站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

LDAPRoleModuleImpl - JBOSS Portal 2.6 API 英文版文档


org.jboss.portal.identity2.ldap
Class LDAPRoleModuleImpl

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport
      extended byorg.jboss.system.ServiceMBeanSupport
          extended byorg.jboss.portal.jems.as.system.AbstractJBossService
              extended byorg.jboss.portal.identity2.ldap.LDAPRoleModuleImpl
All Implemented Interfaces:
javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, RoleModule, org.jboss.system.Service, org.jboss.system.ServiceMBean
Direct Known Subclasses:
LDAPExtRoleModuleImpl

public class LDAPRoleModuleImpl
extends AbstractJBossService
implements RoleModule

Version:
$Revision: 1.1 $
Author:
Boleslaw Dawidowicz

Field Summary
private  LDAPConnectionContext connectionContext
           
private  java.lang.String containerDN
           
private  java.lang.String displayNameAttributeID
           
private  java.lang.String ridAttributeID
           
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport
 
Fields inherited from interface org.jboss.system.ServiceMBean
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
LDAPRoleModuleImpl()
           
 
Method Summary
 Role createRole(java.lang.String name, java.lang.String displayName)
          Create a new role with the specified name.
protected  LDAPRoleImpl createRoleInstance(javax.naming.directory.SearchResult sr)
           
 Role findRoleById(java.lang.Object id)
          Retrieves a role by its id.
 Role findRoleById(java.lang.String id)
          Retrieves a role by its id.
 Role findRoleByName(java.lang.String name)
          Retrieves a role by its name
 java.util.Set findRoles()
          Get all the roles
 java.util.Set findRolesByNames(java.lang.String[] names)
          Retrieve a collection of role from the role names.
 LDAPConnectionContext getConnectionContext()
           
 java.lang.String getContainerDN()
           
 java.lang.String getDisplayNameAttributeID()
           
 java.lang.String getRidAttributeID()
           
 int getRolesCount()
          Returns the number of roles.
 void removeRole(java.lang.Object id)
          Remove a role.
 void setConnectionContext(LDAPConnectionContext connectionContext)
           
 void setContainerDN(java.lang.String containerDN)
           
 void setDisplayNameAttributeID(java.lang.String displayNameAttributeID)
           
 void setRidAttributeID(java.lang.String ridAttributeID)
           
 
Methods inherited from class org.jboss.portal.jems.as.system.AbstractJBossService
create, destroy, getState, getStateString, start, stop
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport
createService, destroyService, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, startService, stopService
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport
addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

connectionContext

private LDAPConnectionContext connectionContext

ridAttributeID

private java.lang.String ridAttributeID

containerDN

private java.lang.String containerDN

displayNameAttributeID

private java.lang.String displayNameAttributeID
Constructor Detail

LDAPRoleModuleImpl

public LDAPRoleModuleImpl()
Method Detail

findRoleByName

public Role findRoleByName(java.lang.String name)
                    throws IdentityException,
                           java.lang.IllegalArgumentException
Description copied from interface: RoleModule
Retrieves a role by its name

Specified by:
findRoleByName in interface RoleModule
Parameters:
name - the role name
Returns:
the role
Throws:
IdentityException
java.lang.IllegalArgumentException

findRolesByNames

public java.util.Set findRolesByNames(java.lang.String[] names)
                               throws IdentityException,
                                      java.lang.IllegalArgumentException
Description copied from interface: RoleModule
Retrieve a collection of role from the role names.

Specified by:
findRolesByNames in interface RoleModule
Parameters:
names - the role names
Returns:
a collection of roles
Throws:
java.lang.IllegalArgumentException
IdentityException

findRoleById

public Role findRoleById(java.lang.Object id)
                  throws IdentityException,
                         java.lang.IllegalArgumentException
Description copied from interface: RoleModule
Retrieves a role by its id.

Specified by:
findRoleById in interface RoleModule
Parameters:
id - the role id
Returns:
the role
Throws:
IdentityException
java.lang.IllegalArgumentException

findRoleById

public Role findRoleById(java.lang.String id)
                  throws IdentityException,
                         java.lang.IllegalArgumentException
Description copied from interface: RoleModule
Retrieves a role by its id.

Specified by:
findRoleById in interface RoleModule
Parameters:
id - the role id
Returns:
the role
Throws:
IdentityException
java.lang.IllegalArgumentException

createRole

public Role createRole(java.lang.String name,
                       java.lang.String displayName)
                throws IdentityException,
                       java.lang.IllegalArgumentException
Description copied from interface: RoleModule
Create a new role with the specified name.

Specified by:
createRole in interface RoleModule
Parameters:
name - the role name
displayName - the role display name
Returns:
the role
Throws:
IdentityException
java.lang.IllegalArgumentException

removeRole

public void removeRole(java.lang.Object id)
                throws IdentityException,
                       java.lang.IllegalArgumentException
Description copied from interface: RoleModule
Remove a role.

Specified by:
removeRole in interface RoleModule
Parameters:
id - the role id
Throws:
IdentityException
java.lang.IllegalArgumentException

getRolesCount

public int getRolesCount()
                  throws IdentityException
Description copied from interface: RoleModule
Returns the number of roles.

Specified by:
getRolesCount in interface RoleModule
Returns:
the number of roles
Throws:
IdentityException

findRoles

public java.util.Set findRoles()
                        throws IdentityException
Description copied from interface: RoleModule
Get all the roles

Specified by:
findRoles in interface RoleModule
Returns:
the roles
Throws:
IdentityException

createRoleInstance

protected LDAPRoleImpl createRoleInstance(javax.naming.directory.SearchResult sr)
                                   throws IdentityException
Throws:
IdentityException

getRidAttributeID

public java.lang.String getRidAttributeID()

setRidAttributeID

public void setRidAttributeID(java.lang.String ridAttributeID)

getConnectionContext

public LDAPConnectionContext getConnectionContext()

setConnectionContext

public void setConnectionContext(LDAPConnectionContext connectionContext)

getContainerDN

public java.lang.String getContainerDN()

setContainerDN

public void setContainerDN(java.lang.String containerDN)

getDisplayNameAttributeID

public java.lang.String getDisplayNameAttributeID()

setDisplayNameAttributeID

public void setDisplayNameAttributeID(java.lang.String displayNameAttributeID)