org.apache.jetspeed.services.security.nosecurity
Class NoRoleManagement

java.lang.Object
  extended byorg.apache.turbine.services.BaseInitable
      extended byorg.apache.turbine.services.BaseService
          extended byorg.apache.turbine.services.TurbineBaseService
              extended byorg.apache.jetspeed.services.security.nosecurity.NoRoleManagement
All Implemented Interfaces:
org.apache.turbine.services.Initable, RoleManagement, org.apache.turbine.services.Service

public class NoRoleManagement
extends org.apache.turbine.services.TurbineBaseService
implements RoleManagement

The NoRoleManagement class is a Jetspeed security provider, implementing the RoleManagement interface. It provides no role management - only the "user" role exists for any user, no roles are listed or saved, any role requested is supplied with a temp. Role object.

Version:
$Id: NoRoleManagement.java,v 1.4 2004/05/18 14:18:38 jford Exp $
Author:
Glenn R. Golden

Field Summary
 
Fields inherited from class org.apache.turbine.services.BaseService
configuration, name, properties, serviceBroker
 
Fields inherited from class org.apache.turbine.services.BaseInitable
initableBroker, isInitialized
 
Fields inherited from interface org.apache.jetspeed.services.security.RoleManagement
DEFAULT_ROLE_NAME, SERVICE_NAME
 
Constructor Summary
NoRoleManagement()
           
 
Method Summary
 void addRole(Role role)
          Adds a Role into permanent storage.
 Role getRole(java.lang.String rolename)
          Retrieves a single Role for a given rolename principal.
 java.util.Iterator getRoles()
          Retrieves all Roles.
 java.util.Iterator getRoles(java.lang.String username)
          Retrieves all GroupRoles for a given username principal.
 void grantGroupRole(java.lang.String username, java.lang.String groupname, java.lang.String rolename)
          Grants a role to a user for a specific group.
 void grantRole(java.lang.String username, java.lang.String rolename)
          Grants a role to a user.
 void grantRole(java.lang.String username, java.lang.String rolename, java.lang.String groupname)
           
 boolean hasRole(java.lang.String username, java.lang.String rolename)
          Checks for the relationship of user has a role.
 boolean hasRole(java.lang.String username, java.lang.String rolename, java.lang.String groupname)
           
 void removeRole(java.lang.String rolename)
          Removes a Role from the permanent store.
 void revokeRole(java.lang.String username, java.lang.String rolename)
          Revokes a role from a user.
 void revokeRole(java.lang.String username, java.lang.String rolename, java.lang.String groupname)
          Revokes a role from a user for a specific group.
 void saveRole(Role role)
          Saves a Role into permanent storage.
 
Methods inherited from class org.apache.turbine.services.TurbineBaseService
init, init, init, init, shutdown
 
Methods inherited from class org.apache.turbine.services.BaseService
getConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBroker
 
Methods inherited from class org.apache.turbine.services.BaseInitable
getInit, getInitableBroker, setInit, setInitableBroker
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Constructor Detail

NoRoleManagement

public NoRoleManagement()
Method Detail

getRoles

public java.util.Iterator getRoles(java.lang.String username)
                            throws JetspeedSecurityException
Retrieves all GroupRoles for a given username principal. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
getRoles in interface RoleManagement
Parameters:
username - a user principal identity to be retrieved.
Returns:
Iterator over all roles associated to the user principal.
Throws:
RoleException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

getRoles

public java.util.Iterator getRoles()
                            throws JetspeedSecurityException
Retrieves all Roles. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
getRoles in interface RoleManagement
Returns:
Iterator over all roles.
Throws:
RoleException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

addRole

public void addRole(Role role)
             throws JetspeedSecurityException
Adds a Role into permanent storage. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
addRole in interface RoleManagement
Throws:
RoleException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

saveRole

public void saveRole(Role role)
              throws JetspeedSecurityException
Saves a Role into permanent storage. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
saveRole in interface RoleManagement
Throws:
RoleException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

removeRole

public void removeRole(java.lang.String rolename)
                throws JetspeedSecurityException
Removes a Role from the permanent store. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
removeRole in interface RoleManagement
Parameters:
rolename - the principal identity of the role to be retrieved.
Throws:
RoleException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

grantRole

public void grantRole(java.lang.String username,
                      java.lang.String rolename)
               throws JetspeedSecurityException
Grants a role to a user. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
grantRole in interface RoleManagement
Throws:
RoleException - when the security provider has a general failure retrieving roles.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

grantRole

public void grantRole(java.lang.String username,
                      java.lang.String rolename,
                      java.lang.String groupname)
               throws JetspeedSecurityException
Specified by:
grantRole in interface RoleManagement
Throws:
JetspeedSecurityException

grantGroupRole

public void grantGroupRole(java.lang.String username,
                           java.lang.String groupname,
                           java.lang.String rolename)
                    throws JetspeedSecurityException
Grants a role to a user for a specific group. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Throws:
RoleException - when the security provider has a general failure retrieving roles.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

revokeRole

public void revokeRole(java.lang.String username,
                       java.lang.String rolename)
                throws JetspeedSecurityException
Revokes a role from a user. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
revokeRole in interface RoleManagement
Throws:
RoleException - when the security provider has a general failure retrieving roles.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

revokeRole

public void revokeRole(java.lang.String username,
                       java.lang.String rolename,
                       java.lang.String groupname)
                throws JetspeedSecurityException
Revokes a role from a user for a specific group. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
revokeRole in interface RoleManagement
Throws:
RoleException - when the security provider has a general failure retrieving roles.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

hasRole

public boolean hasRole(java.lang.String username,
                       java.lang.String rolename)
                throws JetspeedSecurityException
Checks for the relationship of user has a role. Returns true when the user has the given role. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
hasRole in interface RoleManagement
Throws:
RoleException - when the security provider has a general failure retrieving roles.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

hasRole

public boolean hasRole(java.lang.String username,
                       java.lang.String rolename,
                       java.lang.String groupname)
                throws JetspeedSecurityException
Specified by:
hasRole in interface RoleManagement
Throws:
JetspeedSecurityException

getRole

public Role getRole(java.lang.String rolename)
             throws JetspeedSecurityException
Retrieves a single Role for a given rolename principal. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
getRole in interface RoleManagement
Parameters:
rolename - a role principal identity to be retrieved.
Returns:
Role the role record retrieved.
Throws:
RoleException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.