Package org.ldaptive

Class AbstractOperationFactory<Q extends Request,S extends Result>

java.lang.Object
org.ldaptive.AbstractFreezable
org.ldaptive.AbstractOperationFactory<Q,S>
Type Parameters:
Q - type of request
S - type of result
All Implemented Interfaces:
ConnectionFactoryManager, Freezable
Direct Known Subclasses:
AbstractSearchOperationFactory
public abstract class AbstractOperationFactory<Q extends Request,S extends Result> extends AbstractFreezable implements ConnectionFactoryManager
Base class for classes that need to configure an operation.

  • Field Details

    • logger

      protected final Logger logger
      Logger for this class.

    • factory

      private ConnectionFactory factory
      Connection factory.

    • requestHandlers

      private RequestHandler<Q extends Request>[] requestHandlers
      Functions to handle requests.

    • resultHandlers

      private ResultHandler[] resultHandlers
      Functions to handle response results.

    • controlHandlers

      private ResponseControlHandler[] controlHandlers
      Functions to handle response controls.

    • referralHandlers

      private ReferralHandler[] referralHandlers
      Functions to handle referrals.

    • intermediateResponseHandlers

      private IntermediateResponseHandler[] intermediateResponseHandlers
      Functions to handle intermediate responses.

    • exceptionHandler

      private ExceptionHandler exceptionHandler
      Function to handle exceptions.

    • throwCondition

      private ResultPredicate throwCondition
      Function to test results.

    • unsolicitedNotificationHandlers

      private UnsolicitedNotificationHandler[] unsolicitedNotificationHandlers
      Functions to handle unsolicited notifications.

  • Constructor Details

    • AbstractOperationFactory

      public AbstractOperationFactory()

  • 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

    • getConnectionFactory

      public ConnectionFactory getConnectionFactory()
      Returns the connection factory.
      Specified by:
      getConnectionFactory in interface ConnectionFactoryManager
      Returns:
      connection factory

    • setConnectionFactory

      public void setConnectionFactory(ConnectionFactory cf)
      Sets the connection factory.
      Specified by:
      setConnectionFactory in interface ConnectionFactoryManager
      Parameters:
      cf - connection factory

    • getRequestHandlers

      public RequestHandler<Q>[] getRequestHandlers()
      Returns the request handlers.
      Returns:
      request handlers

    • setRequestHandlers

      public void setRequestHandlers(RequestHandler<Q>... handlers)
      Sets the request handlers.
      Parameters:
      handlers - request handler

    • getResultHandlers

      public ResultHandler[] getResultHandlers()
      Returns the search result handlers.
      Returns:
      search result handlers

    • setResultHandlers

      public void setResultHandlers(ResultHandler... handlers)
      Sets the search result handlers.
      Parameters:
      handlers - search result handlers

    • getControlHandlers

      public ResponseControlHandler[] getControlHandlers()
      Returns the control handlers.
      Returns:
      control handlers

    • setControlHandlers

      public void setControlHandlers(ResponseControlHandler... handlers)
      Sets the control handlers.
      Parameters:
      handlers - control handlers

    • getReferralHandlers

      public ReferralHandler[] getReferralHandlers()
      Returns the referral handlers.
      Returns:
      referral handlers

    • setReferralHandlers

      public void setReferralHandlers(ReferralHandler... handlers)
      Sets the referral handlers.
      Parameters:
      handlers - referral handlers

    • getIntermediateResponseHandlers

      public IntermediateResponseHandler[] getIntermediateResponseHandlers()
      Returns the intermediate response handlers.
      Returns:
      intermediate response handlers

    • setIntermediateResponseHandlers

      public void setIntermediateResponseHandlers(IntermediateResponseHandler... handlers)
      Sets the intermediate response handlers.
      Parameters:
      handlers - intermediate response handlers

    • getExceptionHandler

      public ExceptionHandler getExceptionHandler()
      Returns the search exception handler.
      Returns:
      search exception handler

    • setExceptionHandler

      public void setExceptionHandler(ExceptionHandler handler)
      Sets the search exception handler.
      Parameters:
      handler - search exception handler

    • getThrowCondition

      public ResultPredicate getThrowCondition()
      Returns the throw condition.
      Returns:
      throw condition

    • setThrowCondition

      public void setThrowCondition(ResultPredicate function)
      Sets the throw condition.
      Parameters:
      function - throw condition

    • getUnsolicitedNotificationHandlers

      public UnsolicitedNotificationHandler[] getUnsolicitedNotificationHandlers()
      Returns the unsolicited notification handlers.
      Returns:
      unsolicited notification handlers

    • setUnsolicitedNotificationHandlers

      public void setUnsolicitedNotificationHandlers(UnsolicitedNotificationHandler... handlers)
      Sets the unsolicited notification handlers.
      Parameters:
      handlers - unsolicited notification handlers

    • initializeOperation

      protected void initializeOperation(AbstractOperation<Q,S> op)
      Initializes the supplied operation with the properties configured on this factory.
      Parameters:
      op - operation to initialize

    • toString

      public String toString()
      Overrides:
      toString in class Object