org.apache.brooklyn.util.text

Class Identifiers

java.lang.Object

org.apache.brooklyn.util.text.Identifiers

public class Identifiers
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE64_VALID_CHARS
static java.lang.String	ID_VALID_NONSTART_CHARS
static java.lang.String	ID_VALID_START_CHARS
static java.lang.String	JAVA_GENERATED_IDENTIFIER_START_CHARS
static java.lang.String	JAVA_GENERATED_IDENTIFIERNONSTART_CHARS
static java.lang.String	JAVA_GOOD_BINARY_REGEX as JAVA_GOOD_PACKAGE_OR_CLASS_REGEX but allowing a dollar sign inside a class name (e.g.
static java.lang.String	JAVA_GOOD_NONSTART_CHARS
static java.lang.String	JAVA_GOOD_PACKAGE_OR_CLASS_REGEX regex for a java package or class name using "good" chars, that is no accents or funny unicodes.
static java.lang.String	JAVA_GOOD_SEGMENT_REGEX
static java.lang.String	JAVA_GOOD_START_CHARS
static java.lang.String	LOWER_CASE_ALPHA
static java.lang.String	NON_ALPHA_NUMERIC
static java.lang.String	NUMERIC
static java.lang.String	PASSWORD_VALID_CHARS
static java.lang.String	UPPER_CASE_ALPHA

Constructor Summary

Constructors

Constructor and Description
Identifiers()

Method Summary

Modifier and Type	Method and Description
static void	appendBase64IdFromValueOfLength(long value, int length, java.lang.StringBuffer sb)
static void	appendBase64IdFromValueOfLength(long value, int length, java.lang.StringBuilder sb)
static java.lang.String	getBase64IdFromValue(long value)
static java.lang.String	getBase64IdFromValue(long value, int length)
static boolean	isValidToken(java.lang.String token, java.lang.String validStartChars, java.lang.String validSubsequentChars)
static java.lang.String	makeIdFromHash(long d) creates a short identifier comfortable in java and OS's, given an input hash code
static java.lang.String	makeRandomBase64Id(int length)
static java.lang.String	makeRandomId(int l)
static java.lang.String	makeRandomJavaId(int l) Makes a random id string (letters and numbers) of the given length; starts with letter (upper or lower) so can be used as Java id.
static java.lang.String	makeRandomLowercaseId(int l)
static java.lang.String	makeRandomPassword(int length)
static java.lang.String	makeRandomPassword(int length, java.lang.String... passwordValidCharsPool) A fairly slow but hopefully secure way to randomly select characters for a password Takes a pool of acceptible characters using the first set in the pool for the first character, second set for the second character, ..., nth set for all remaining character.
static boolean	randomBoolean()
static byte[]	randomBytes(byte[] buf) returns the array passed in
static byte[]	randomBytes(int length)
static double	randomDouble()
static int	randomInt()
static int	randomInt(int upbound) returns in [0,upbound)
static long	randomLong()

Methods inherited from class java.lang.Object

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

Field Detail

UPPER_CASE_ALPHA

public static final java.lang.String UPPER_CASE_ALPHA

See Also:

Constant Field Values

LOWER_CASE_ALPHA

public static final java.lang.String LOWER_CASE_ALPHA

See Also:

Constant Field Values

NUMERIC

public static final java.lang.String NUMERIC

See Also:

Constant Field Values

NON_ALPHA_NUMERIC

public static final java.lang.String NON_ALPHA_NUMERIC

See Also:

Constant Field Values

JAVA_GOOD_START_CHARS

public static final java.lang.String JAVA_GOOD_START_CHARS

See Also:

JAVA_GOOD_PACKAGE_OR_CLASS_REGEX, Constant Field Values

JAVA_GOOD_NONSTART_CHARS

public static final java.lang.String JAVA_GOOD_NONSTART_CHARS

See Also:

JAVA_GOOD_PACKAGE_OR_CLASS_REGEX, Constant Field Values

JAVA_GOOD_SEGMENT_REGEX

public static final java.lang.String JAVA_GOOD_SEGMENT_REGEX

See Also:

JAVA_GOOD_PACKAGE_OR_CLASS_REGEX, Constant Field Values

JAVA_GOOD_PACKAGE_OR_CLASS_REGEX

public static final java.lang.String JAVA_GOOD_PACKAGE_OR_CLASS_REGEX

regex for a java package or class name using "good" chars, that is no accents or funny unicodes. see http://docs.oracle.com/javase/specs/jls/se7/html/jls-3.html#jls-3.8 for the full set supported by the spec; but it's rare to deviate from this subset and it causes problems when charsets aren't respected (tsk tsk but not uncommon!). our use cases so far only require testing for "good" names.

See Also:

Constant Field Values

JAVA_GOOD_BINARY_REGEX

public static final java.lang.String JAVA_GOOD_BINARY_REGEX

as JAVA_GOOD_PACKAGE_OR_CLASS_REGEX but allowing a dollar sign inside a class name (e.g. Foo$1)

See Also:

Constant Field Values

JAVA_GENERATED_IDENTIFIER_START_CHARS

public static final java.lang.String JAVA_GENERATED_IDENTIFIER_START_CHARS

See Also:

Constant Field Values

JAVA_GENERATED_IDENTIFIERNONSTART_CHARS

public static final java.lang.String JAVA_GENERATED_IDENTIFIERNONSTART_CHARS

See Also:

Constant Field Values

BASE64_VALID_CHARS

public static final java.lang.String BASE64_VALID_CHARS

See Also:

Constant Field Values

ID_VALID_START_CHARS

public static final java.lang.String ID_VALID_START_CHARS

See Also:

Constant Field Values

ID_VALID_NONSTART_CHARS

public static final java.lang.String ID_VALID_NONSTART_CHARS

See Also:

Constant Field Values

PASSWORD_VALID_CHARS

public static final java.lang.String PASSWORD_VALID_CHARS

See Also:

Constant Field Values

Constructor Detail

Identifiers

public Identifiers()

Method Detail

makeRandomId

public static java.lang.String makeRandomId(int l)

makeRandomLowercaseId

public static java.lang.String makeRandomLowercaseId(int l)

makeRandomPassword

public static java.lang.String makeRandomPassword(int length)

Parameters:

length - of password to be returned

Returns:

randomly generated password containing at least one of each upper case, lower case, numeric, and non alpha-numeric characters. Hopefully this is acceptible for most password schemes.

makeRandomPassword

public static java.lang.String makeRandomPassword(int length,
                                                  java.lang.String... passwordValidCharsPool)

A fairly slow but hopefully secure way to randomly select characters for a password Takes a pool of acceptible characters using the first set in the pool for the first character, second set for the second character, ..., nth set for all remaining character.

Parameters:

length - length of password

passwordValidCharsPool - pool of acceptable character sets

Returns:

a randomly generated password

makeIdFromHash

public static java.lang.String makeIdFromHash(long d)

creates a short identifier comfortable in java and OS's, given an input hash code

result is always at least of length 1, shorter if the hash is smaller

makeRandomJavaId

public static java.lang.String makeRandomJavaId(int l)

Makes a random id string (letters and numbers) of the given length; starts with letter (upper or lower) so can be used as Java id.

randomDouble

public static double randomDouble()

randomLong

public static long randomLong()

randomBoolean

public static boolean randomBoolean()

randomInt

public static int randomInt()

randomInt

public static int randomInt(int upbound)

returns in [0,upbound)

randomBytes

public static byte[] randomBytes(byte[] buf)

returns the array passed in

randomBytes

public static byte[] randomBytes(int length)

makeRandomBase64Id

public static java.lang.String makeRandomBase64Id(int length)

getBase64IdFromValue

public static java.lang.String getBase64IdFromValue(long value)

getBase64IdFromValue

public static java.lang.String getBase64IdFromValue(long value,
                                                    int length)

appendBase64IdFromValueOfLength

public static void appendBase64IdFromValueOfLength(long value,
                                                   int length,
                                                   java.lang.StringBuffer sb)

appendBase64IdFromValueOfLength

public static void appendBase64IdFromValueOfLength(long value,
                                                   int length,
                                                   java.lang.StringBuilder sb)

isValidToken

public static boolean isValidToken(java.lang.String token,
                                   java.lang.String validStartChars,
                                   java.lang.String validSubsequentChars)