act.ws

Class StringSecureTicketCodec

java.lang.Object

act.ws.SecureTicketCodec.Base<String>

act.ws.StringSecureTicketCodec

All Implemented Interfaces:

SecureTicketCodec<String>

Direct Known Subclasses:

DefaultSecureTicketCodec, UsernameSecureTicketCodec

public class StringSecureTicketCodec
extends SecureTicketCodec.Base<String>

Implement SecureTicketCodec on String typed ticket

Nested Class Summary

Nested classes/interfaces inherited from interface act.ws.SecureTicketCodec

SecureTicketCodec.Base<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	MARKER

Constructor Summary

Constructors

Constructor and Description
StringSecureTicketCodec()
StringSecureTicketCodec(AppCrypto crypto)
StringSecureTicketCodec(AppCrypto crypto, Collection<String> keys)
StringSecureTicketCodec(AppCrypto crypto, String... keys)
StringSecureTicketCodec(AppCrypto crypto, String keys)
StringSecureTicketCodec(Collection<String> keys)
StringSecureTicketCodec(String... keys)
StringSecureTicketCodec(String keys)

Method Summary

Modifier and Type	Method and Description
protected String	deserialize(String ticket, Map<String,String> payload) Decode the ticket and return the session ID and fill the payload map
boolean	probeTicket(Object ticket) Do sanity check on an object to quickly probe if it is a ticket that can be processed by this codec
protected String	serialize(String id, Map<String,String> payload) Encode the session id and payload data into the ticket with type <T>

Methods inherited from class act.ws.SecureTicketCodec.Base

createTicket, parseTicket

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MARKER

public static final String MARKER

See Also:

Constant Field Values

Constructor Detail

StringSecureTicketCodec

public StringSecureTicketCodec()

StringSecureTicketCodec

public StringSecureTicketCodec(Collection<String> keys)

StringSecureTicketCodec

public StringSecureTicketCodec(String... keys)

StringSecureTicketCodec

public StringSecureTicketCodec(String keys)

StringSecureTicketCodec

public StringSecureTicketCodec(AppCrypto crypto)

StringSecureTicketCodec

public StringSecureTicketCodec(AppCrypto crypto,
                               Collection<String> keys)

StringSecureTicketCodec

public StringSecureTicketCodec(AppCrypto crypto,
                               String... keys)

StringSecureTicketCodec

public StringSecureTicketCodec(AppCrypto crypto,
                               String keys)

Method Detail

serialize

protected String serialize(String id,
                           Map<String,String> payload)

Description copied from class: SecureTicketCodec.Base

Encode the session id and payload data into the ticket with type <T>

Specified by:

serialize in class SecureTicketCodec.Base<String>

Parameters:

id - the session id

payload - the payload data

Returns:

the ticket

deserialize

protected String deserialize(String ticket,
                             Map<String,String> payload)

Description copied from class: SecureTicketCodec.Base

Decode the ticket and return the session ID and fill the payload map

Note if the ticket is invalid, the implementation shall return a null id and leave the payload map untouched

Specified by:

deserialize in class SecureTicketCodec.Base<String>

Parameters:

ticket - the ticket to be decoded

payload - a Map passed in to be filled with decoded payload

Returns:

the session ID decoded from the ticket specified

probeTicket

public boolean probeTicket(Object ticket)

Description copied from interface: SecureTicketCodec

Do sanity check on an object to quickly probe if it is a ticket that can be processed by this codec

Parameters:

ticket - the object to be tested

Returns:

true if the codec believe it can process the ticket or false if not sure