Package org.wildfly.security.auth.realm.ldap

Interface DirContextFactory

public interface DirContextFactory
Factory for obtaining connected DirContext instances. By using a factory for the contexts different strategies can be substituted in a managed environment.
Author:
Darran Lofthouse

  • Method Details

    • obtainDirContext

      DirContext obtainDirContext(DirContextFactory.ReferralMode mode) throws NamingException
      Obtain a DirContext for the configured referral mode.
      Parameters:
      mode - the referral mode for if a referral is encountered querying LDAP; the passed in referral mode can be null in which case the default of IGNORE will be assumed
      Returns:
      a ready to use DirContext for searching and attribute retrieval
      Throws:
      NamingException

    • obtainDirContext

      DirContext obtainDirContext(CallbackHandler handler, DirContextFactory.ReferralMode mode) throws NamingException
      Obtain a DirContext based on the credentials extracted from the given CallbackHandler.
      Parameters:
      handler - the callback handler used to extract credentials in order to obtain a connected DirContext instance.
      mode - the referral mode for if a referral is encountered querying LDAP; the passed in referral mode can be null in which case the default of IGNORE will be assumed
      Returns:
      a ready to use DirContext for searching and attribute retrieval
      Throws:
      NamingException

    • returnContext

      void returnContext(DirContext context)
      Return the DirContext once it is no longer required. The returned DirContext is not necessarily an InitialDirContext and as a result we can not assume it is closeable. Should only be called if a context was successfully obtained.
      Parameters:
      context - the DirContext to return

    • discardContext

      default void discardContext(DirContext context)
      Pass back a DirContext to this factory to be discarded. The context may be passed back either because it is detected as being invalid or possibly because it has been created to act as a specific account and so should not be pooled. Although the context is being discarded this method allows the factory to perform any additional clean up required around this context.
      Parameters:
      context - the DirContext to discard.