org.opends.server.protocols.ldap
Class LDAPConstants

java.lang.Object
  extended by org.opends.server.protocols.ldap.LDAPConstants

public class LDAPConstants
extends java.lang.Object

This class defines a number of constants used in the LDAP protocol.


Field Summary
static int DEREF_ALWAYS
          The alias dereferencing policy value that will be used for cases in which all aliases encountered should be dereferenced.
static int DEREF_FINDING_BASE
          The alias dereferencing policy value that will be used for cases in which the search base should be dereferenced if it is an alias.
static int DEREF_IN_SEARCHING
          The alias dereferencing policy value that will be used for cases in which any aliases encountered while finding matching entries should be dereferenced.
static int DEREF_NEVER
          The alias dereferencing policy value that will be used for cases in which aliases are never to be dereferenced.
static int ELEMENT_READ_STATE_NEED_ADDITIONAL_LENGTH_BYTES
          The ASN.1 element decoding state that indicates that the next byte read should be additional bytes of a multi-byte length.
static int ELEMENT_READ_STATE_NEED_FIRST_LENGTH_BYTE
          The ASN.1 element decoding state that indicates that the next byte read should be the first byte for the element length.
static int ELEMENT_READ_STATE_NEED_TYPE
          The ASN.1 element decoding state that indicates that the next byte read should be the BER type for a new element.
static int ELEMENT_READ_STATE_NEED_VALUE_BYTES
          The ASN.1 element decoding state that indicates that the next byte read should be applied to the value of the element.
static int MOD_TYPE_ADD
          The enumerated type for modify operations that add one or more values for an attribute.
static int MOD_TYPE_DELETE
          The enumerated type for modify operations that remove one or more values from an attribute.
static int MOD_TYPE_INCREMENT
          The enumerated type for modify operations that increment the value for an attribute.
static int MOD_TYPE_REPLACE
          The enumerated type for modify operations that replace the set of values for an attribute.
static java.lang.String OID_GSSAPI_KERBEROS_V
          The OID for the Kerberos V GSSAPI mechanism.
static java.lang.String OID_NOTICE_OF_DISCONNECTION
          The OID for the LDAP notice of disconnection extended operation.
static byte OP_TYPE_ABANDON_REQUEST
          The protocol op type for abandon requests.
static byte OP_TYPE_ADD_REQUEST
          The protocol op type for add requests.
static byte OP_TYPE_ADD_RESPONSE
          The protocol op type for add responses.
static byte OP_TYPE_BIND_REQUEST
          The protocol op type for bind requests.
static byte OP_TYPE_BIND_RESPONSE
          The protocol op type for bind responses.
static byte OP_TYPE_COMPARE_REQUEST
          The protocol op type for compare requests.
static byte OP_TYPE_COMPARE_RESPONSE
          The protocol op type for compare responses.
static byte OP_TYPE_DELETE_REQUEST
          The protocol op type for delete requests.
static byte OP_TYPE_DELETE_RESPONSE
          The protocol op type for delete responses.
static byte OP_TYPE_EXTENDED_REQUEST
          The protocol op type for extended requests.
static byte OP_TYPE_EXTENDED_RESPONSE
          The protocol op type for extended responses.
static byte OP_TYPE_INTERMEDIATE_RESPONSE
          The protocol op type for intermediate responses.
static byte OP_TYPE_MODIFY_DN_REQUEST
          The protocol op type for modify DN requests.
static byte OP_TYPE_MODIFY_DN_RESPONSE
          The protocol op type for modify DN responses.
static byte OP_TYPE_MODIFY_REQUEST
          The protocol op type for modify requests.
static byte OP_TYPE_MODIFY_RESPONSE
          The protocol op type for modify responses.
static byte OP_TYPE_SEARCH_REQUEST
          The protocol op type for search requests.
static byte OP_TYPE_SEARCH_RESULT_DONE
          The protocol op type for search result done elements.
static byte OP_TYPE_SEARCH_RESULT_ENTRY
          The protocol op type for search result entries.
static byte OP_TYPE_SEARCH_RESULT_REFERENCE
          The protocol op type for search result references.
static byte OP_TYPE_UNBIND_REQUEST
          The protocol op type for unbind requests.
static int SCOPE_BASE_OBJECT
          The search scope value that will be used for base-level searches.
static int SCOPE_SINGLE_LEVEL
          The search scope value that will be used for single-level searches.
static int SCOPE_SUBORDINATE_SUBTREE
          The search scope value that will be used for subordinate subtree searches.
static int SCOPE_WHOLE_SUBTREE
          The search scope value that will be used for whole subtree searches.
static byte TYPE_AUTHENTICATION_SASL
          The BER type to use for the AuthenticationChoice element in a bind request when SASL authentication is to be used.
static byte TYPE_AUTHENTICATION_SIMPLE
          The BER type to use for the AuthenticationChoice element in a bind request when simple authentication is to be used.
static byte TYPE_CONTROL_SEQUENCE
          The BER type to use for encoding the sequence of controls in an LDAP message.
static byte TYPE_EXTENDED_REQUEST_OID
          The BER type to use for the OID of an extended request.
static byte TYPE_EXTENDED_REQUEST_VALUE
          The BER type to use for the value of an extended request.
static byte TYPE_EXTENDED_RESPONSE_OID
          The BER type to use for the OID of an extended response.
static byte TYPE_EXTENDED_RESPONSE_VALUE
          The BER type to use for the value of an extended response.
static byte TYPE_FILTER_AND
          The BER type to use for AND filter components.
static byte TYPE_FILTER_APPROXIMATE
          The BER type to use for approximate filter components.
static byte TYPE_FILTER_EQUALITY
          The BER type to use for equality filter components.
static byte TYPE_FILTER_EXTENSIBLE_MATCH
          The BER type to use for extensible matching filter components.
static byte TYPE_FILTER_GREATER_OR_EQUAL
          The BER type to use for greater than or equal to filter components.
static byte TYPE_FILTER_LESS_OR_EQUAL
          The BER type to use for less than or equal to filter components.
static byte TYPE_FILTER_NOT
          The BER type to use for NOT filter components.
static byte TYPE_FILTER_OR
          The BER type to use for OR filter components.
static byte TYPE_FILTER_PRESENCE
          The BER type to use for presence filter components.
static byte TYPE_FILTER_SUBSTRING
          The BER type to use for substring filter components.
static byte TYPE_INTERMEDIATE_RESPONSE_OID
          The BER type to use for the OID of an intermediate response message.
static byte TYPE_INTERMEDIATE_RESPONSE_VALUE
          The BER type to use for the value of an intermediate response message.
static byte TYPE_MATCHING_RULE_DN_ATTRIBUTES
          The BER type to use for the DN attributes flag in a matching rule assertion.
static byte TYPE_MATCHING_RULE_ID
          The BER type to use for the matching rule OID in a matching rule assertion.
static byte TYPE_MATCHING_RULE_TYPE
          The BER type to use for the attribute type in a matching rule assertion.
static byte TYPE_MATCHING_RULE_VALUE
          The BER type to use for the assertion value in a matching rule assertion.
static byte TYPE_MODIFY_DN_NEW_SUPERIOR
          The BER type to use for the newSuperior component of a modify DN request.
static byte TYPE_REFERRAL_SEQUENCE
          The BER type to use for encoding the sequence of referral URLs in an LDAPResult element.
static byte TYPE_SERVER_SASL_CREDENTIALS
          The BER type to use for the server SASL credentials in a bind response.
static byte TYPE_SUBANY
          The BER type to use for the subAny component(s) of a substring filter.
static byte TYPE_SUBFINAL
          The BER type to use for the subFinal components of a substring filter.
static byte TYPE_SUBINITIAL
          The BER type to use for the subInitial component of a substring filter.
 
Constructor Summary
LDAPConstants()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OP_TYPE_BIND_REQUEST

public static final byte OP_TYPE_BIND_REQUEST
The protocol op type for bind requests.

See Also:
Constant Field Values

OP_TYPE_BIND_RESPONSE

public static final byte OP_TYPE_BIND_RESPONSE
The protocol op type for bind responses.

See Also:
Constant Field Values

OP_TYPE_UNBIND_REQUEST

public static final byte OP_TYPE_UNBIND_REQUEST
The protocol op type for unbind requests.

See Also:
Constant Field Values

OP_TYPE_SEARCH_REQUEST

public static final byte OP_TYPE_SEARCH_REQUEST
The protocol op type for search requests.

See Also:
Constant Field Values

OP_TYPE_SEARCH_RESULT_ENTRY

public static final byte OP_TYPE_SEARCH_RESULT_ENTRY
The protocol op type for search result entries.

See Also:
Constant Field Values

OP_TYPE_SEARCH_RESULT_REFERENCE

public static final byte OP_TYPE_SEARCH_RESULT_REFERENCE
The protocol op type for search result references.

See Also:
Constant Field Values

OP_TYPE_SEARCH_RESULT_DONE

public static final byte OP_TYPE_SEARCH_RESULT_DONE
The protocol op type for search result done elements.

See Also:
Constant Field Values

OP_TYPE_MODIFY_REQUEST

public static final byte OP_TYPE_MODIFY_REQUEST
The protocol op type for modify requests.

See Also:
Constant Field Values

OP_TYPE_MODIFY_RESPONSE

public static final byte OP_TYPE_MODIFY_RESPONSE
The protocol op type for modify responses.

See Also:
Constant Field Values

OP_TYPE_ADD_REQUEST

public static final byte OP_TYPE_ADD_REQUEST
The protocol op type for add requests.

See Also:
Constant Field Values

OP_TYPE_ADD_RESPONSE

public static final byte OP_TYPE_ADD_RESPONSE
The protocol op type for add responses.

See Also:
Constant Field Values

OP_TYPE_DELETE_REQUEST

public static final byte OP_TYPE_DELETE_REQUEST
The protocol op type for delete requests.

See Also:
Constant Field Values

OP_TYPE_DELETE_RESPONSE

public static final byte OP_TYPE_DELETE_RESPONSE
The protocol op type for delete responses.

See Also:
Constant Field Values

OP_TYPE_MODIFY_DN_REQUEST

public static final byte OP_TYPE_MODIFY_DN_REQUEST
The protocol op type for modify DN requests.

See Also:
Constant Field Values

OP_TYPE_MODIFY_DN_RESPONSE

public static final byte OP_TYPE_MODIFY_DN_RESPONSE
The protocol op type for modify DN responses.

See Also:
Constant Field Values

OP_TYPE_COMPARE_REQUEST

public static final byte OP_TYPE_COMPARE_REQUEST
The protocol op type for compare requests.

See Also:
Constant Field Values

OP_TYPE_COMPARE_RESPONSE

public static final byte OP_TYPE_COMPARE_RESPONSE
The protocol op type for compare responses.

See Also:
Constant Field Values

OP_TYPE_ABANDON_REQUEST

public static final byte OP_TYPE_ABANDON_REQUEST
The protocol op type for abandon requests.

See Also:
Constant Field Values

OP_TYPE_EXTENDED_REQUEST

public static final byte OP_TYPE_EXTENDED_REQUEST
The protocol op type for extended requests.

See Also:
Constant Field Values

OP_TYPE_EXTENDED_RESPONSE

public static final byte OP_TYPE_EXTENDED_RESPONSE
The protocol op type for extended responses.

See Also:
Constant Field Values

OP_TYPE_INTERMEDIATE_RESPONSE

public static final byte OP_TYPE_INTERMEDIATE_RESPONSE
The protocol op type for intermediate responses.

See Also:
Constant Field Values

TYPE_CONTROL_SEQUENCE

public static final byte TYPE_CONTROL_SEQUENCE
The BER type to use for encoding the sequence of controls in an LDAP message.

See Also:
Constant Field Values

TYPE_REFERRAL_SEQUENCE

public static final byte TYPE_REFERRAL_SEQUENCE
The BER type to use for encoding the sequence of referral URLs in an LDAPResult element.

See Also:
Constant Field Values

TYPE_AUTHENTICATION_SIMPLE

public static final byte TYPE_AUTHENTICATION_SIMPLE
The BER type to use for the AuthenticationChoice element in a bind request when simple authentication is to be used.

See Also:
Constant Field Values

TYPE_AUTHENTICATION_SASL

public static final byte TYPE_AUTHENTICATION_SASL
The BER type to use for the AuthenticationChoice element in a bind request when SASL authentication is to be used.

See Also:
Constant Field Values

TYPE_SERVER_SASL_CREDENTIALS

public static final byte TYPE_SERVER_SASL_CREDENTIALS
The BER type to use for the server SASL credentials in a bind response.

See Also:
Constant Field Values

TYPE_FILTER_AND

public static final byte TYPE_FILTER_AND
The BER type to use for AND filter components.

See Also:
Constant Field Values

TYPE_FILTER_OR

public static final byte TYPE_FILTER_OR
The BER type to use for OR filter components.

See Also:
Constant Field Values

TYPE_FILTER_NOT

public static final byte TYPE_FILTER_NOT
The BER type to use for NOT filter components.

See Also:
Constant Field Values

TYPE_FILTER_EQUALITY

public static final byte TYPE_FILTER_EQUALITY
The BER type to use for equality filter components.

See Also:
Constant Field Values

TYPE_FILTER_SUBSTRING

public static final byte TYPE_FILTER_SUBSTRING
The BER type to use for substring filter components.

See Also:
Constant Field Values

TYPE_FILTER_GREATER_OR_EQUAL

public static final byte TYPE_FILTER_GREATER_OR_EQUAL
The BER type to use for greater than or equal to filter components.

See Also:
Constant Field Values

TYPE_FILTER_LESS_OR_EQUAL

public static final byte TYPE_FILTER_LESS_OR_EQUAL
The BER type to use for less than or equal to filter components.

See Also:
Constant Field Values

TYPE_FILTER_PRESENCE

public static final byte TYPE_FILTER_PRESENCE
The BER type to use for presence filter components.

See Also:
Constant Field Values

TYPE_FILTER_APPROXIMATE

public static final byte TYPE_FILTER_APPROXIMATE
The BER type to use for approximate filter components.

See Also:
Constant Field Values

TYPE_FILTER_EXTENSIBLE_MATCH

public static final byte TYPE_FILTER_EXTENSIBLE_MATCH
The BER type to use for extensible matching filter components.

See Also:
Constant Field Values

TYPE_SUBINITIAL

public static final byte TYPE_SUBINITIAL
The BER type to use for the subInitial component of a substring filter.

See Also:
Constant Field Values

TYPE_SUBANY

public static final byte TYPE_SUBANY
The BER type to use for the subAny component(s) of a substring filter.

See Also:
Constant Field Values

TYPE_SUBFINAL

public static final byte TYPE_SUBFINAL
The BER type to use for the subFinal components of a substring filter.

See Also:
Constant Field Values

TYPE_MATCHING_RULE_ID

public static final byte TYPE_MATCHING_RULE_ID
The BER type to use for the matching rule OID in a matching rule assertion.

See Also:
Constant Field Values

TYPE_MATCHING_RULE_TYPE

public static final byte TYPE_MATCHING_RULE_TYPE
The BER type to use for the attribute type in a matching rule assertion.

See Also:
Constant Field Values

TYPE_MATCHING_RULE_VALUE

public static final byte TYPE_MATCHING_RULE_VALUE
The BER type to use for the assertion value in a matching rule assertion.

See Also:
Constant Field Values

TYPE_MATCHING_RULE_DN_ATTRIBUTES

public static final byte TYPE_MATCHING_RULE_DN_ATTRIBUTES
The BER type to use for the DN attributes flag in a matching rule assertion.

See Also:
Constant Field Values

TYPE_MODIFY_DN_NEW_SUPERIOR

public static final byte TYPE_MODIFY_DN_NEW_SUPERIOR
The BER type to use for the newSuperior component of a modify DN request.

See Also:
Constant Field Values

TYPE_EXTENDED_REQUEST_OID

public static final byte TYPE_EXTENDED_REQUEST_OID
The BER type to use for the OID of an extended request.

See Also:
Constant Field Values

TYPE_EXTENDED_REQUEST_VALUE

public static final byte TYPE_EXTENDED_REQUEST_VALUE
The BER type to use for the value of an extended request.

See Also:
Constant Field Values

TYPE_EXTENDED_RESPONSE_OID

public static final byte TYPE_EXTENDED_RESPONSE_OID
The BER type to use for the OID of an extended response.

See Also:
Constant Field Values

TYPE_EXTENDED_RESPONSE_VALUE

public static final byte TYPE_EXTENDED_RESPONSE_VALUE
The BER type to use for the value of an extended response.

See Also:
Constant Field Values

TYPE_INTERMEDIATE_RESPONSE_OID

public static final byte TYPE_INTERMEDIATE_RESPONSE_OID
The BER type to use for the OID of an intermediate response message.

See Also:
Constant Field Values

TYPE_INTERMEDIATE_RESPONSE_VALUE

public static final byte TYPE_INTERMEDIATE_RESPONSE_VALUE
The BER type to use for the value of an intermediate response message.

See Also:
Constant Field Values

MOD_TYPE_ADD

public static final int MOD_TYPE_ADD
The enumerated type for modify operations that add one or more values for an attribute.

See Also:
Constant Field Values

MOD_TYPE_DELETE

public static final int MOD_TYPE_DELETE
The enumerated type for modify operations that remove one or more values from an attribute.

See Also:
Constant Field Values

MOD_TYPE_REPLACE

public static final int MOD_TYPE_REPLACE
The enumerated type for modify operations that replace the set of values for an attribute.

See Also:
Constant Field Values

MOD_TYPE_INCREMENT

public static final int MOD_TYPE_INCREMENT
The enumerated type for modify operations that increment the value for an attribute.

See Also:
Constant Field Values

SCOPE_BASE_OBJECT

public static final int SCOPE_BASE_OBJECT
The search scope value that will be used for base-level searches.

See Also:
Constant Field Values

SCOPE_SINGLE_LEVEL

public static final int SCOPE_SINGLE_LEVEL
The search scope value that will be used for single-level searches.

See Also:
Constant Field Values

SCOPE_WHOLE_SUBTREE

public static final int SCOPE_WHOLE_SUBTREE
The search scope value that will be used for whole subtree searches.

See Also:
Constant Field Values

SCOPE_SUBORDINATE_SUBTREE

public static final int SCOPE_SUBORDINATE_SUBTREE
The search scope value that will be used for subordinate subtree searches.

See Also:
Constant Field Values

DEREF_NEVER

public static final int DEREF_NEVER
The alias dereferencing policy value that will be used for cases in which aliases are never to be dereferenced.

See Also:
Constant Field Values

DEREF_IN_SEARCHING

public static final int DEREF_IN_SEARCHING
The alias dereferencing policy value that will be used for cases in which any aliases encountered while finding matching entries should be dereferenced.

See Also:
Constant Field Values

DEREF_FINDING_BASE

public static final int DEREF_FINDING_BASE
The alias dereferencing policy value that will be used for cases in which the search base should be dereferenced if it is an alias.

See Also:
Constant Field Values

DEREF_ALWAYS

public static final int DEREF_ALWAYS
The alias dereferencing policy value that will be used for cases in which all aliases encountered should be dereferenced.

See Also:
Constant Field Values

OID_GSSAPI_KERBEROS_V

public static final java.lang.String OID_GSSAPI_KERBEROS_V
The OID for the Kerberos V GSSAPI mechanism.

See Also:
Constant Field Values

OID_NOTICE_OF_DISCONNECTION

public static final java.lang.String OID_NOTICE_OF_DISCONNECTION
The OID for the LDAP notice of disconnection extended operation.

See Also:
Constant Field Values

ELEMENT_READ_STATE_NEED_TYPE

public static final int ELEMENT_READ_STATE_NEED_TYPE
The ASN.1 element decoding state that indicates that the next byte read should be the BER type for a new element.

See Also:
Constant Field Values

ELEMENT_READ_STATE_NEED_FIRST_LENGTH_BYTE

public static final int ELEMENT_READ_STATE_NEED_FIRST_LENGTH_BYTE
The ASN.1 element decoding state that indicates that the next byte read should be the first byte for the element length.

See Also:
Constant Field Values

ELEMENT_READ_STATE_NEED_ADDITIONAL_LENGTH_BYTES

public static final int ELEMENT_READ_STATE_NEED_ADDITIONAL_LENGTH_BYTES
The ASN.1 element decoding state that indicates that the next byte read should be additional bytes of a multi-byte length.

See Also:
Constant Field Values

ELEMENT_READ_STATE_NEED_VALUE_BYTES

public static final int ELEMENT_READ_STATE_NEED_VALUE_BYTES
The ASN.1 element decoding state that indicates that the next byte read should be applied to the value of the element.

See Also:
Constant Field Values
Constructor Detail

LDAPConstants

public LDAPConstants()