Package org.ldaptive.auth

Class AggregateEntryResolver

java.lang.Object
org.ldaptive.AbstractFreezable
org.ldaptive.auth.AggregateEntryResolver
All Implemented Interfaces:
EntryResolver, Freezable
public final class AggregateEntryResolver extends AbstractFreezable implements EntryResolver
Used in conjunction with an AggregateDnResolver to resolve an entry. In particular, the resolved DN is expected to be of the form: label:DN where the label indicates the entry resolver to use. This class only invokes one entry resolver that matches the label found on the DN.

  • Field Details

    • logger

      private final Logger logger
      Logger for this class.

    • entryResolvers

      private final Map<String,EntryResolver> entryResolvers
      Labeled entry resolvers.

  • Constructor Details

    • AggregateEntryResolver

      public AggregateEntryResolver()
      Default constructor.

    • AggregateEntryResolver

      public AggregateEntryResolver(Map<String,EntryResolver> resolvers)
      Creates a new aggregate entry resolver.
      Parameters:
      resolvers - entry resolvers

  • Method Details

    • freeze

      public void freeze()
      Description copied from interface: Freezable
      Freezes this object, making it immutable.
      Specified by:
      freeze in interface Freezable
      Overrides:
      freeze in class AbstractFreezable

    • getEntryResolvers

      public Map<String,EntryResolver> getEntryResolvers()
      Returns the entry resolvers to aggregate over.
      Returns:
      map of label to entry resolver

    • setEntryResolvers

      public void setEntryResolvers(Map<String,EntryResolver> resolvers)
      Sets the entry resolvers to aggregate over.
      Parameters:
      resolvers - to set

    • addEntryResolver

      public void addEntryResolver(String label, EntryResolver resolver)
      Adds an entry resolver with the supplied label.
      Parameters:
      label - of the resolver
      resolver - entry resolver

    • resolve

      public LdapEntry resolve(AuthenticationCriteria criteria, AuthenticationHandlerResponse response) throws LdapException
      Description copied from interface: EntryResolver
      Attempts to find the LDAP entry for the supplied authentication criteria and authentication handler response. The connection available in the response should not be closed in this method.
      Specified by:
      resolve in interface EntryResolver
      Parameters:
      criteria - authentication criteria used to perform the authentication
      response - produced by the authentication handler
      Returns:
      ldap entry
      Throws:
      LdapException - if an LDAP error occurs

    • builder

      public static AggregateEntryResolver.Builder builder()
      Creates a builder for this class.
      Returns:
      new builder