Package com.identity4j.connector.jndi.directory

Class AbstractDirectoryConnector<P extends AbstractDirectoryConfiguration>

java.lang.Object

com.identity4j.connector.AbstractConnector<P>

com.identity4j.connector.jndi.directory.AbstractDirectoryConnector<P>

All Implemented Interfaces:

com.identity4j.connector.BrowseableConnector<P>, com.identity4j.connector.Connector<P>, com.identity4j.util.validator.ValidationContext, Closeable, AutoCloseable

Direct Known Subclasses:

DirectoryConnector

public class AbstractDirectoryConnector<P extends AbstractDirectoryConfiguration>
extends com.identity4j.connector.AbstractConnector<P>
implements com.identity4j.connector.BrowseableConnector<P>

Nested Class Summary

Nested classes/interfaces inherited from interface com.identity4j.connector.Connector

com.identity4j.connector.Connector.PasswordResetType

Field Summary

Fields

Modifier and Type	Field	Description
protected static Set<com.identity4j.connector.ConnectorCapability>	capabilities
static String	COMMON_NAME_ATTRIBUTE
protected static Iterator<com.identity4j.connector.principal.Identity>	IDENTITY_ITERATOR
protected LdapService	ldapService
static String	OBJECT_CLASS_ATTRIBUTE
static String	OU_ATTRIBUTE
protected static Iterator<com.identity4j.connector.principal.Role>	ROLE_ITERATOR
protected SocketFactory	socketFactory
static String	WILDCARD_SEARCH

Constructor Summary

Constructors

Constructor	Description
AbstractDirectoryConnector()

Method Summary

Modifier and Type	Method	Description
Iterator<com.identity4j.connector.principal.Identity>	allIdentities()
Iterator<com.identity4j.connector.principal.Role>	allRoles()
protected boolean	areCredentialsValid(com.identity4j.connector.principal.Identity identity, char[] password)
protected void	assignRole(LdapName userDn, com.identity4j.connector.principal.Role role)
protected Filter	buildGuidFilter(String identityGuid)
protected Filter	buildIdentityFilter(String identityName)
protected Filter	buildRoleFilter(String roleName, boolean isWildcard)
protected void	changePassword(com.identity4j.connector.principal.Identity identity, char[] oldPassword, char[] password)
boolean	checkCredentialsOptimised(String username, String remoteIdentifier, char[] password)
protected void	checkNamingException(String errorText, NamingException nme, com.identity4j.connector.principal.Principal principal)
protected void	checkOtherCreationExceptions(com.identity4j.connector.principal.Identity identity, Exception e)
protected SearchControls	configureRoleSearchControls(SearchControls searchControls)
protected SearchControls	configureSearchControls(SearchControls searchControls)
com.identity4j.connector.principal.Identity	createIdentity(com.identity4j.connector.principal.Identity identity, char[] password)
com.identity4j.connector.principal.Identity	createIdentity(com.identity4j.connector.principal.Identity identity, com.identity4j.connector.PasswordCreationCallback passwordCallback, boolean forceChange)
void	deleteIdentity(String principalName)
void	deleteRole(String roleName)
protected void	finaliseCreate(DirectoryIdentity directoryIdentity, boolean forceChange)
protected String	finaliseCreate(com.identity4j.connector.principal.Identity identity, String principalName, List<Attribute> attributes)
protected Collection<String>	getAttributesReservedForCreation()
protected String	getAttributeValue(Name dn, String attributeName)
Iterator<com.identity4j.connector.BrowseNode>	getBrowseableNodes(com.identity4j.connector.BrowseNode parent)
protected String	getByteValue(String attributeName, Attributes attributes)
Set<com.identity4j.connector.ConnectorCapability>	getCapabilities()
protected int	getCode(NamingException nme)
protected Collection<String>	getCoreIdentityAttributes()
protected List<ModificationItem>	getCreationPasswordModificationItems(char[] password, DirectoryConfiguration config)
protected String	getEmailAttribute()
Iterator<com.identity4j.connector.principal.Identity>	getIdentities(Filter filter)
com.identity4j.connector.principal.Identity	getIdentityByGuid(String identityGuid)
com.identity4j.connector.principal.Identity	getIdentityByName(String identityName)
protected List<String>	getIdentityCreationObjectClasses(com.identity4j.connector.principal.Identity identity)
protected String	getMessage(NamingException nme)
protected String	getMobileAttribute()
Iterator<DirectoryOU>	getOrganizationalUnits()
protected String	getReason(NamingException nme)
com.identity4j.connector.principal.Role	getRoleByName(String roleName)
protected Iterator<com.identity4j.connector.principal.Role>	getRoles()
protected Iterator<com.identity4j.connector.principal.Role>	getRoles(Filter filter, boolean applyFilters)
protected Name	getRootDn()
SocketFactory	getSocketFactory()
protected boolean	isExcludeForUserUpdate(String attributeName)
protected boolean	isIncluded(com.identity4j.connector.principal.Role role)
protected boolean	isIncluded(String dn)
protected boolean	isIncluded(Name dn)
boolean	isOpen()
boolean	isReadOnly()
protected com.identity4j.connector.principal.Identity	mapIdentity(SearchResult result)
protected com.identity4j.connector.principal.Role	mapRole(SearchResult result)
protected void	onClose()
protected void	onOpen(P parameters)
protected String	processNamingException(NamingException nme)
protected String	processNamingException(NamingException nme, com.identity4j.connector.Connector.PasswordResetType type, com.identity4j.connector.principal.Principal pricipal)
protected void	processUserAttributes(List<ModificationItem> modificationItems, com.identity4j.connector.principal.Identity previousState, com.identity4j.connector.principal.Identity newState)
protected void	revokeRole(LdapName userDn, com.identity4j.connector.principal.Role role)
protected void	setPassword(com.identity4j.connector.principal.Identity identity, char[] password, boolean forcePasswordChangeAtLogon, com.identity4j.connector.Connector.PasswordResetType type)
void	setSocketFactory(SocketFactory socketFactory)
boolean	supportsOptimisedCheckCredentials()
void	updateIdentity(com.identity4j.connector.principal.Identity identity)

Methods inherited from class com.identity4j.connector.AbstractConnector

allIdentities, allRoles, assertGuid, assertPasswordChangeIsAllowed, changePassword, checkCredentials, close, count, countIdentities, countIdentities, countRoles, countRoles, createRole, disableIdentity, enableIdentity, getAttribute, getConfiguration, getPasswordCharacteristics, getPasswordPolicies, getPrincipal, install, isIdentityNameInUse, isRoleNameInUse, lockIdentity, logon, open, reopen, setAttribute, setPassword, setPassword, setPassword, startAuthentication, unlockIdentity, updateRole

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface com.identity4j.connector.Connector

allIdentities, allRoles, changePassword, checkCredentials, countIdentities, countIdentities, countRoles, countRoles, createRole, disableIdentity, enableIdentity, getAttribute, getConfiguration, getPasswordCharacteristics, getPasswordPolicies, install, isIdentityNameInUse, isRoleNameInUse, lockIdentity, logon, open, reopen, setAttribute, setPassword, setPassword, startAuthentication, unlockIdentity, updateRole

Field Detail

IDENTITY_ITERATOR

protected static final Iterator<com.identity4j.connector.principal.Identity> IDENTITY_ITERATOR

ROLE_ITERATOR

protected static final Iterator<com.identity4j.connector.principal.Role> ROLE_ITERATOR

WILDCARD_SEARCH

public static final String WILDCARD_SEARCH

See Also:

Constant Field Values

OBJECT_CLASS_ATTRIBUTE

public static final String OBJECT_CLASS_ATTRIBUTE

See Also:

Constant Field Values

OU_ATTRIBUTE

public static final String OU_ATTRIBUTE

See Also:

Constant Field Values

COMMON_NAME_ATTRIBUTE

public static final String COMMON_NAME_ATTRIBUTE

See Also:

Constant Field Values

ldapService

protected LdapService ldapService

socketFactory

protected SocketFactory socketFactory

capabilities

protected static Set<com.identity4j.connector.ConnectorCapability> capabilities

Constructor Detail

AbstractDirectoryConnector

public AbstractDirectoryConnector()

Method Detail

getSocketFactory

public SocketFactory getSocketFactory()

setSocketFactory

public void setSocketFactory(SocketFactory socketFactory)

Specified by:

setSocketFactory in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

setSocketFactory in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

deleteIdentity

public void deleteIdentity(String principalName)
                    throws com.identity4j.connector.exception.ConnectorException

Specified by:

deleteIdentity in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

deleteIdentity in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

deleteRole

public void deleteRole(String roleName)
                throws com.identity4j.connector.exception.ConnectorException

Specified by:

deleteRole in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

deleteRole in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

getCapabilities

public Set<com.identity4j.connector.ConnectorCapability> getCapabilities()

Specified by:

getCapabilities in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

isOpen

public boolean isOpen()

Specified by:

isOpen in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

onClose

protected void onClose()

Overrides:

onClose in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

getRootDn

protected Name getRootDn()

createIdentity

public final com.identity4j.connector.principal.Identity createIdentity(com.identity4j.connector.principal.Identity identity,
                                                                        char[] password)
                                                                 throws com.identity4j.connector.exception.ConnectorException

Specified by:

createIdentity in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

createIdentity in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

createIdentity

public final com.identity4j.connector.principal.Identity createIdentity(com.identity4j.connector.principal.Identity identity,
                                                                        com.identity4j.connector.PasswordCreationCallback passwordCallback,
                                                                        boolean forceChange)
                                                                 throws com.identity4j.connector.exception.ConnectorException

Specified by:

createIdentity in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

createIdentity in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

getIdentityCreationObjectClasses

protected List<String> getIdentityCreationObjectClasses(com.identity4j.connector.principal.Identity identity)

finaliseCreate

protected void finaliseCreate(DirectoryIdentity directoryIdentity,
                              boolean forceChange)

finaliseCreate

protected String finaliseCreate(com.identity4j.connector.principal.Identity identity,
                                String principalName,
                                List<Attribute> attributes)

getCoreIdentityAttributes

protected Collection<String> getCoreIdentityAttributes()

assignRole

protected void assignRole(LdapName userDn,
                          com.identity4j.connector.principal.Role role)
                   throws NamingException,
                          IOException

Throws:

NamingException

IOException

processNamingException

protected String processNamingException(NamingException nme,
                                        com.identity4j.connector.Connector.PasswordResetType type,
                                        com.identity4j.connector.principal.Principal pricipal)

checkOtherCreationExceptions

protected void checkOtherCreationExceptions(com.identity4j.connector.principal.Identity identity,
                                            Exception e)

checkNamingException

protected void checkNamingException(String errorText,
                                    NamingException nme,
                                    com.identity4j.connector.principal.Principal principal)
                             throws com.identity4j.connector.exception.ConnectorException

Throws:

com.identity4j.connector.exception.ConnectorException

getAttributesReservedForCreation

protected Collection<String> getAttributesReservedForCreation()

getEmailAttribute

protected String getEmailAttribute()

getMobileAttribute

protected String getMobileAttribute()

getCreationPasswordModificationItems

protected List<ModificationItem> getCreationPasswordModificationItems(char[] password,
                                                                      DirectoryConfiguration config)
                                                               throws com.identity4j.util.crypt.EncoderException

Throws:

com.identity4j.util.crypt.EncoderException

supportsOptimisedCheckCredentials

public boolean supportsOptimisedCheckCredentials()

Overrides:

supportsOptimisedCheckCredentials in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

checkCredentialsOptimised

public boolean checkCredentialsOptimised(String username,
                                         String remoteIdentifier,
                                         char[] password)
                                  throws com.identity4j.connector.exception.ConnectorException

Overrides:

checkCredentialsOptimised in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

areCredentialsValid

protected boolean areCredentialsValid(com.identity4j.connector.principal.Identity identity,
                                      char[] password)
                               throws com.identity4j.connector.exception.ConnectorException

Overrides:

areCredentialsValid in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

changePassword

protected void changePassword(com.identity4j.connector.principal.Identity identity,
                              char[] oldPassword,
                              char[] password)

Overrides:

changePassword in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

isIncluded

protected boolean isIncluded(String dn)
                      throws InvalidNameException

Throws:

InvalidNameException

isIncluded

protected boolean isIncluded(Name dn)

updateIdentity

public void updateIdentity(com.identity4j.connector.principal.Identity identity)
                    throws com.identity4j.connector.exception.ConnectorException

Specified by:

updateIdentity in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

updateIdentity in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

isExcludeForUserUpdate

protected boolean isExcludeForUserUpdate(String attributeName)

processUserAttributes

protected void processUserAttributes(List<ModificationItem> modificationItems,
                                     com.identity4j.connector.principal.Identity previousState,
                                     com.identity4j.connector.principal.Identity newState)

revokeRole

protected void revokeRole(LdapName userDn,
                          com.identity4j.connector.principal.Role role)
                   throws NamingException,
                          IOException

Throws:

NamingException

IOException

setPassword

protected void setPassword(com.identity4j.connector.principal.Identity identity,
                           char[] password,
                           boolean forcePasswordChangeAtLogon,
                           com.identity4j.connector.Connector.PasswordResetType type)
                    throws com.identity4j.connector.exception.ConnectorException

Overrides:

setPassword in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

getOrganizationalUnits

public Iterator<DirectoryOU> getOrganizationalUnits()
                                             throws com.identity4j.connector.exception.ConnectorException,
                                                    IOException

Throws:

com.identity4j.connector.exception.ConnectorException

IOException

getIdentityByName

public final com.identity4j.connector.principal.Identity getIdentityByName(String identityName)
                                                                    throws com.identity4j.connector.exception.PrincipalNotFoundException,
                                                                           com.identity4j.connector.exception.ConnectorException

Specified by:

getIdentityByName in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

getIdentityByName in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.PrincipalNotFoundException

com.identity4j.connector.exception.ConnectorException

getIdentityByGuid

public final com.identity4j.connector.principal.Identity getIdentityByGuid(String identityGuid)
                                                                    throws com.identity4j.connector.exception.PrincipalNotFoundException,
                                                                           com.identity4j.connector.exception.ConnectorException

Specified by:

getIdentityByGuid in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

getIdentityByGuid in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.PrincipalNotFoundException

com.identity4j.connector.exception.ConnectorException

allIdentities

public final Iterator<com.identity4j.connector.principal.Identity> allIdentities()
                                                                          throws com.identity4j.connector.exception.ConnectorException

Specified by:

allIdentities in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

buildRoleFilter

protected Filter buildRoleFilter(String roleName,
                                 boolean isWildcard)

buildGuidFilter

protected Filter buildGuidFilter(String identityGuid)

buildIdentityFilter

protected Filter buildIdentityFilter(String identityName)

getIdentities

public Iterator<com.identity4j.connector.principal.Identity> getIdentities(Filter filter)

mapIdentity

protected com.identity4j.connector.principal.Identity mapIdentity(SearchResult result)
                                                           throws NamingException

Throws:

NamingException

isIncluded

protected boolean isIncluded(com.identity4j.connector.principal.Role role)

getRoleByName

public final com.identity4j.connector.principal.Role getRoleByName(String roleName)
                                                            throws com.identity4j.connector.exception.PrincipalNotFoundException,
                                                                   com.identity4j.connector.exception.ConnectorException

Specified by:

getRoleByName in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Overrides:

getRoleByName in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.PrincipalNotFoundException

com.identity4j.connector.exception.ConnectorException

allRoles

public final Iterator<com.identity4j.connector.principal.Role> allRoles()
                                                                 throws com.identity4j.connector.exception.ConnectorException

Specified by:

allRoles in interface com.identity4j.connector.Connector<P extends AbstractDirectoryConfiguration>

Throws:

com.identity4j.connector.exception.ConnectorException

getRoles

protected Iterator<com.identity4j.connector.principal.Role> getRoles()

getRoles

protected Iterator<com.identity4j.connector.principal.Role> getRoles(Filter filter,
                                                                     boolean applyFilters)

mapRole

protected com.identity4j.connector.principal.Role mapRole(SearchResult result)
                                                   throws NamingException

Throws:

NamingException

configureSearchControls

protected SearchControls configureSearchControls(SearchControls searchControls)

configureRoleSearchControls

protected SearchControls configureRoleSearchControls(SearchControls searchControls)

getAttributeValue

protected final String getAttributeValue(Name dn,
                                         String attributeName)

getByteValue

protected final String getByteValue(String attributeName,
                                    Attributes attributes)

onOpen

protected void onOpen(P parameters)

Specified by:

onOpen in class com.identity4j.connector.AbstractConnector<P extends AbstractDirectoryConfiguration>

processNamingException

protected String processNamingException(NamingException nme)

getReason

protected String getReason(NamingException nme)

getCode

protected int getCode(NamingException nme)

getMessage

protected String getMessage(NamingException nme)

getBrowseableNodes

public Iterator<com.identity4j.connector.BrowseNode> getBrowseableNodes(com.identity4j.connector.BrowseNode parent)

Specified by:

getBrowseableNodes in interface com.identity4j.connector.BrowseableConnector<P extends AbstractDirectoryConfiguration>