Enum LDAPServerType
- java.lang.Object
-
- java.lang.Enum<LDAPServerType>
-
- com.redwood.scheduler.api.model.enumeration.LDAPServerType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<LDAPServerType,Character>
,SchedulerEnumeration<LDAPServerType>
,Serializable
,Comparable<LDAPServerType>
public enum LDAPServerType extends Enum<LDAPServerType> implements SchedulerEnumeration<LDAPServerType>
What type of LDAP Server do we know we can support (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ActiveDirectory
Microsoft Active Directory ServereDirectory
Novell eDirectory ServerMisc
The user another type of LDAP server that we don't have a default configuration for yet.OpenLDAP
OpenLDAP also known as SLAPDOracleInternetDirectory
Oracle Internet DirectoryTivoli
IBM Tivoli Directory Server
-
Field Summary
Fields Modifier and Type Field Description static char
ActiveDirectoryCode
The char returned from ActiveDirectory.getCodeEx().static char
eDirectoryCode
The char returned from eDirectory.getCodeEx().static char
MiscCode
The char returned from Misc.getCodeEx().static char
OpenLDAPCode
The char returned from OpenLDAP.getCodeEx().static char
OracleInternetDirectoryCode
The char returned from OracleInternetDirectory.getCodeEx().static char
TivoliCode
The char returned from Tivoli.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getCodeEx()
Get the code that is used to represent this enumeration in the database.Character
getCodeExCharacter()
Get the code that is used to represent this enumeration in the database.String
getCodeExString()
Get the code that is used to represent this enumeration in the database.Character
getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.String
getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.String
getTranslationEN()
Get the English name of this enumeration.String
getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static LDAPServerType
safeValueOf(String value)
Helper function to return the LDAPServerType represented byvalue
.static LDAPServerType
valueOf(char code)
Helper function to return the LDAPServerType represented by code.static LDAPServerType
valueOf(Character code)
Helper function to return the LDAPServerType represented by code.static LDAPServerType
valueOf(String name)
Returns the enum constant of this type with the specified name.static LDAPServerType
valueOfCode(String code)
Helper function to return the LDAPServerType represented by code.static LDAPServerType[]
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 interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
ActiveDirectory
public static final LDAPServerType ActiveDirectory
Microsoft Active Directory Server
-
Tivoli
public static final LDAPServerType Tivoli
IBM Tivoli Directory Server
-
OpenLDAP
public static final LDAPServerType OpenLDAP
OpenLDAP also known as SLAPD
-
eDirectory
public static final LDAPServerType eDirectory
Novell eDirectory Server
-
OracleInternetDirectory
public static final LDAPServerType OracleInternetDirectory
Oracle Internet Directory
-
Misc
public static final LDAPServerType Misc
The user another type of LDAP server that we don't have a default configuration for yet.
-
-
Field Detail
-
ActiveDirectoryCode
public static final char ActiveDirectoryCode
The char returned from ActiveDirectory.getCodeEx().- See Also:
ActiveDirectory
, Constant Field Values
-
TivoliCode
public static final char TivoliCode
The char returned from Tivoli.getCodeEx().- See Also:
Tivoli
, Constant Field Values
-
OpenLDAPCode
public static final char OpenLDAPCode
The char returned from OpenLDAP.getCodeEx().- See Also:
OpenLDAP
, Constant Field Values
-
eDirectoryCode
public static final char eDirectoryCode
The char returned from eDirectory.getCodeEx().- See Also:
eDirectory
, Constant Field Values
-
OracleInternetDirectoryCode
public static final char OracleInternetDirectoryCode
The char returned from OracleInternetDirectory.getCodeEx().- See Also:
OracleInternetDirectory
, Constant Field Values
-
MiscCode
public static final char MiscCode
The char returned from Misc.getCodeEx().- See Also:
Misc
, Constant Field Values
-
-
Method Detail
-
values
public static LDAPServerType[] 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 (LDAPServerType c : LDAPServerType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LDAPServerType valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOfCode
public static LDAPServerType valueOfCode(String code)
Helper function to return the LDAPServerType represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
code
- A string with one character that is one of the codes for LDAPServerType- Returns:
- The LDAPServerType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static LDAPServerType safeValueOf(String value)
Helper function to return the LDAPServerType represented byvalue
. Ifvalue
is null, or not a valid LDAPServerType enumeration then this method will return null.The main difference between this method and
valueOf(String)
, is that this method will return null when passed an invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The LDAPServerType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static LDAPServerType valueOf(Character code)
Helper function to return the LDAPServerType represented by code. If code is null, or not a valid LDAPServerType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The LDAPServerType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static LDAPServerType valueOf(char code)
Helper function to return the LDAPServerType represented by code. If code is not a valid LDAPServerType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The LDAPServerType corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerEnumeration<LDAPServerType>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<LDAPServerType,Character>
- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacter
in interfaceSchedulerEnumeration<LDAPServerType>
- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKey
in interfaceBaseSchedulerEnumeration<LDAPServerType,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<LDAPServerType,Character>
- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKey
in interfaceBaseSchedulerEnumeration<LDAPServerType,Character>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExString
in interfaceSchedulerEnumeration<LDAPServerType>
- Returns:
- the database code for the enumeration
-
-