com.unboundid.ldap.sdk

Enum PooledReferralConnectorLDAPURLSecurityType

java.lang.Object

java.lang.Enum<PooledReferralConnectorLDAPURLSecurityType>

com.unboundid.ldap.sdk.PooledReferralConnectorLDAPURLSecurityType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PooledReferralConnectorLDAPURLSecurityType>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum PooledReferralConnectorLDAPURLSecurityType
extends java.lang.Enum<PooledReferralConnectorLDAPURLSecurityType>

This enum defines the type of communication security that the PooledReferralConnector will use when following LDAP URLs that have a scheme of "ldap" rather than "ldaps". The referral connector will always use LDAPS for LDAP referrals that have a scheme of "ldaps", but it is more ambiguous for referrals that have a scheme of "ldap".

Although some LDAP URL implementations (including the LDAP SDK) support using a scheme of "ldaps" to indicate that connections should be created as secure, the official LDAP URL specification in RFC 4516 lists "ldap" as the only allowed scheme. As such, if a client receives a referral URL with a scheme of "ldap", it isn't necessarily clear whether it should establish an insecure LDAP connection or a secure LDAPS connection. Further, for the case in which it establishes an insecure LDAP connection, it isn't clear if that connection should be subsequently secured with the StartTLS extended operation. This enum will be used to address that ambiguity.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS_USE_LDAP_AND_ALWAYS_USE_START_TLS Indicates that the referral connector should always create unencrypted LDAP connections for referral URLs with a scheme of "ldap", and that it should always attempt to secure them with the StartTLS extended operation.
ALWAYS_USE_LDAP_AND_CONDITIONALLY_USE_START_TLS Indicates that the referral connector should always create unencrypted LDAP connections for referral URLs with a scheme of "ldap".
ALWAYS_USE_LDAP_AND_NEVER_USE_START_TLS Indicates that the referral connector should always create unencrypted LDAP connections for referral URLs with a scheme of "ldap", and that it should never attempt to secure them with the StartTLS extended operation.
ALWAYS_USE_LDAPS Indicates that the referral connector should always create encrypted LDAPS connections for referral URLs with a scheme of "ldap".
CONDITIONALLY_USE_LDAP_AND_ALWAYS_USE_START_TLS Indicates that the referral connector should determine whether to create unencrypted LDAP or encrypted LDAPS connections based on whether the connection on which the referral was received was using LDAP or LDAPS.
CONDITIONALLY_USE_LDAP_AND_CONDITIONALLY_USE_START_TLS Indicates that the referral connector should determine whether to create unencrypted LDAP or encrypted LDAPS connections based on whether the connection on which the referral was received was using LDAP or LDAPS.
CONDITIONALLY_USE_LDAP_AND_NEVER_USE_START_TLS Indicates that the referral connector should determine whether to create unencrypted LDAP or encrypted LDAPS connections based on whether the connection on which the referral was received was using LDAP or LDAPS.

Method Summary

Modifier and Type	Method and Description
static PooledReferralConnectorLDAPURLSecurityType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PooledReferralConnectorLDAPURLSecurityType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS_USE_LDAP_AND_NEVER_USE_START_TLS

public static final PooledReferralConnectorLDAPURLSecurityType ALWAYS_USE_LDAP_AND_NEVER_USE_START_TLS

Indicates that the referral connector should always create unencrypted LDAP connections for referral URLs with a scheme of "ldap", and that it should never attempt to secure them with the StartTLS extended operation.

ALWAYS_USE_LDAP_AND_ALWAYS_USE_START_TLS

public static final PooledReferralConnectorLDAPURLSecurityType ALWAYS_USE_LDAP_AND_ALWAYS_USE_START_TLS

Indicates that the referral connector should always create unencrypted LDAP connections for referral URLs with a scheme of "ldap", and that it should always attempt to secure them with the StartTLS extended operation.

ALWAYS_USE_LDAP_AND_CONDITIONALLY_USE_START_TLS

public static final PooledReferralConnectorLDAPURLSecurityType ALWAYS_USE_LDAP_AND_CONDITIONALLY_USE_START_TLS

Indicates that the referral connector should always create unencrypted LDAP connections for referral URLs with a scheme of "ldap". If the connection on which the referral was received was secured by either LDAPS or StartTLS, then the referral connector will subsequently attempt to secure those connections with StartTLS. On the other hand, if the connection on which the referral was received was an unencrypted LDAP connection, then the referral connection will also use unencrypted LDAP and will not be secured with StartTLS.

CONDITIONALLY_USE_LDAP_AND_NEVER_USE_START_TLS

public static final PooledReferralConnectorLDAPURLSecurityType CONDITIONALLY_USE_LDAP_AND_NEVER_USE_START_TLS

Indicates that the referral connector should determine whether to create unencrypted LDAP or encrypted LDAPS connections based on whether the connection on which the referral was received was using LDAP or LDAPS. If the connection on which the referral was received was using unencrypted LDAP (regardless of whether it was secured with StartTLS), then the referral connector will create unencrypted LDAP connections, and it will never attempt to secure them with StartTLS. If the connection on which the referral was received was secured by LDAPS, then the referral connector will create secure LDAPS connections.

CONDITIONALLY_USE_LDAP_AND_ALWAYS_USE_START_TLS

public static final PooledReferralConnectorLDAPURLSecurityType CONDITIONALLY_USE_LDAP_AND_ALWAYS_USE_START_TLS

Indicates that the referral connector should determine whether to create unencrypted LDAP or encrypted LDAPS connections based on whether the connection on which the referral was received was using LDAP or LDAPS. If the connection on which the referral was received was using unencrypted LDAP (regardless of whether it was secured with StartTLS), then the referral connector will create unencrypted LDAP connections, and it will always attempt to secure them with StartTLS. If the connection on which the referral was received was secured by LDAPS, then the referral connector will create secure LDAPS connections.

CONDITIONALLY_USE_LDAP_AND_CONDITIONALLY_USE_START_TLS

public static final PooledReferralConnectorLDAPURLSecurityType CONDITIONALLY_USE_LDAP_AND_CONDITIONALLY_USE_START_TLS

Indicates that the referral connector should determine whether to create unencrypted LDAP or encrypted LDAPS connections based on whether the connection on which the referral was received was using LDAP or LDAPS. If the connection on which the referral was received was using unencrypted LDAP that was not secured by StartTLS, then the referral connector will create unencrypted LDAP connections, and it will not attempt to secure them with StartTLS. If the connection on which the referral was received was using unencrypted LDAP that was subsequently secured with StartTLS, then the referral connector will create unencrypted LDAP connections, and it will attempt to secure them with StartTLS. If the connection on which the referral was received was secured by LDAPS, then the referral connector will create secure LDAPS connections.

ALWAYS_USE_LDAPS

public static final PooledReferralConnectorLDAPURLSecurityType ALWAYS_USE_LDAPS

Indicates that the referral connector should always create encrypted LDAPS connections for referral URLs with a scheme of "ldap".

Method Detail

values

public static PooledReferralConnectorLDAPURLSecurityType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PooledReferralConnectorLDAPURLSecurityType c : PooledReferralConnectorLDAPURLSecurityType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PooledReferralConnectorLDAPURLSecurityType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null