org.wildfly.clustering.web

Enum IdentifierSerializer

java.lang.Object

java.lang.Enum<IdentifierSerializer>

org.wildfly.clustering.web.IdentifierSerializer

All Implemented Interfaces:

Serializable, Comparable<IdentifierSerializer>, Serializer<String>

public enum IdentifierSerializer
extends Enum<IdentifierSerializer>
implements Serializer<String>

Strategies for externalizing a session identifier.

Author:

Paul Ferraro

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE64 Specific optimization for Base64-encoded identifiers (e.g.
HEX Specific optimization for hex-encoded identifiers (e.g.
UTF8

Method Summary

Modifier and Type	Method and Description
boolean	validate(String id) Indicates whether or not the specified identifier is valid for this serializer.
static IdentifierSerializer	valueOf(String name) Returns the enum constant of this type with the specified name.
static IdentifierSerializer[]	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

Methods inherited from interface org.wildfly.clustering.marshalling.spi.Serializer

read, size, write

Enum Constant Detail

UTF8

public static final IdentifierSerializer UTF8

BASE64

public static final IdentifierSerializer BASE64

Specific optimization for Base64-encoded identifiers (e.g. Undertow).

HEX

public static final IdentifierSerializer HEX

Specific optimization for hex-encoded identifiers (e.g. Tomcat).

Method Detail

values

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

Returns:

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

valueOf

public static IdentifierSerializer 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

validate

public boolean validate(String id)

Indicates whether or not the specified identifier is valid for this serializer.

Parameters:

id - an identifier

Returns:

true, if the specified identifier is valid, false otherwise.