org.apereo.cas.util

Class DefaultUniqueTicketIdGenerator

java.lang.Object

org.apereo.cas.util.DefaultUniqueTicketIdGenerator

All Implemented Interfaces:

UniqueTicketIdGenerator

Direct Known Subclasses:

HostNameBasedUniqueTicketIdGenerator

public class DefaultUniqueTicketIdGenerator
extends java.lang.Object
implements UniqueTicketIdGenerator

Default implementation of UniqueTicketIdGenerator. Implementation utilizes a DefaultLongNumericGeneraor and a DefaultRandomStringGenerator to construct the ticket id.

Tickets are of the form [PREFIX]-[SEQUENCE NUMBER]-[RANDOM STRING]-[SUFFIX]

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger The logger instance.

Constructor Summary

Constructors

Constructor and Description
DefaultUniqueTicketIdGenerator() Creates an instance of DefaultUniqueTicketIdGenerator with default values including a DefaultLongNumericGenerator with a starting value of 1.
DefaultUniqueTicketIdGenerator(int maxLength) Creates an instance of DefaultUniqueTicketIdGenerator with a specified maximum length for the random portion.
DefaultUniqueTicketIdGenerator(int maxLength, java.lang.String suffix) Creates an instance of DefaultUniqueTicketIdGenerator with a specified maximum length for the random portion.
DefaultUniqueTicketIdGenerator(NumericGenerator numericGenerator, RandomStringGenerator randomStringGenerator, java.lang.String suffix) Creates an instance of DefaultUniqueTicketIdGenerator with a specified maximum length for the random portion.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNewTicketId(java.lang.String prefix) Return a new unique ticket id beginning with the prefix.
void	setMaxLength(int maxLength) Sets max length of id generation.
void	setSuffix(java.lang.String suffix)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final transient org.slf4j.Logger logger

The logger instance.

Constructor Detail

DefaultUniqueTicketIdGenerator

public DefaultUniqueTicketIdGenerator()

Creates an instance of DefaultUniqueTicketIdGenerator with default values including a DefaultLongNumericGenerator with a starting value of 1.

DefaultUniqueTicketIdGenerator

public DefaultUniqueTicketIdGenerator(int maxLength)

Creates an instance of DefaultUniqueTicketIdGenerator with a specified maximum length for the random portion.

Parameters:

maxLength - the maximum length of the random string used to generate the id.

DefaultUniqueTicketIdGenerator

public DefaultUniqueTicketIdGenerator(int maxLength,
                                      java.lang.String suffix)

Creates an instance of DefaultUniqueTicketIdGenerator with a specified maximum length for the random portion.

Parameters:

maxLength - the maximum length of the random string used to generate the id.

suffix - the value to append at the end of the unique id to ensure uniqueness across JVMs.

DefaultUniqueTicketIdGenerator

public DefaultUniqueTicketIdGenerator(NumericGenerator numericGenerator,
                                      RandomStringGenerator randomStringGenerator,
                                      java.lang.String suffix)

Creates an instance of DefaultUniqueTicketIdGenerator with a specified maximum length for the random portion.

Parameters:

numericGenerator - the numeric generator

randomStringGenerator - the random string generator

suffix - the value to append at the end of the unique id to ensure uniqueness across JVMs.

Since:

4.1.0

Method Detail

getNewTicketId

public java.lang.String getNewTicketId(java.lang.String prefix)

Description copied from interface: UniqueTicketIdGenerator

Return a new unique ticket id beginning with the prefix.

Specified by:

getNewTicketId in interface UniqueTicketIdGenerator

Parameters:

prefix - The prefix we want attached to the ticket.

Returns:

the unique ticket id

setSuffix

public void setSuffix(java.lang.String suffix)

setMaxLength

public void setMaxLength(int maxLength)

Sets max length of id generation.

Parameters:

maxLength - the max length