Package net.shibboleth.utilities.java.support.security.impl

Class RandomIdentifierGenerationStrategy

java.lang.Object

net.shibboleth.utilities.java.support.security.impl.RandomIdentifierGenerationStrategy

All Implemented Interfaces:

IdentifierGenerationStrategy

Direct Known Subclasses:

SecureRandomIdentifierGenerationStrategy

public class RandomIdentifierGenerationStrategy
extends Object
implements IdentifierGenerationStrategy

Generates a random number of bytes via a Random source and encodes them into a string using a BinaryEncoder (Hex by default).

Field Summary

Fields

Modifier and Type	Field	Description
private final org.apache.commons.codec.BinaryEncoder	encoder	Encoder used to convert the random bytes in to a string.
private final Random	random	Random number generator.
private final int	sizeOfIdentifier	Number of random bytes in the identifier.

Constructor Summary

Constructors

Constructor	Description
RandomIdentifierGenerationStrategy()	Constructor.
RandomIdentifierGenerationStrategy(int identifierSize)	Constructor.
RandomIdentifierGenerationStrategy(Random source, int identifierSize, org.apache.commons.codec.BinaryEncoder identifierEncoder)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	generateIdentifier()	Generates an identifier guaranteed to be XML ID safe.
String	generateIdentifier(boolean xmlSafe)	Generates an identifier.

Methods inherited from class java.lang.Object

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

Field Details

random

private final Random random

Random number generator.

sizeOfIdentifier

private final int sizeOfIdentifier

Number of random bytes in the identifier.

encoder

private final org.apache.commons.codec.BinaryEncoder encoder

Encoder used to convert the random bytes in to a string.

Constructor Details

RandomIdentifierGenerationStrategy

public RandomIdentifierGenerationStrategy()

Constructor. Initializes the random number source to a new SecureRandom, size of identifier is set to 16 bytes, and the encoder is set to a Hex.

RandomIdentifierGenerationStrategy

public RandomIdentifierGenerationStrategy(int identifierSize)

Constructor. Initializes the random number source to a new SecureRandom and the encoder is set to a Hex.

Parameters:

identifierSize - number of random bytes in identifier

RandomIdentifierGenerationStrategy

public RandomIdentifierGenerationStrategy(@Nonnull
 Random source,
 int identifierSize,
 @Nonnull
 org.apache.commons.codec.BinaryEncoder identifierEncoder)

Constructor.

Parameters:

source - source of random bytes

identifierSize - number of random bytes in the identifier

identifierEncoder - encoder used to convert random bytes to string identifier

Method Details

generateIdentifier

@Nonnull
@NotEmpty
public String generateIdentifier()

Generates an identifier guaranteed to be XML ID safe.

Specified by:

generateIdentifier in interface IdentifierGenerationStrategy

Returns:

the identifier

generateIdentifier

@Nonnull
@NotEmpty
public String generateIdentifier(boolean xmlSafe)

Generates an identifier.

Specified by:

generateIdentifier in interface IdentifierGenerationStrategy

Parameters:

xmlSafe - true iff the result must be XML ID safe

Returns:

the identifier