Package org.wildfly.clustering.web

Enum IdentifierMarshaller

java.lang.Object

java.lang.Enum<IdentifierMarshaller>

org.wildfly.clustering.web.IdentifierMarshaller

All Implemented Interfaces:

Serializable, Comparable<IdentifierMarshaller>, Marshallability, Marshaller<String,ByteBuffer>

public enum IdentifierMarshaller
extends Enum<IdentifierMarshaller>
implements Marshaller<String,ByteBuffer>

Strategies for externalizing a session identifier.

Author:

Paul Ferraro

Enum Constant Summary

Enum Constants

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

Method Summary

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

read, write

Enum Constant Detail

ISO_LATIN_1

public static final IdentifierMarshaller ISO_LATIN_1

BASE64

public static final IdentifierMarshaller BASE64

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

HEX

public static final IdentifierMarshaller HEX

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

Method Detail

values

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

Returns:

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

valueOf

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

isMarshallable

public boolean isMarshallable(Object object)

Specified by:

isMarshallable in interface Marshallability

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.