org.eclipse.scada.sec.utils.password

Enum PasswordEncoding

java.lang.Object

java.lang.Enum<PasswordEncoding>

org.eclipse.scada.sec.utils.password.PasswordEncoding

All Implemented Interfaces:

Serializable, Comparable<PasswordEncoding>

public enum PasswordEncoding
extends Enum<PasswordEncoding>

Since:

1.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
MD5
PLAIN
SHA1

Method Summary

Modifier and Type	Method and Description
String	encodeToHexString(String password)
String	encodeToString(String password, String characterEncoding, PasswordDigestCodec codec)
abstract MessageDigest	getDigest()
abstract PasswordEncoder	getEncoder(String characterEncoding, PasswordDigestCodec codec)
static PasswordEncoding	valueOf(String name) Returns the enum constant of this type with the specified name.
static PasswordEncoding[]	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

PLAIN

public static final PasswordEncoding PLAIN

MD5

public static final PasswordEncoding MD5

SHA1

public static final PasswordEncoding SHA1

Method Detail

values

public static PasswordEncoding[] 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 (PasswordEncoding c : PasswordEncoding.values())
    System.out.println(c);

Returns:

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

valueOf

public static PasswordEncoding 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 name

NullPointerException - if the argument is null

getEncoder

public abstract PasswordEncoder getEncoder(String characterEncoding,
                                           PasswordDigestCodec codec)
                                    throws Exception

Throws:

Exception

encodeToString

public String encodeToString(String password,
                             String characterEncoding,
                             PasswordDigestCodec codec)
                      throws Exception

Throws:

Exception

encodeToHexString

public String encodeToHexString(String password)
                         throws Exception

Throws:

Exception

getDigest

public abstract MessageDigest getDigest()
                                 throws NoSuchAlgorithmException

Returns:

the message digest or null if none is used

Throws:

NoSuchAlgorithmException