Enum CredentialProtocolType
- java.lang.Object
-
- java.lang.Enum<CredentialProtocolType>
-
- com.redwood.scheduler.api.model.enumeration.CredentialProtocolType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<CredentialProtocolType,Character>
,SchedulerEnumeration<CredentialProtocolType>
,Serializable
,Comparable<CredentialProtocolType>
public enum CredentialProtocolType extends Enum<CredentialProtocolType> implements SchedulerEnumeration<CredentialProtocolType>
Type of credential protocol (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Certificate
A certificate providing a chain of trust to a common name.Passphrase
A passphrase unlocking a wallet of security information.Password
Plain password.PrivateKey
A private key that can be combined with a public key that allows authentication.PublicKey
A public key that provides proof of having a particular private key.
-
Field Summary
Fields Modifier and Type Field Description static char
CertificateCode
The char returned from Certificate.getCodeEx().static char
PassphraseCode
The char returned from Passphrase.getCodeEx().static char
PasswordCode
The char returned from Password.getCodeEx().static char
PrivateKeyCode
The char returned from PrivateKey.getCodeEx().static char
PublicKeyCode
The char returned from PublicKey.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 CredentialProtocolType
safeValueOf(String value)
Helper function to return the CredentialProtocolType represented byvalue
.static CredentialProtocolType
valueOf(char code)
Helper function to return the CredentialProtocolType represented by code.static CredentialProtocolType
valueOf(Character code)
Helper function to return the CredentialProtocolType represented by code.static CredentialProtocolType
valueOf(String name)
Returns the enum constant of this type with the specified name.static CredentialProtocolType
valueOfCode(String code)
Helper function to return the CredentialProtocolType represented by code.static CredentialProtocolType[]
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
-
Password
public static final CredentialProtocolType Password
Plain password.
-
Certificate
public static final CredentialProtocolType Certificate
A certificate providing a chain of trust to a common name.
-
PublicKey
public static final CredentialProtocolType PublicKey
A public key that provides proof of having a particular private key.
-
PrivateKey
public static final CredentialProtocolType PrivateKey
A private key that can be combined with a public key that allows authentication.
-
Passphrase
public static final CredentialProtocolType Passphrase
A passphrase unlocking a wallet of security information.
-
-
Field Detail
-
PasswordCode
public static final char PasswordCode
The char returned from Password.getCodeEx().- See Also:
Password
, Constant Field Values
-
CertificateCode
public static final char CertificateCode
The char returned from Certificate.getCodeEx().- See Also:
Certificate
, Constant Field Values
-
PublicKeyCode
public static final char PublicKeyCode
The char returned from PublicKey.getCodeEx().- See Also:
PublicKey
, Constant Field Values
-
PrivateKeyCode
public static final char PrivateKeyCode
The char returned from PrivateKey.getCodeEx().- See Also:
PrivateKey
, Constant Field Values
-
PassphraseCode
public static final char PassphraseCode
The char returned from Passphrase.getCodeEx().- See Also:
Passphrase
, Constant Field Values
-
-
Method Detail
-
values
public static CredentialProtocolType[] 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 (CredentialProtocolType c : CredentialProtocolType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CredentialProtocolType 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 CredentialProtocolType valueOfCode(String code)
Helper function to return the CredentialProtocolType 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 CredentialProtocolType- Returns:
- The CredentialProtocolType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static CredentialProtocolType safeValueOf(String value)
Helper function to return the CredentialProtocolType represented byvalue
. Ifvalue
is null, or not a valid CredentialProtocolType 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 CredentialProtocolType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static CredentialProtocolType valueOf(Character code)
Helper function to return the CredentialProtocolType represented by code. If code is null, or not a valid CredentialProtocolType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The CredentialProtocolType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static CredentialProtocolType valueOf(char code)
Helper function to return the CredentialProtocolType represented by code. If code is not a valid CredentialProtocolType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The CredentialProtocolType 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<CredentialProtocolType>
- 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<CredentialProtocolType,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<CredentialProtocolType>
- 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<CredentialProtocolType,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<CredentialProtocolType,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<CredentialProtocolType,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<CredentialProtocolType>
- Returns:
- the database code for the enumeration
-
-