Package org.opends.server.protocols.ldap

Class IntermediateResponseProtocolOp

  • public class IntermediateResponseProtocolOp
extends ProtocolOp
    This class defines the structures and methods for an LDAP intermediate response protocol op, which is used to provide information to a client before the final response for an operation.

    • Constructor Detail

      • IntermediateResponseProtocolOp

        public IntermediateResponseProtocolOp​(String oid)
        Creates a new intermediate protocol op with the specified OID and no value.
        Parameters:
        oid - The OID for this intermediate response.

      • IntermediateResponseProtocolOp

        public IntermediateResponseProtocolOp​(String oid,
                                      ByteString value)
        Creates a new intermediate response protocol op with the specified OID and value.
        Parameters:
        oid - The OID for this intermediate response.
        value - The value for this intermediate response.

    • Method Detail

      • getOID

        public String getOID()
        Retrieves the OID for this intermediate response.
        Returns:
        The OID for this intermediate response, or null if there is no OID.

      • getValue

        public ByteString getValue()
        Retrieves the value for this intermediate response.
        Returns:
        The value for this intermediate response, or null if there is no value.

      • getType

        public byte getType()
        Retrieves the BER type for this protocol op.
        Specified by:
        getType in class ProtocolOp
        Returns:
        The BER type for this protocol op.

      • getProtocolOpName

        public String getProtocolOpName()
        Retrieves the name for this protocol op type.
        Specified by:
        getProtocolOpName in class ProtocolOp
        Returns:
        The name for this protocol op type.

      • write

        public void write​(ASN1Writer stream)
           throws IOException
        Writes this protocol op to an ASN.1 output stream.
        Specified by:
        write in class ProtocolOp
        Parameters:
        stream - The ASN.1 output stream to write to.
        Throws:
        IOException - If a problem occurs while writing to the stream.

      • toString

        public void toString​(StringBuilder buffer)
        Appends a string representation of this LDAP protocol op to the provided buffer.
        Specified by:
        toString in class ProtocolOp
        Parameters:
        buffer - The buffer to which the string should be appended.

      • toString

        public void toString​(StringBuilder buffer,
                     int indent)
        Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
        Specified by:
        toString in class ProtocolOp
        Parameters:
        buffer - The buffer to which the information should be appended.
        indent - The number of spaces from the margin that the lines should be indented.