|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<AliasDerefMode>
org.apache.directory.shared.ldap.message.AliasDerefMode
public enum AliasDerefMode
Type-safe derefAliases search parameter enumeration which determines the mode of alias handling. Note that the jndi values of these ValuedEnums correspond to the string value for the java.naming.ldap.derefAliases JNDI LDAP specific property. The integer value represents the values used in the LDAP ASN.1 for different settings.
Enum Constant Summary | |
---|---|
DEREF_ALWAYS
Alias handling mode value that dereferences always |
|
DEREF_FINDING_BASE_OBJ
Alias handling mode value that dereferences only in finding the base |
|
DEREF_IN_SEARCHING
Alias handling mode value that dereferences only when searching |
|
NEVER_DEREF_ALIASES
Alias handling mode value that treats aliases like entries |
Method Summary | |
---|---|
static AliasDerefMode |
getEnum(java.util.Map<java.lang.String,java.lang.Object> env)
Gets the enumeration from by extracting the value for the JNDI LDAP specific environment property, java.naming.ldap.derefAliases, from the environment. |
java.lang.String |
getJndiValue()
|
int |
getValue()
|
boolean |
isDerefAlways()
Checks to see if we dereference while searching and finding the base. |
boolean |
isDerefFindingBase()
Checks to see if we dereference while finding the base. |
boolean |
isDerefInSearching()
Checks to see if we dereference while searching. |
boolean |
isNeverDeref()
Checks to see if we never dereference aliases. |
static AliasDerefMode |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static AliasDerefMode[] |
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 |
---|
public static final AliasDerefMode NEVER_DEREF_ALIASES
public static final AliasDerefMode DEREF_IN_SEARCHING
public static final AliasDerefMode DEREF_FINDING_BASE_OBJ
public static final AliasDerefMode DEREF_ALWAYS
Method Detail |
---|
public static AliasDerefMode[] values()
for (AliasDerefMode c : AliasDerefMode.values()) System.out.println(c);
public static AliasDerefMode valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic int getValue()
public static AliasDerefMode getEnum(java.util.Map<java.lang.String,java.lang.Object> env)
env
- the JNDI environment with a potential value for the
java.naming.ldap.derefAliases property
public boolean isDerefAlways()
public boolean isNeverDeref()
public boolean isDerefInSearching()
public boolean isDerefFindingBase()
public java.lang.String getJndiValue()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |