Package org.alfresco.repo.security.authentication.ldap

Class LDAPInitialDirContextFactoryImpl

java.lang.Object

org.alfresco.repo.security.authentication.ldap.LDAPInitialDirContextFactoryImpl

All Implemented Interfaces:

LDAPInitialDirContextFactory, org.springframework.beans.factory.InitializingBean

public class LDAPInitialDirContextFactoryImpl
extends Object
implements LDAPInitialDirContextFactory, org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor	Description
LDAPInitialDirContextFactoryImpl()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
InitialDirContext	getDefaultIntialDirContext()	Use the environment properties and connect to the LDAP server.
InitialDirContext	getDefaultIntialDirContext(int pageSize)	Use the environment properties and connect to the LDAP server, optionally configuring RFC 2696 paged results.
InitialDirContext	getDefaultIntialDirContext(int pageSize, AuthenticationDiagnostic diagnostic)	Use the environment properties and connect to the LDAP server, optionally configuring RFC 2696 paged results.
InitialDirContext	getDefaultIntialDirContext(AuthenticationDiagnostic diagnostic)	Use the environment properties and connect to the LDAP server.
InitialDirContext	getInitialDirContext(String principal, String credentials)	Augment the connection environment with the identity and credentials and bind to the ldap server.
InitialDirContext	getInitialDirContext(String principal, String credentials, AuthenticationDiagnostic diagnostic)	Augment the connection environment with the identity and credentials and bind to the ldap server.
Map<String,String>	getInitialDirContextEnvironment()
String	getTrustStorePassPhrase()
String	getTrustStorePath()
String	getTrustStoreType()
boolean	hasNextPage(DirContext ctx, int pageSize)	Determines whether there is another page to fetch from the last search to be run in this context.
static void	main(String[] args)
void	setDefaultIntialDirContextEnvironment(Map<String,String> defaultEnvironment)
void	setInitialChecksEnabled(boolean initialChecksEnabled)
void	setInitialDirContextEnvironment(Map<String,String> initialDirContextEnvironment)	Set the LDAP environment Hashtable properties used ot initialise the LDAP connection.
void	setLdapInitialDirContextCache(SimpleCache<String,Set<Map<String,String>>> cache)
void	setPoolSystemProperties(Map<String,String> poolSystemProperties)
void	setTrustStorePassPhrase(String trustStorePassPhrase)
void	setTrustStorePath(String trustStorePath)
void	setTrustStoreType(String trustStoreType)

Methods inherited from class java.lang.Object

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

Constructor Details

LDAPInitialDirContextFactoryImpl

public LDAPInitialDirContextFactoryImpl()

Method Details

getTrustStorePath

public String getTrustStorePath()

setTrustStorePath

public void setTrustStorePath(String trustStorePath)

getTrustStoreType

public String getTrustStoreType()

setTrustStoreType

public void setTrustStoreType(String trustStoreType)

getTrustStorePassPhrase

public String getTrustStorePassPhrase()

setTrustStorePassPhrase

public void setTrustStorePassPhrase(String trustStorePassPhrase)

setInitialDirContextEnvironment

public void setInitialDirContextEnvironment(Map<String,String> initialDirContextEnvironment)

Description copied from interface: LDAPInitialDirContextFactory

Set the LDAP environment Hashtable properties used ot initialise the LDAP connection.

Specified by:

setInitialDirContextEnvironment in interface LDAPInitialDirContextFactory

getInitialDirContextEnvironment

public Map<String,String> getInitialDirContextEnvironment()

setDefaultIntialDirContextEnvironment

public void setDefaultIntialDirContextEnvironment(Map<String,String> defaultEnvironment)

getDefaultIntialDirContext

public InitialDirContext getDefaultIntialDirContext()
                                             throws AuthenticationException

Description copied from interface: LDAPInitialDirContextFactory

Use the environment properties and connect to the LDAP server. Used to obtain read only access to the LDAP server.

Specified by:

getDefaultIntialDirContext in interface LDAPInitialDirContextFactory

Returns:

InitialDirContext

Throws:

AuthenticationException

setPoolSystemProperties

public void setPoolSystemProperties(Map<String,String> poolSystemProperties)

getDefaultIntialDirContext

public InitialDirContext getDefaultIntialDirContext(int pageSize)
                                             throws AuthenticationException

Description copied from interface: LDAPInitialDirContextFactory

Use the environment properties and connect to the LDAP server, optionally configuring RFC 2696 paged results. Used to obtain read only access to the LDAP server.

Specified by:

getDefaultIntialDirContext in interface LDAPInitialDirContextFactory

Parameters:

pageSize - if a positive value, indicates that a LDAP v3 RFC 2696 paged results control should be used. The results of a search operation should be returned by the LDAP server in batches of the specified size.

Returns:

the default intial dir context

Throws:

AuthenticationException - the authentication exception

getDefaultIntialDirContext

public InitialDirContext getDefaultIntialDirContext(AuthenticationDiagnostic diagnostic)
                                             throws AuthenticationException

Description copied from interface: LDAPInitialDirContextFactory

Use the environment properties and connect to the LDAP server. Used to obtain read only access to the LDAP server.

Specified by:

getDefaultIntialDirContext in interface LDAPInitialDirContextFactory

Returns:

InitialDirContext

Throws:

AuthenticationException

getDefaultIntialDirContext

public InitialDirContext getDefaultIntialDirContext(int pageSize,
 AuthenticationDiagnostic diagnostic)
                                             throws AuthenticationException

Description copied from interface: LDAPInitialDirContextFactory

Use the environment properties and connect to the LDAP server, optionally configuring RFC 2696 paged results. Used to obtain read only access to the LDAP server.

Specified by:

getDefaultIntialDirContext in interface LDAPInitialDirContextFactory

Parameters:

pageSize - if a positive value, indicates that a LDAP v3 RFC 2696 paged results control should be used. The results of a search operation should be returned by the LDAP server in batches of the specified size.

diagnostic - AuthenticationDiagnostic

Returns:

the default intial dir context

Throws:

AuthenticationException - the authentication exception

hasNextPage

public boolean hasNextPage(DirContext ctx,
 int pageSize)

Description copied from interface: LDAPInitialDirContextFactory

Determines whether there is another page to fetch from the last search to be run in this context. Also prepares the request controls so that the appropriate cookie will be passed in the next search.

Specified by:

hasNextPage in interface LDAPInitialDirContextFactory

Parameters:

ctx - the context

pageSize - if a positive value, indicates that a LDAP v3 RFC 2696 paged results control should be used. The results of a search operation should be returned by the LDAP server in batches of the specified size.

Returns:

true, if is ready for next page

getInitialDirContext

public InitialDirContext getInitialDirContext(String principal,
 String credentials)
                                       throws AuthenticationException

Description copied from interface: LDAPInitialDirContextFactory

Augment the connection environment with the identity and credentials and bind to the ldap server. Mainly used to validate a user's credentials during authentication.

Specified by:

getInitialDirContext in interface LDAPInitialDirContextFactory

Parameters:

principal - String

credentials - String

Returns:

InitialDirContext

Throws:

AuthenticationException

getInitialDirContext

public InitialDirContext getInitialDirContext(String principal,
 String credentials,
 AuthenticationDiagnostic diagnostic)
                                       throws AuthenticationException

Description copied from interface: LDAPInitialDirContextFactory

Augment the connection environment with the identity and credentials and bind to the ldap server. Mainly used to validate a user's credentials during authentication.

Specified by:

getInitialDirContext in interface LDAPInitialDirContextFactory

Parameters:

principal - String

credentials - String

diagnostic - AuthenticationDiagnostic

Returns:

InitialDirContext

Throws:

AuthenticationException

main

public static void main(String[] args)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

setLdapInitialDirContextCache

public void setLdapInitialDirContextCache(SimpleCache<String,Set<Map<String,String>>> cache)

setInitialChecksEnabled

public void setInitialChecksEnabled(boolean initialChecksEnabled)