org.cloudfoundry.identity.uaa.util

Class UaaStringUtils

java.lang.Object

org.cloudfoundry.identity.uaa.util.UaaStringUtils

public class UaaStringUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ISO_8859_1
static java.lang.String	UTF_8
static java.lang.String	ZONE_VAR_ID
static java.lang.String	ZONE_VAR_SUBDOMAIN

Constructor Summary

Constructors

Constructor and Description
UaaStringUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	camelToUnderscore(java.lang.String value) Convert a string from camel case to underscores, also replacing periods with underscores (so for example a fully qualified Java class name gets underscores everywhere).
static java.lang.String	constructSimpleWildcardPattern(java.lang.String s) Returns a pattern that does a single level regular expression match where the * character is a wildcard until it encounters the next literal
static java.lang.String	constructSimpleWildcardPatternWithAnyCharDelimiter(java.lang.String s)
static java.util.Set<java.util.regex.Pattern>	constructWildcards(java.util.Collection<java.lang.String> wildcardStrings)
static java.util.Set<java.util.regex.Pattern>	constructWildcards(java.util.Collection<java.lang.String> wildcardStrings, java.util.function.Function<java.lang.String,java.lang.String> replace)
static boolean	containsIgnoreCase(java.util.List<java.lang.String> list, java.lang.String findMe)
static boolean	containsWildcard(java.lang.String s)
static java.lang.String	convertISO8859_1_to_UTF_8(java.lang.String s)
static java.lang.String	escapeRegExCharacters(java.lang.String s) Escapes all regular expression patterns in a string so that when using the string itself in a regular expression, only an exact literal match will return true.
static java.lang.String	escapeRegExCharacters(java.lang.String s, java.lang.String pattern) Escapes all regular expression patterns in a string so that when using the string itself in a regular expression, only an exact literal match will return true.
static java.util.List<? extends org.springframework.security.core.GrantedAuthority>	getAuthoritiesFromStrings(java.util.Collection<java.lang.String> authorities)
static java.lang.String	getErrorName(java.lang.Exception e)
static java.lang.String	getHostIfArgIsURL(java.lang.String arg)
static java.util.Map<java.lang.String,?>	getMapFromProperties(java.util.Properties properties, java.lang.String prefix) Extract a Map from some properties by removing a prefix from the key names.
static java.util.Set<java.lang.String>	getStringsFromAuthorities(java.util.Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)
static java.util.Map<java.lang.String,?>	hidePasswords(java.util.Map<java.lang.String,?> map) Hide the passwords and secrets in a config map (e.g.
static java.util.Properties	hidePasswords(java.util.Properties properties)
static boolean	matches(java.util.Set<java.util.regex.Pattern> wildcards, java.lang.String scope)
static java.lang.String	nonNull(java.lang.String... s)
static java.lang.String	replaceZoneVariables(java.lang.String s, IdentityZone zone)
static java.util.Set<java.lang.String>	retainAllMatches(java.util.Collection<java.lang.String> values, java.util.Collection<java.lang.String> whitelist)
static java.lang.String	toJsonString(java.lang.String s)

Methods inherited from class java.lang.Object

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

Field Detail

ZONE_VAR_ID

public static final java.lang.String ZONE_VAR_ID

See Also:

Constant Field Values

ZONE_VAR_SUBDOMAIN

public static final java.lang.String ZONE_VAR_SUBDOMAIN

See Also:

Constant Field Values

ISO_8859_1

public static final java.lang.String ISO_8859_1

See Also:

Constant Field Values

UTF_8

public static final java.lang.String UTF_8

See Also:

Constant Field Values

Constructor Detail

UaaStringUtils

public UaaStringUtils()

Method Detail

replaceZoneVariables

public static java.lang.String replaceZoneVariables(java.lang.String s,
                                                    IdentityZone zone)

nonNull

public static java.lang.String nonNull(java.lang.String... s)

camelToUnderscore

public static java.lang.String camelToUnderscore(java.lang.String value)

Convert a string from camel case to underscores, also replacing periods with underscores (so for example a fully qualified Java class name gets underscores everywhere).

Parameters:

value - a camel case String

Returns:

the same value with camels comverted to underscores

getErrorName

public static java.lang.String getErrorName(java.lang.Exception e)

hidePasswords

public static java.util.Map<java.lang.String,?> hidePasswords(java.util.Map<java.lang.String,?> map)

Hide the passwords and secrets in a config map (e.g. for logging).

Parameters:

map - a map with String keys (e.g. Properties) and String or nested map values

Returns:

new properties with no plaintext passwords and secrets

hidePasswords

public static java.util.Properties hidePasswords(java.util.Properties properties)

Parameters:

properties - the properties with potential password values

Returns:

new properties with no plaintext passwords

retainAllMatches

public static java.util.Set<java.lang.String> retainAllMatches(java.util.Collection<java.lang.String> values,
                                                               java.util.Collection<java.lang.String> whitelist)

containsWildcard

public static boolean containsWildcard(java.lang.String s)

escapeRegExCharacters

public static java.lang.String escapeRegExCharacters(java.lang.String s)

Escapes all regular expression patterns in a string so that when using the string itself in a regular expression, only an exact literal match will return true. For example, the string ".*" will not match any string, it will only match ".*". The value ".*" when escaped will be "\.\*"

Parameters:

s - - the string for which we need to escape regular expression constructs

Returns:

a regular expression string that will only match exact literals

escapeRegExCharacters

public static java.lang.String escapeRegExCharacters(java.lang.String s,
                                                     java.lang.String pattern)

Escapes all regular expression patterns in a string so that when using the string itself in a regular expression, only an exact literal match will return true.

Parameters:

s - - the string for which we need to escape regular expression constructs

pattern - - the pattern containing the characters we wish to remain string literals

Returns:

a regular expression string that will only match exact literals

constructSimpleWildcardPattern

public static java.lang.String constructSimpleWildcardPattern(java.lang.String s)

Returns a pattern that does a single level regular expression match where the * character is a wildcard until it encounters the next literal

Parameters:

s -

Returns:

the wildcard pattern

constructSimpleWildcardPatternWithAnyCharDelimiter

public static java.lang.String constructSimpleWildcardPatternWithAnyCharDelimiter(java.lang.String s)

constructWildcards

public static java.util.Set<java.util.regex.Pattern> constructWildcards(java.util.Collection<java.lang.String> wildcardStrings)

constructWildcards

public static java.util.Set<java.util.regex.Pattern> constructWildcards(java.util.Collection<java.lang.String> wildcardStrings,
                                                                        java.util.function.Function<java.lang.String,java.lang.String> replace)

matches

public static boolean matches(java.util.Set<java.util.regex.Pattern> wildcards,
                              java.lang.String scope)

getMapFromProperties

public static java.util.Map<java.lang.String,?> getMapFromProperties(java.util.Properties properties,
                                                                     java.lang.String prefix)

Extract a Map from some properties by removing a prefix from the key names.

Parameters:

properties - the properties to use

prefix - the prefix to strip from key names

Returns:

a map of String values

getHostIfArgIsURL

public static java.lang.String getHostIfArgIsURL(java.lang.String arg)

getStringsFromAuthorities

public static java.util.Set<java.lang.String> getStringsFromAuthorities(java.util.Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

getAuthoritiesFromStrings

public static java.util.List<? extends org.springframework.security.core.GrantedAuthority> getAuthoritiesFromStrings(java.util.Collection<java.lang.String> authorities)

containsIgnoreCase

public static boolean containsIgnoreCase(java.util.List<java.lang.String> list,
                                         java.lang.String findMe)

convertISO8859_1_to_UTF_8

public static java.lang.String convertISO8859_1_to_UTF_8(java.lang.String s)

toJsonString

public static java.lang.String toJsonString(java.lang.String s)