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

Interface LDAPInitialDirContextFactory

All Known Implementing Classes:
LDAPInitialDirContextFactoryImpl
public interface LDAPInitialDirContextFactory
Interface that defines a factory for obtaining ldap directory contexts.
Author:
Andy Hind

  • Method Details

    • setInitialDirContextEnvironment

      void setInitialDirContextEnvironment(Map<String,String> environment)
      Set the LDAP environment Hashtable properties used ot initialise the LDAP connection.

    • getDefaultIntialDirContext

      InitialDirContext getDefaultIntialDirContext(int pageSize, AuthenticationDiagnostic diagnostic) throws AuthenticationException
      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.
      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

    • getDefaultIntialDirContext

      InitialDirContext getDefaultIntialDirContext(int pageSize) throws AuthenticationException
      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.
      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

      InitialDirContext getDefaultIntialDirContext() throws AuthenticationException
      Use the environment properties and connect to the LDAP server. Used to obtain read only access to the LDAP server.
      Returns:
      InitialDirContext
      Throws:
      AuthenticationException

    • getDefaultIntialDirContext

      InitialDirContext getDefaultIntialDirContext(AuthenticationDiagnostic diagnostic) throws AuthenticationException
      Use the environment properties and connect to the LDAP server. Used to obtain read only access to the LDAP server.
      Returns:
      InitialDirContext
      Throws:
      AuthenticationException

    • hasNextPage

      boolean hasNextPage(DirContext ctx, int pageSize)
      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.
      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

      InitialDirContext getInitialDirContext(String principal, String credentials) throws AuthenticationException
      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.
      Parameters:
      principal - String
      credentials - String
      Returns:
      InitialDirContext
      Throws:
      AuthenticationException

    • getInitialDirContext

      InitialDirContext getInitialDirContext(String principal, String credentials, AuthenticationDiagnostic diagnostic) throws AuthenticationException
      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.
      Parameters:
      principal - String
      credentials - String
      diagnostic - AuthenticationDiagnostic
      Returns:
      InitialDirContext
      Throws:
      AuthenticationException