com.adaptris.util

Class PseudoRandomIdGenerator

java.lang.Object

com.adaptris.util.PseudoRandomIdGenerator

All Implemented Interfaces:

IdGenerator

public class PseudoRandomIdGenerator
extends java.lang.Object
implements IdGenerator

Pseudo Random IdGenerator implementation

The ID is generated from the a combination of Random.nextBytes(byte[]) (8 bytes, and then base64 encoded), along with the configured prefix to generate an id. No guarantees are made for the uniqueness of the id that is generated. If you wish for a unique-id then you should consider using GuidGenerator instead.

Effectively the ID that is generated follows the form

  
    ID              = prefix unique-sequence
    prefix          = *VCHAR
    unique sequence = 12(ALPHA/DIGIT/"+"/"/"/"=")
    
   

If you wish to restrict the length of the resulting ID, then bear in mind that with padding 8 bytes base64 encoded is 12 characters long so consider how long your prefix is.

In the adapter configuration file this class is aliased as pseudo-random-id-generator which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
PseudoRandomIdGenerator()
PseudoRandomIdGenerator(java.lang.String prefix)
PseudoRandomIdGenerator(java.lang.String prefix, boolean useSecureRandom)

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.Object msg) A generated ID.
java.lang.String	getPrefix()
java.lang.Boolean	getUseSecureRandom()
void	setPrefix(java.lang.String s)
void	setUseSecureRandom(java.lang.Boolean u) Whether or not to use SecureRandom when generating a random sequence of bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

PseudoRandomIdGenerator

public PseudoRandomIdGenerator()

PseudoRandomIdGenerator

public PseudoRandomIdGenerator(java.lang.String prefix)

PseudoRandomIdGenerator

public PseudoRandomIdGenerator(java.lang.String prefix,
                               boolean useSecureRandom)

Method Detail

create

public java.lang.String create(java.lang.Object msg)

A generated ID.

Specified by:

create in interface IdGenerator

Parameters:

msg - the object to create an id around

Returns:

a unique id for use.

getPrefix

public java.lang.String getPrefix()

Returns:

the separator

setPrefix

public void setPrefix(java.lang.String s)

Parameters:

s - the separator to set

getUseSecureRandom

public java.lang.Boolean getUseSecureRandom()

Returns:

the useSecureRandom

setUseSecureRandom

public void setUseSecureRandom(java.lang.Boolean u)

Whether or not to use SecureRandom when generating a random sequence of bytes.

Parameters:

u - the useSecureRandom to set, if not set, defaults to true.