Class AbstractLdapQueryPipe

All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
Direct Known Subclasses:
LdapFindGroupMembershipsPipe, LdapFindMemberPipe

@Forward(name="*",description="When {@literal notFoundForwardName} or {@literal exceptionForwardName} is used") @Forward(name="notFound",description="Default forward used when member is not found. Overridable by {@literal notFoundForwardName}") public abstract class AbstractLdapQueryPipe extends FixedForwardPipe
Base pipe for querying LDAP.
Author:
Gerrit van Brakel
  • Field Details

  • Constructor Details

    • AbstractLdapQueryPipe

      public AbstractLdapQueryPipe()
  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from class: FixedForwardPipe
      Checks for correct configuration of forward.
      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class FixedForwardPipe
      Throws:
      ConfigurationException - in case it was not able to configure the component.
    • doPipe

      public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
      Description copied from interface: IPipe
      This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.
      Throws:
      PipeRunException
    • doPipeWithException

      public abstract PipeRunResult doPipeWithException(Message message, PipeLineSession session) throws PipeRunException
      Throws:
      PipeRunException
    • retrieveUrl

      protected String retrieveUrl(String host, int port, String baseDN, boolean useSsl)
    • setLdapProviderURL

      public void setLdapProviderURL(String string)
      Url to context to search in, e.g. 'ldaps://DOMAIN.EXT'.
    • setHost

      public void setHost(String string)
      Host part of ldapProviderUrl. Only used when ldapProviderUrl not specified
    • setPort

      public void setPort(int i)
      Port of ldapProviderUrl. Only used when ldapProviderUrl not specified
    • setUseSsl

      public void setUseSsl(boolean b)
      Indication to use ldap or ldaps in ldapProviderUrl. Only used when ldapProviderUrl not specified
      Default value
      false
    • setBaseDN

      public void setBaseDN(String baseDN)
      BaseDN, e.g. CN=USERS,DC=DOMAIN,DC=EXT
      Default value
      false
    • setAuthAlias

      public void setAuthAlias(String string)
      Alias used to obtain credentials to connect to ldap server
    • setUsername

      public void setUsername(String string)
      Username used to obtain credentials to connect to ldap server
    • setPassword

      public void setPassword(String string)
      Password used to obtain credentials to connect to ldap server
    • setNotFoundForwardName

      public void setNotFoundForwardName(String string)
    • setExceptionForwardName

      public void setExceptionForwardName(String string)
      PipeForward used when an exception is caught