Package org.forgerock.opendj.ldap.messages

Enum Class Request.RequestType

java.lang.Object
java.lang.Enum<Request.RequestType>
org.forgerock.opendj.ldap.messages.Request.RequestType
All Implemented Interfaces:
Serializable, Comparable<Request.RequestType>, java.lang.constant.Constable
Enclosing interface:
Request
public static enum Request.RequestType extends Enum<Request.RequestType>
The type of this request. Components like access logging can rely on the string representation, for example by calling request.getType().name().

  • Enum Constant Details

    • ABANDON

      public static final Request.RequestType ABANDON
      Abandon request type.

    • ADD

      public static final Request.RequestType ADD
      Add request type.

    • BIND

      public static final Request.RequestType BIND
      Bind request type.

    • COMPARE

      public static final Request.RequestType COMPARE
      Compare request type.

    • DELETE

      public static final Request.RequestType DELETE
      Delete request type.

    • EXTENDED

      public static final Request.RequestType EXTENDED
      Extended request type.

    • MODIFYDN

      public static final Request.RequestType MODIFYDN
      Modify DN request type.

    • MODIFY

      public static final Request.RequestType MODIFY
      Modify request type.

    • UNBIND

      public static final Request.RequestType UNBIND
      Unbind request type.

    • UNKNOWN

      public static final Request.RequestType UNKNOWN
      Unknown request type. Unknown requests do not have a response because the type of the response cannot be determined and therefore it cannot be encoded and sent. On receipt of an unknown request, the only viable action a server can take is to not return anything and instead disconnect the client in order to avoid leaving the client waiting indefinitely.

    • INVALID

      public static final Request.RequestType INVALID
      Invalid request type. Invalid requests have a response because the type of the request can be determined. However, the request content cannot be parsed for some reason, such as an invalid target DN. In such cases an appropriate result message can be returned by the server.

  • Method Details

    • values

      public static Request.RequestType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Request.RequestType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getProtocolOperationType

      public byte getProtocolOperationType()
      Returns the protocol operation type.
      Returns:
      the protocol operation type

    • hasResponse

      public boolean hasResponse()
      Returns true if this type of request is expected to return a response to the client. All types of request have responses except for UNBIND and ABANDON requests.
      Returns:
      true if this type of request is expected to return a response to the client.