Class LdapQueryPipeBase

All Implemented Interfaces:
HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
Direct Known Subclasses:
LdapFindGroupMembershipsPipe, LdapFindMemberPipe

public abstract class LdapQueryPipeBase extends FixedForwardPipe
Base pipe for querying LDAP.
Gerrit van Brakel
  • Field Details

  • Constructor Details

    • LdapQueryPipeBase

      public LdapQueryPipeBase()
  • 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
      Specified by:
      configure in interface IPipe
      configure in class FixedForwardPipe
    • 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. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.
    • doPipeWithException

      public abstract PipeRunResult doPipeWithException(Message message, PipeLineSession session) 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
    • setBaseDN

      public void setBaseDN(String baseDN)
      Default value
    • 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
    • getLdapProviderURL

      public String getLdapProviderURL()
    • getHost

      public String getHost()
    • getPort

      public int getPort()
    • isUseSsl

      public boolean isUseSsl()
    • getBaseDN

      public String getBaseDN()
    • getAuthAlias

      public String getAuthAlias()
    • getUsername

      public String getUsername()
    • getPassword

      public String getPassword()
    • getNotFoundForwardName

      public String getNotFoundForwardName()
    • getExceptionForwardName

      public String getExceptionForwardName()