Package edu.internet2.middleware.grouperClient.util

Class GrouperClientUtils

java.lang.Object

edu.internet2.middleware.grouperClient.util.GrouperClientCommonUtils

edu.internet2.middleware.grouperClient.util.GrouperClientUtils

public class GrouperClientUtils
extends GrouperClientCommonUtils

utility methods specific to grouper client

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GrouperClientUtils.NotNullToStringStyle	dont print null fields in reflection

Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClient.util.GrouperClientCommonUtils

GrouperClientCommonUtils.CommandResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PERFORMANCE_LOG_LABEL_SQL	use this for performance log label for sql queries

Fields inherited from class edu.internet2.middleware.grouperClient.util.GrouperClientCommonUtils

DATE_FORMAT, DATE_MINUTES_SECONDS_FORMAT, DATE_MINUTES_SECONDS_NO_SLASH_FORMAT, DEFAULT_BUFFER_SIZE, EMPTY, EMPTY_OBJECT_ARRAY, EMPTY_STRING_ARRAY, INDEX_NOT_FOUND, LOG_ERROR, NOT_FOUND, ONE_GB, ONE_KB, ONE_MB, TIMESTAMP_DASHES_TENTHS_FORMAT, TIMESTAMP_FILE_FORMAT, TIMESTAMP_FORMAT, TIMESTAMP_NO_SLASH_FORMAT

Constructor Summary

Constructors

Constructor	Description
GrouperClientUtils()

Method Summary

Modifier and Type	Method	Description
static String	appendQuestions(int numberOfMarks)	append a certain number of question marks to a query
static void	appendQuestions(StringBuilder query, int numberOfMarks)	append a certain number of question marks to a query
static String	cacheDirectoryName()	name of the cache directory without trailing slash
static String	decryptFromFileIfFileExists(String pass, StringBuilder logInfo)	decrypt a pass from a file if the file exists (i.e. passes might have slashes in them)
static String	encryptKey()
static String	encryptSha(String plaintext)	encrypt a message to SHA with base 64
static String	extensionFromName(String name)	get the extension from name.
static Map<String,String>	grouperClientOverrideMap()	Deprecated. use GrouperClientConfig.retrieveConfig().propertiesOverrideMap() instead
static Properties	grouperClientProperties()	Deprecated. use GrouperClientConfig.retrieveConfig().properties() instead
static String	httpBasicAuthenticationString(String login, String password)	Create a basic authentication string.
static HttpCallResponse	httpCall(String urlSuffix, String serviceAuthn, HttpCallMethod httpCallMethod, String body)	call HTTP with a url, optional request body, get a response body.
static org.apache.http.impl.client.CloseableHttpClient	httpClient(boolean reuseIfConfigured)
static void	httpCloseQuietly(org.apache.http.impl.client.CloseableHttpClient closeableHttpClient, org.apache.http.client.methods.HttpRequestBase httpRequestBase, org.apache.http.client.methods.CloseableHttpResponse closeableHttpResponse, boolean reuseIfConfigured)
static org.apache.http.impl.client.CloseableHttpClient	httpTrustAllClient(boolean reuseIfConfigured)
static void	join(Thread thread)	wait for a thread to end
static Object	jsonConvertFrom(Map<String,Class<?>> conversionMap, String json)	convert an object from json.
static String	jsonConvertTo(Object object, boolean includeObjectNameWrapper)	convert object to json, optionally include object name wrapper
static void	main(String[] args)
static void	performanceTimingAllDuration(String key, long durationNanos)
static String	popUrlString(List<String> urlStrings)	pop first url string, retrieve, and remove, or null if not there
static String	propertiesValue(String key, boolean required)	Deprecated. use GrouperClientConfig.retrieveConfig().propertyValueString instead
static boolean	propertiesValueBoolean(String key, boolean defaultValue, boolean required)	Deprecated. use GrouperClientConfig.retrieveConfig().propertyValueBoolean instead
static int	propertiesValueInt(String key, int defaultValue, boolean required)	Deprecated. GrouperClientConfig.retrieveConfig().propertyValueInt
static org.apache.commons.logging.Log	retrieveLog(Class<?> theClass)
static String	subjectAttributeValue(WsSubject wsSubject, String[] attributeNames, String attributeName)	get the attribute value of an attribute name of a subject
static String	substituteExpressionLanguage(String stringToParse, Map<String,Object> variableMap)	substitute an EL for objects.
static String	substituteExpressionLanguage(String stringToParse, Map<String,Object> variableMap, boolean allowStaticClasses, boolean silent, boolean lenient, boolean logOnNull)	substitute an EL for objects
static String	toStringReflection(Object object)	to string reflection
static String	toStringReflection(Object object, Set<String> fieldsToIgnore)	to string reflection
static String	toStringReflection(Object object, Set<String> fieldsToIgnore, String extraInfo)	to string reflection

Methods inherited from class edu.internet2.middleware.grouperClient.util.GrouperClientCommonUtils

abbreviate, abbreviate, absolutePath, addIfNotThere, append, appendIfNotBlank, appendIfNotBlank, appendIfNotBlank, appendIfNotBlank, appendIfNotBlankString, appendIfNotEmpty, appendIfNotEmpty, appendIfNotEmpty, appendIfNotEmpty, argAfter, argKey, argMap, argMapBoolean, argMapBoolean, argMapFileList, argMapInteger, argMapList, argMapSet, argMapString, argMapTimestamp, argValue, arrayPopOne, assertion, assignField, assignField, assignField, assignField, assignField, assignSetter, batchList, batchNumberOfBatches, batchNumberOfBatches, batchNumberOfBatches, batchNumberOfBatches, bigDecimalObjectValue, booleanObjectValue, booleanValue, booleanValue, byteCountToDisplaySize, byteObjectValue, byteValue, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, capitalize, charObjectValue, charValue, classesString, classLoader, className, classNameCollection, clone, cloneFields, cloneValue, closeQuietly, closeQuietly, closeQuietly, closeQuietly, closeQuietly, closeQuietly, closeQuietly, collectionPopOne, collectionToString, compare, compareObjectFields, computeUrl, construct, contains, contains, contains, convertLongToChar, convertLongToCharSmall, convertLongToString, convertLongToStringSmall, convertMillisToFriendlyString, convertMillisToFriendlyString, convertToRuntimeException, convertUrlToDriverClassIfNeeded, copy, copy, copy, copy, copy, copyLarge, createParentDirectories, createRuntimeExceptionWithMessage, dateLongValue, dateStringValue, dateStringValue, dateToString, dateValue, debugMapIncrementLogEntry, defaultIfBlank, defaultIfEmpty, defaultIfNull, defaultString, defaultString, deleteCreateFile, deleteFile, deleteRecursiveDirectory, doubleObjectValue, doubleObjectValue, doubleValue, doubleValueNoError, endsWith, enumValueOfIgnoreCase, environmentVariable, equals, equals, equalsIgnoreCase, escapeUrlDecode, escapeUrlEncode, execCommand, execCommand, execCommand, field, fieldNames, fieldNames, fieldNames, fieldNames, fields, fields, fieldValue, fieldValue, fieldValue, fieldValue, fileCanonicalPath, fileFromResourceName, fileOrClasspathInputstream, floatObjectValue, floatValue, floatValueNoError, formatNumberWithCommas, forName, get, getCause, getCause, getFullStackTrace, getMaxLongValue, getMinLongValue, getter, getterHelper, getterNameFromPropertyName, getters, getThrowables, grouperClientVersion, grouperWsVersionConvert, hasOption, hostname, incrementChar, incrementStringInt, indent, indexOf, indexOf, injectInException, intObjectValue, intValue, intValue, intValueNoError, invokeMethod, invokeMethod, ipInt, ipOnNetwork, ipOnNetworks, ipReadyForAnd, isAscii, isBlank, isBlank, isEmpty, iserNameFromPropertyName, isGetter, isMysql, isNestedThrowable, isNotBlank, isOracle, isPostgres, isScalar, isSetter, isSQLServer, isThrowableNested, isWindows, iterator, jarFile, jarFile, jarVersion, join, join, join, join, join, leftPad, leftPad, leftPad, length, lengthAscii, listPopOne, longObjectValue, longValue, longValue, longValueNoError, manifestProperty, mapAddValue, mapAddValue, mapDifferences, mapEquals, mapToString, MapToString, method, methodNames, methodsHelper, mkdirs, monthInt, newFileUniqueName, newInstance, newInstance, next, nonNull, nonNull, nonNull, nonNull, nonNull, normalizeEmailAddresses, nullOrBlank, oracleStandardNameFromJava, packInts, parentStemNameFromName, prefixOrSuffix, processEnvVarOrFile, processEnvVarOrFileNoTrim, propertiesCacheClear, propertiesFromFile, propertiesFromResourceName, propertiesFromResourceName, propertiesThreadLocalOverrideMap, propertiesValue, propertiesValue, propertiesValue, propertiesValue, propertiesValueBoolean, propertiesValueBoolean, propertiesValueBoolean, propertiesValueBoolean, propertiesValueInt, propertiesValueInt, propertiesValueInt, propertyName, propertyType, propertyValidateValueBoolean, propertyValidateValueClass, propertyValidateValueInt, propertyValidateValueRequired, propertyValue, readFileIntoString, readFileIntoStringUtf8, readFileIntoStringUtf8, readFileIntoStringUtf8, readFileToString, readFromFileIfFile, readFromFileIfFileExists, readFromFileIfFileUtf8, readResourceIntoString, readResourceIntoString, remove, remove, removeEnd, removeEnd, renameTo, repeat, replace, replace, replace, replace, replace, replace, replace, replace, replace, replaceWhitespaceWithSpace, responseBodyAsString, retrieveExecutorService, retrievePasswordFromStdin, retrievePasswordFromStdin, rightPad, rightPad, rightPad, rollbackQuietly, saveStringIntoFile, saveStringIntoFile, serializeObjectToFile, setPopOne, setShorten, setter, setterHelper, setterNameFromPropertyName, setters, setToString, shortObjectValue, shortValue, sleep, sleepWithStdoutCountdown, split, split, split, split, splitByWholeSeparator, splitByWholeSeparator, splitPreserveAllTokens, splitPreserveAllTokens, splitPreserveAllTokens, splitPreserveAllTokens, splitTrim, splitTrim, splitTrimToList, splitTrimToSet, stack, stringLength, stringToDate, stringToDate2, stringToTimestamp, stringValue, stringValue, stripEnd, stripLastSlashIfExists, stripPrefix, stripStart, stripSuffix, substituteCommonVars, substringAfter, substringAfterLast, substringBefore, substringBeforeLast, suffixAfterChar, timestampToFileString, timestampToString, toArray, toArray, toList, toListClasses, toListFromCollection, toListObject, toMap, toSet, toSetObject, toSqlDate, toString, toString, toStringForLog, toStringForLog, toStringForLog, toStringObjectMap, toStringSafe, toTimestamp, trim, trimToEmpty, truncateAscii, typeCast, typeCast, uniqueId, unpackInt, unserializeObjectFromFile, uuid, validEmail, writeStringToFile, xmlEscape

Methods inherited from class java.lang.Object

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

Field Details

PERFORMANCE_LOG_LABEL_SQL

public static final String PERFORMANCE_LOG_LABEL_SQL

use this for performance log label for sql queries

See Also:

• Constant Field Values

Constructor Details

GrouperClientUtils

public GrouperClientUtils()

Method Details

httpTrustAllClient

public static org.apache.http.impl.client.CloseableHttpClient httpTrustAllClient(boolean reuseIfConfigured)

httpClient

public static org.apache.http.impl.client.CloseableHttpClient httpClient(boolean reuseIfConfigured)

httpBasicAuthenticationString

public static String httpBasicAuthenticationString(String login,
 String password)

Create a basic authentication string.

Parameters:

login - is the login.

password - is the password.

Returns:

"Basic login:password" where login:password is Base64 encoded.

httpCloseQuietly

public static void httpCloseQuietly(org.apache.http.impl.client.CloseableHttpClient closeableHttpClient,
 org.apache.http.client.methods.HttpRequestBase httpRequestBase,
 org.apache.http.client.methods.CloseableHttpResponse closeableHttpResponse,
 boolean reuseIfConfigured)

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

extensionFromName

public static String extensionFromName(String name)

get the extension from name. if name is a:b:c, name is c

Parameters:

name -

Returns:

the name

jsonConvertTo

public static String jsonConvertTo(Object object,
 boolean includeObjectNameWrapper)

convert object to json, optionally include object name wrapper

Parameters:

object -

includeObjectNameWrapper -

Returns:

the json

jsonConvertFrom

public static Object jsonConvertFrom(Map<String,Class<?>> conversionMap,
 String json)

convert an object from json. note this works well if there are no collections, just real types, arrays, etc.

Parameters:

conversionMap - is the class simple name to class of objects which are allowed to be brought back. Note: only the top level object needs to be registered

json -

Returns:

the object

performanceTimingAllDuration

public static void performanceTimingAllDuration(String key,
 long durationNanos)

Parameters:

key -

durationNanos -

toStringReflection

public static String toStringReflection(Object object,
 Set<String> fieldsToIgnore)

to string reflection

Parameters:

object -

Returns:

the string representation

toStringReflection

public static String toStringReflection(Object object,
 Set<String> fieldsToIgnore,
 String extraInfo)

to string reflection

Parameters:

object -

Returns:

the string representation

toStringReflection

public static String toStringReflection(Object object)

to string reflection

Parameters:

object -

Returns:

the string representation

appendQuestions

public static String appendQuestions(int numberOfMarks)

append a certain number of question marks to a query

Parameters:

query -

numberOfMarks -

appendQuestions

public static void appendQuestions(StringBuilder query,
 int numberOfMarks)

append a certain number of question marks to a query

Parameters:

query -

numberOfMarks -

retrieveLog

public static org.apache.commons.logging.Log retrieveLog(Class<?> theClass)

Parameters:

theClass -

Returns:

the log

grouperClientOverrideMap

@Deprecated
public static Map<String,String> grouperClientOverrideMap()

Deprecated.

use GrouperClientConfig.retrieveConfig().propertiesOverrideMap() instead

override map for properties for testing

Returns:

the override map

grouperClientProperties

@Deprecated
public static Properties grouperClientProperties()

Deprecated.

use GrouperClientConfig.retrieveConfig().properties() instead

grouper client properties

Returns:

the properties

propertiesValue

@Deprecated
public static String propertiesValue(String key,
 boolean required)

Deprecated.

use GrouperClientConfig.retrieveConfig().propertyValueString instead

get a property and validate required from grouper.client.properties

Parameters:

key -

required -

Returns:

the value

propertiesValueBoolean

@Deprecated
public static boolean propertiesValueBoolean(String key,
 boolean defaultValue,
 boolean required)

Deprecated.

use GrouperClientConfig.retrieveConfig().propertyValueBoolean instead

get a boolean and validate from grouper.client.properties

Parameters:

key -

defaultValue -

required -

Returns:

the string

propertiesValueInt

@Deprecated
public static int propertiesValueInt(String key,
 int defaultValue,
 boolean required)

Deprecated.

GrouperClientConfig.retrieveConfig().propertyValueInt

get a boolean and validate from grouper.client.properties

Parameters:

key -

defaultValue -

required -

Returns:

the string

substituteExpressionLanguage

public static String substituteExpressionLanguage(String stringToParse,
 Map<String,Object> variableMap)

substitute an EL for objects. Dont worry if something returns null

Parameters:

stringToParse -

variableMap -

Returns:

the string

join

public static void join(Thread thread)

wait for a thread to end

Parameters:

thread -

substituteExpressionLanguage

public static String substituteExpressionLanguage(String stringToParse,
 Map<String,Object> variableMap,
 boolean allowStaticClasses,
 boolean silent,
 boolean lenient,
 boolean logOnNull)

substitute an EL for objects

Parameters:

stringToParse -

variableMap -

allowStaticClasses - if true allow static classes not registered with context

silent - if silent mode, swallow exceptions (warn), and dont warn when variable not found

lenient - false if undefined variables should throw an exception. if lenient is true (default) then undefined variables are null

logOnNull - if null output of substitution should be logged

Returns:

the string

subjectAttributeValue

public static String subjectAttributeValue(WsSubject wsSubject,
 String[] attributeNames,
 String attributeName)

get the attribute value of an attribute name of a subject

Parameters:

wsSubject - subject

attributeNames - list of attribute names in the subject

attributeName - to query

Returns:

the value or null

encryptKey

public static String encryptKey()

Returns:

the encrypt key

decryptFromFileIfFileExists

public static String decryptFromFileIfFileExists(String pass,
 StringBuilder logInfo)

decrypt a pass from a file if the file exists (i.e. passes might have slashes in them)

Parameters:

pass -

logInfo - if not null, put log info in there

Returns:

the pass

cacheDirectoryName

public static String cacheDirectoryName()

name of the cache directory without trailing slash

Returns:

the name of the cache directory

encryptSha

public static String encryptSha(String plaintext)

encrypt a message to SHA with base 64

Parameters:

plaintext -

Returns:

the hash

httpCall

public static HttpCallResponse httpCall(String urlSuffix,
 String serviceAuthn,
 HttpCallMethod httpCallMethod,
 String body)

call HTTP with a url, optional request body, get a response body. this assumes json by default

Parameters:

urlSuffix - is after the configured URL, or if it starts with http:// or https:// just use that

serviceAuthn - is the config string that identifies the user/pass/url

httpCallMethod - HTTP

body - to send if applicable

Returns:

the response

popUrlString

public static String popUrlString(List<String> urlStrings)

pop first url string, retrieve, and remove, or null if not there

Parameters:

urlStrings -

Returns:

the string or null if not there