Package org.forgerock.opendj.ldap.messages

Class AbstractIntermediateResponse<S extends IntermediateResponse>

java.lang.Object
org.forgerock.opendj.ldap.messages.AbstractIntermediateResponse<S>
Type Parameters:
S - The type of Intermediate response.
All Implemented Interfaces:
IntermediateResponse, ProtocolOp, Response
public abstract class AbstractIntermediateResponse<S extends IntermediateResponse> extends Object implements IntermediateResponse
An abstract Intermediate response which can be used as the basis for implementing new Intermediate responses.

  • Constructor Details

    • AbstractIntermediateResponse

      protected AbstractIntermediateResponse()
      Creates a new intermediate response.

    • AbstractIntermediateResponse

      protected AbstractIntermediateResponse(IntermediateResponse intermediateResponse)
      Creates a new intermediate response that is an exact copy of the provided response.
      Parameters:
      intermediateResponse - The intermediate response to be copied.
      Throws:
      NullPointerException - If intermediateResponse was null .

  • Method Details

    • getOid

      public abstract String getOid()
      Description copied from interface: IntermediateResponse
      Returns the numeric OID, if any, associated with this intermediate response.
      Specified by:
      getOid in interface IntermediateResponse
      Returns:
      The numeric OID associated with this intermediate response, or null if there is no OID.

    • getValue

      public abstract ByteString getValue()
      Description copied from interface: IntermediateResponse
      Returns the value, if any, associated with this intermediate response. Its format is defined by the specification of this intermediate response.
      Specified by:
      getValue in interface IntermediateResponse
      Returns:
      The value associated with this intermediate response, or null if there is no value.

    • hasValue

      public abstract boolean hasValue()
      Description copied from interface: IntermediateResponse
      Returns true if this intermediate response has a value. In some circumstances it may be useful to determine if an intermediate response has a value, without actually calculating the value and incurring any performance costs.
      Specified by:
      hasValue in interface IntermediateResponse
      Returns:
      true if this intermediate response has a value, or false if there is no value.

    • toString

      public String toString()

    • addControl

      public final S addControl(Control control)
      Description copied from interface: ProtocolOp
      Adds the provided control to this protocol-op.
      Specified by:
      addControl in interface ProtocolOp
      Parameters:
      control - The control to be added to this protocol-op.
      Returns:
      This protocol-op.

    • addControls

      public final S addControls(Iterable<? extends Control> controls)
      Description copied from interface: ProtocolOp
      Adds the provided controls to this protocol-op.
      Specified by:
      addControls in interface ProtocolOp
      Parameters:
      controls - The controls to be added to this protocol-op.
      Returns:
      This protocol-op.

    • removeControls

      public final S removeControls(String oid)
      Description copied from interface: ProtocolOp
      Removes all the controls having the specified OID.
      Specified by:
      removeControls in interface ProtocolOp
      Parameters:
      oid - The numeric OID of the protocol-op control to remove.
      Returns:
      This protocol-op.

    • containsControl

      public final boolean containsControl(String oid)
      Description copied from interface: ProtocolOp
      Returns true if this protocol-op contains the specified control.
      Specified by:
      containsControl in interface ProtocolOp
      Parameters:
      oid - The numeric OID of the protocol-op control.
      Returns:
      true if this protocol-op contains the specified control.

    • getControl

      public final <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
      Description copied from interface: ProtocolOp
      Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
      Specified by:
      getControl in interface ProtocolOp
      Type Parameters:
      C - The type of control to be decoded and returned.
      Parameters:
      decoder - The control decoder.
      options - The set of decode options which should be used when decoding the control.
      Returns:
      The decoded control, or null if the control is not included with this protocol-op.
      Throws:
      DecodeException - If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).

    • getControls

      public final List<Control> getControls()
      Description copied from interface: ProtocolOp
      Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.
      Specified by:
      getControls in interface ProtocolOp
      Returns:
      A List containing the controls.