edu.vt.middleware.ldap
Class LdapConstants

java.lang.Object
  edu.vt.middleware.ldap.LdapConstants

public final class LdapConstants
extends Object

LdapConstants contains all the constants needed for creating a Ldap. See http://java.sun.com/j2se/1.4.2/docs/guide/jndi/jndi-ldap.html or http://java.sun.com/j2se/1.4.2/docs/guide/jndi/spec/jndi/properties.html for more information on JNDI properties.

Version:

$Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $

Author:

Middleware Services

Field Summary

static String	AUTHENTICATION The value of this property is a string that specifies the authentication mechanism(s) for the provider to use.
static String	AUTHORITATIVE The value of this property is a string specifying the authoritativeness of the service requested.
static String	BATCH_SIZE The value of this property is a string of decimal digits that specifies the batch size of search results returned by the server.
static String	BINARY_ATTRIBUTES The value of this property is a string that specifies additional binary attributes.
static String	CONTEXT_FACTORY The value of this property is a fully qualified class name of the factory class which creates the initial context for the LDAP service provider.
static String	CREDENTIALS The value of this property is an object that specifies the credentials of the principal to be authenticated.
static boolean	DEFAULT_ALLOW_MULTIPLE_DNS Whether Authenticator should throw an exception if multiple DNs are found by Authenticator.getDn(String).
static boolean	DEFAULT_AUTHORITATIVE Default authoritative value, the value of this constant is false.
static String	DEFAULT_AUTHTYPE Default authentication type, the value of this constant is "simple".
static String	DEFAULT_BASE_DN Default base DN, value of this constant is "".
static int	DEFAULT_BATCH_SIZE Default batch size, -1 means use provider setting.
static String	DEFAULT_CHARSET Default character set for creating strings.
static String	DEFAULT_CONTEXT_FACTORY Default context factory, value of this constant is "com.sun.jndi.ldap.LdapCtxFactory".
static long	DEFAULT_COUNT_LIMIT Default count limit, 0 means return all results.
static boolean	DEFAULT_IGNORE_CASE Default ignore case value, value of this constant is true.
static boolean	DEFAULT_LOG_CREDENTIALS Whether to log authentication credentials.
static int	DEFAULT_OPERATION_RETRY Default number of times to retry an operation on failure.
static int	DEFAULT_OPERATION_RETRY_BACKOFF Default factor to multiply the operation retry wait by.
static long	DEFAULT_OPERATION_RETRY_WAIT Default amount of time to wait between operation retries.
static int	DEFAULT_PAGED_RESULTS_SIZE Default paged results size.
static String	DEFAULT_PORT Default ldap port, the value of this constant is "389".
static String	DEFAULT_SSL_PORT Default ldaps port, the value of this constant is "636".
static int	DEFAULT_TIME_LIMIT Default time limit, 0 means wait indefinitely.
static int	DEFAULT_TIMEOUT Default timeout, -1 means use provider setting.
static boolean	DEFAULT_TYPES_ONLY Default type only value, the value of this constant is false.
static boolean	DEFAULT_USE_SSL Whether to use SSL by default, the value of this constant is false.
static String	DEFAULT_USER_FIELD Default userfield field used by Authenticator.
static String	DEREF_ALIASES The value of this property is a string that specifies how aliases shall be handled by the provider.
static String	DNS_URL The value of this property is a string that specifies the DNS host and domain names.
static String	LANGUAGE The value of this property is a string language tag according to RFC 1766.
static String	NONE_AUTHTYPE Value passed to AUTHENTICATION to use none authentication The value of this constant is "none".
static String	PRINCIPAL The value of this property is a string that specifies the identity of the principal to be authenticated.
static String	PROTOCOL The value of this property is a string that specifies the security protocol for the provider to use.
static String	PROVIDER_URL The value of this property is a URL string that specifies the hostname and port number of the LDAP server, and the root distinguished name of the naming context to use.
static String	PROVIDER_URL_PREFIX URL prefix used for constructing URLs.
static String	PROVIDER_URL_SCHEME Ldap scheme, the value of this constant is "ldap".
static String	PROVIDER_URL_SEPARATOR URL separator used for constructing URLs.
static String	PROVIDER_URL_SSL_SCHEME Secure ldap scheme, the value of this constant is "ldaps".
static String	REFERRAL The value of this property is a string that specifies how referrals shall be handled by the provider.
static String	SASL_AUTHORIZATION_ID The value of this property is a string that specifies a SASL authorization id.
static String	SASL_MECHANISM_CRAM_MD5 Value passed to AUTHENTICATION to use CRAM-MD5 authentication.
static String	SASL_MECHANISM_DIGEST_MD5 Value passed to AUTHENTICATION to use DIGEST-MD5 authentication.
static String	SASL_MECHANISM_EXTERNAL Value passed to AUTHENTICATION to use SASL authentication.
static String	SASL_MECHANISM_GSS_API Value passed to AUTHENTICATION to use GSS-API authentication.
static String[]	SASL_MECHANISMS List of supported SASL Mechanisms.
static String	SASL_REALM The value of this property is a string that specifies a SASL realm.
static String	SIMPLE_AUTHTYPE Value passed to AUTHENTICATION to use simple authentication.
static String	SOCKET_FACTORY The value of this property is a string identifying the class name of a socket factory.
static String	SSL_PROTOCOL Value passed to PROTOCOL to use SSL.
static String	STRONG_AUTHTYPE Value passed to AUTHENTICATION to use simple authentication.
static String	SUPPORTED_CONTROL Ldap command which returns a list of supported controls.
static String	SUPPORTED_SASL_MECHANISMS Ldap command which returns a list of supported SASL mechanisms.
static String	TIMEOUT The value of this property is a string that specifies the time in milliseconds that a connection attempt will abort if the connection cannot be made.
static String	TRACE The value of this property is a java.io.OutputStream object into which a hexadecimal dump of the incoming and outgoing LDAP ASN.1 BER packets is written.
static String	TYPES_ONLY The value of this property is a string that specifies to only return attribute type names, no values.
static String	VERSION The value of this property is a string that specifies the protocol version for the provider.
static String	VERSION_THREE Value passed to VERSION to use ldap version 3 controls The value of this constant is "3".

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_FACTORY

public static final String CONTEXT_FACTORY

The value of this property is a fully qualified class name of the factory class which creates the initial context for the LDAP service provider. The value of this constant is "java.naming.factory.initial".

See Also:

Constant Field Values

SOCKET_FACTORY

public static final String SOCKET_FACTORY

The value of this property is a string identifying the class name of a socket factory. The value of this constant is "java.naming.ldap.factory.socket".

See Also:

Constant Field Values

AUTHORITATIVE

public static final String AUTHORITATIVE

The value of this property is a string specifying the authoritativeness of the service requested. The value of this constant is "java.naming.authoritative".

See Also:

Constant Field Values

TRACE

public static final String TRACE

The value of this property is a java.io.OutputStream object into which a hexadecimal dump of the incoming and outgoing LDAP ASN.1 BER packets is written. The value of this constant is "com.sun.jndi.ldap.trace.ber".

See Also:

Constant Field Values

AUTHENTICATION

public static final String AUTHENTICATION

The value of this property is a string that specifies the authentication mechanism(s) for the provider to use. The value of this constant is "java.naming.security.authentication".

See Also:

Constant Field Values

PRINCIPAL

public static final String PRINCIPAL

The value of this property is a string that specifies the identity of the principal to be authenticated. The value of this constant is "java.naming.security.principal".

See Also:

Constant Field Values

CREDENTIALS

public static final String CREDENTIALS

The value of this property is an object that specifies the credentials of the principal to be authenticated. The value of this constant is "java.naming.security.credentials".

See Also:

Constant Field Values

BATCH_SIZE

public static final String BATCH_SIZE

The value of this property is a string of decimal digits that specifies the batch size of search results returned by the server. The value of this constant is "java.naming.batchsize".

See Also:

Constant Field Values

DNS_URL

public static final String DNS_URL

The value of this property is a string that specifies the DNS host and domain names. The value of this constant is "java.naming.dns.url".

See Also:

Constant Field Values

LANGUAGE

public static final String LANGUAGE

The value of this property is a string language tag according to RFC 1766. The value of this constant is "java.naming.language".

See Also:

Constant Field Values

REFERRAL

public static final String REFERRAL

The value of this property is a string that specifies how referrals shall be handled by the provider. The value of this constant is "java.naming.referral".

See Also:

Constant Field Values

DEREF_ALIASES

public static final String DEREF_ALIASES

The value of this property is a string that specifies how aliases shall be handled by the provider. The value of this constant is "java.naming.ldap.derefAliases".

See Also:

Constant Field Values

BINARY_ATTRIBUTES

public static final String BINARY_ATTRIBUTES

The value of this property is a string that specifies additional binary attributes. The value of this constant is "java.naming.ldap.attributes.binary".

See Also:

Constant Field Values

SASL_AUTHORIZATION_ID

public static final String SASL_AUTHORIZATION_ID

The value of this property is a string that specifies a SASL authorization id. The value of this constant is "java.naming.security.sasl.authorizationId".

See Also:

Constant Field Values

SASL_REALM

public static final String SASL_REALM

The value of this property is a string that specifies a SASL realm. The value of this constant is "java.naming.security.sasl.realm".

See Also:

Constant Field Values

TYPES_ONLY

public static final String TYPES_ONLY

The value of this property is a string that specifies to only return attribute type names, no values. The value of this constant is "java.naming.ldap.typesOnly".

See Also:

Constant Field Values

PROTOCOL

public static final String PROTOCOL

The value of this property is a string that specifies the security protocol for the provider to use. The value of this constant is "java.naming.security.protocol".

See Also:

Constant Field Values

VERSION

public static final String VERSION

The value of this property is a string that specifies the protocol version for the provider. The value of this constant is "java.naming.ldap.version".

See Also:

Constant Field Values

PROVIDER_URL

public static final String PROVIDER_URL

The value of this property is a URL string that specifies the hostname and port number of the LDAP server, and the root distinguished name of the naming context to use. The value of this constant is "java.naming.provider.url".

See Also:

Constant Field Values

TIMEOUT

public static final String TIMEOUT

The value of this property is a string that specifies the time in milliseconds that a connection attempt will abort if the connection cannot be made. The value of this constant is "com.sun.jndi.ldap.connect.timeout".

See Also:

Constant Field Values

SSL_PROTOCOL

public static final String SSL_PROTOCOL

Value passed to PROTOCOL to use SSL. The value of this constant is "ssl".

See Also:

Constant Field Values

SIMPLE_AUTHTYPE

public static final String SIMPLE_AUTHTYPE

Value passed to AUTHENTICATION to use simple authentication. The value of this constant is "simple".

See Also:

Constant Field Values

STRONG_AUTHTYPE

public static final String STRONG_AUTHTYPE

Value passed to AUTHENTICATION to use simple authentication. The value of this constant is "strong".

See Also:

Constant Field Values

NONE_AUTHTYPE

public static final String NONE_AUTHTYPE

Value passed to AUTHENTICATION to use none authentication The value of this constant is "none".

See Also:

Constant Field Values

VERSION_THREE

public static final String VERSION_THREE

Value passed to VERSION to use ldap version 3 controls The value of this constant is "3".

See Also:

Constant Field Values

PROVIDER_URL_SCHEME

public static final String PROVIDER_URL_SCHEME

Ldap scheme, the value of this constant is "ldap".

See Also:

Constant Field Values

PROVIDER_URL_SSL_SCHEME

public static final String PROVIDER_URL_SSL_SCHEME

Secure ldap scheme, the value of this constant is "ldaps".

See Also:

Constant Field Values

PROVIDER_URL_PREFIX

public static final String PROVIDER_URL_PREFIX

URL prefix used for constructing URLs. The value of this constant is "://".

See Also:

Constant Field Values

PROVIDER_URL_SEPARATOR

public static final String PROVIDER_URL_SEPARATOR

URL separator used for constructing URLs. The value of this constant is ":".

See Also:

Constant Field Values

SUPPORTED_SASL_MECHANISMS

public static final String SUPPORTED_SASL_MECHANISMS

Ldap command which returns a list of supported SASL mechanisms. The value of this constant is "supportedSASLMechanisms".

See Also:

Constant Field Values

SUPPORTED_CONTROL

public static final String SUPPORTED_CONTROL

Ldap command which returns a list of supported controls. The value of this constant is "supportedcontrol".

See Also:

Constant Field Values

SASL_MECHANISM_EXTERNAL

public static final String SASL_MECHANISM_EXTERNAL

Value passed to AUTHENTICATION to use SASL authentication. The value of this constant is "EXTERNAL".

See Also:

Constant Field Values

SASL_MECHANISM_DIGEST_MD5

public static final String SASL_MECHANISM_DIGEST_MD5

Value passed to AUTHENTICATION to use DIGEST-MD5 authentication. The value of this constant is "DIGEST-MD5".

See Also:

Constant Field Values

SASL_MECHANISM_CRAM_MD5

public static final String SASL_MECHANISM_CRAM_MD5

Value passed to AUTHENTICATION to use CRAM-MD5 authentication. The value of this constant is "CRAM-MD5".

See Also:

Constant Field Values

SASL_MECHANISM_GSS_API

public static final String SASL_MECHANISM_GSS_API

Value passed to AUTHENTICATION to use GSS-API authentication. The value of this constant is "GSSAPI".

See Also:

Constant Field Values

SASL_MECHANISMS

public static final String[] SASL_MECHANISMS

List of supported SASL Mechanisms.

DEFAULT_CONTEXT_FACTORY

public static final String DEFAULT_CONTEXT_FACTORY

Default context factory, value of this constant is "com.sun.jndi.ldap.LdapCtxFactory".

See Also:

Constant Field Values

DEFAULT_BASE_DN

public static final String DEFAULT_BASE_DN

Default base DN, value of this constant is "".

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

Default timeout, -1 means use provider setting. The value of this constant is -1.

See Also:

Constant Field Values

DEFAULT_AUTHTYPE

public static final String DEFAULT_AUTHTYPE

Default authentication type, the value of this constant is "simple".

See Also:

Constant Field Values

DEFAULT_TIME_LIMIT

public static final int DEFAULT_TIME_LIMIT

Default time limit, 0 means wait indefinitely. The value of this constant is 0.

See Also:

Constant Field Values

DEFAULT_COUNT_LIMIT

public static final long DEFAULT_COUNT_LIMIT

Default count limit, 0 means return all results. The value of this constant is 0L.

See Also:

Constant Field Values

DEFAULT_PAGED_RESULTS_SIZE

public static final int DEFAULT_PAGED_RESULTS_SIZE

Default paged results size. The value of this constant is 0.

See Also:

Constant Field Values

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

Default batch size, -1 means use provider setting. The value of this constant is -1.

See Also:

Constant Field Values

DEFAULT_AUTHORITATIVE

public static final boolean DEFAULT_AUTHORITATIVE

Default authoritative value, the value of this constant is false.

See Also:

Constant Field Values

DEFAULT_TYPES_ONLY

public static final boolean DEFAULT_TYPES_ONLY

Default type only value, the value of this constant is false.

See Also:

Constant Field Values

DEFAULT_IGNORE_CASE

public static final boolean DEFAULT_IGNORE_CASE

Default ignore case value, value of this constant is true.

See Also:

Constant Field Values

DEFAULT_PORT

public static final String DEFAULT_PORT

Default ldap port, the value of this constant is "389".

See Also:

Constant Field Values

DEFAULT_SSL_PORT

public static final String DEFAULT_SSL_PORT

Default ldaps port, the value of this constant is "636".

See Also:

Constant Field Values

DEFAULT_USE_SSL

public static final boolean DEFAULT_USE_SSL

Whether to use SSL by default, the value of this constant is false.

See Also:

Constant Field Values

DEFAULT_LOG_CREDENTIALS

public static final boolean DEFAULT_LOG_CREDENTIALS

Whether to log authentication credentials. The value of this constant is false.

See Also:

Constant Field Values

DEFAULT_USER_FIELD

public static final String DEFAULT_USER_FIELD

Default userfield field used by Authenticator. The value of this constant is "uid".

See Also:

Constant Field Values

DEFAULT_ALLOW_MULTIPLE_DNS

public static final boolean DEFAULT_ALLOW_MULTIPLE_DNS

Whether Authenticator should throw an exception if multiple DNs are found by Authenticator.getDn(String). The value of this constant is false.

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

Default character set for creating strings. The value of this constant is "UTF-8".

See Also:

Constant Field Values

DEFAULT_OPERATION_RETRY

public static final int DEFAULT_OPERATION_RETRY

Default number of times to retry an operation on failure. The value of this constant is 1.

See Also:

Constant Field Values

DEFAULT_OPERATION_RETRY_WAIT

public static final long DEFAULT_OPERATION_RETRY_WAIT

Default amount of time to wait between operation retries. The value of this constant is 0L.

See Also:

Constant Field Values

DEFAULT_OPERATION_RETRY_BACKOFF

public static final int DEFAULT_OPERATION_RETRY_BACKOFF

Default factor to multiply the operation retry wait by. The value of this constant is 0.

See Also:

Constant Field Values