CsrfGuardUtils (OWASP CSRFGuard 3.1.0 API)

java.lang.Object
- org.owasp.csrfguard.util.CsrfGuardUtils

public class CsrfGuardUtils
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static Object[] EMPTY_OBJECT_ARRAY
An empty immutable Object array.

Fields
Modifier and Type	Field and Description
`static Object[]`	`EMPTY_OBJECT_ARRAY` An empty immutable `Object` array.

Constructor Summary

Constructors
Constructor and Description

CsrfGuardUtils()

Constructors
Constructor and Description
`CsrfGuardUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`abbreviate(String str, int maxWidth)` Abbreviates a String using ellipses.
`static String`	`abbreviate(String str, int offset, int maxWidth)` Abbreviates a String using ellipses.
`static void`	`assignField(Class theClass, Object invokeOn, String fieldName, Object dataToAssign, boolean callOnSupers, boolean overrideSecurity, boolean typeCast, Class<? extends Annotation> annotationWithValueOverride)` assign data to a field
`static void`	`assignField(Field field, Object invokeOn, Object dataToAssign, boolean overrideSecurity, boolean typeCast)` assign data to a field
`static void`	`assignField(Field field, Object invokeOn, Object dataToAssign, boolean overrideSecurity, boolean typeCast, Class<? extends Annotation> annotationWithValueOverride)` assign data to a field
`static void`	`assignField(Object invokeOn, String fieldName, Object dataToAssign)` assign data to a field.
`static Object`	`callMethod(Class theClass, Object invokeOn, String methodName)` helper method for calling a method with no params (could be in superclass)
`static Object`	`callMethod(Class theClass, Object invokeOn, String methodName, Object paramTypesOrArrayOrList, Object paramsOrListOrArray)` helper method for calling a method (could be in superclass)
`static Object`	`callMethod(Class theClass, Object invokeOn, String methodName, Object paramTypesOrArrayOrList, Object paramsOrListOrArray, boolean callOnSupers)` helper method for calling a method
`static Object`	`callMethod(Class theClass, Object invokeOn, String methodName, Object paramTypesOrArrayOrList, Object paramsOrListOrArray, boolean callOnSupers, boolean overrideSecurity)` helper method for calling a method
`static String`	`className(Object object)` null safe classname method, gets the unenhanced name
`static String`	`classNameCollection(Object object)` null safe classname method, max out at 20
`static void`	`closeQuietly(Connection connection)` close a connection null safe and dont throw exception
`static void`	`closeQuietly(InputStream input)` Unconditionally close an `InputStream`.
`static void`	`closeQuietly(OutputStream output)` Unconditionally close an `OutputStream`.
`static void`	`closeQuietly(Reader input)` Unconditionally close an `Reader`.
`static void`	`closeQuietly(ResultSet resultSet)` close a resultSet null safe and dont throw exception
`static void`	`closeQuietly(Statement statement)` close a statement null safe and dont throw exception
`static void`	`closeQuietly(Writer writer)` close a writer quietly
`static void`	`closeQuietly(XMLStreamWriter writer)` close a writer quietly
`static String`	`defaultString(String str)` Returns either the passed in String, or if the String is `null`, an empty String ("").
`static Field`	`field(Class theClass, String fieldName, boolean callOnSupers, boolean throwExceptionIfNotFound)` get a field object for a class, potentially in superclasses
`static Class`	`forName(String origClassName)` Returns the class object.
`static Throwable`	`getCause(Throwable throwable)` Introspects the `Throwable` to obtain the cause.
`static Throwable`	`getCause(Throwable throwable, String[] methodNames)` Introspects the `Throwable` to obtain the cause.
`static String`	`getFullStackTrace(Throwable throwable)` A way to get the entire nested stack-trace of an throwable.
`static String`	`getInitParameter(javax.servlet.ServletConfig servletConfig, String name, String configFileDefaultParamValue, String defaultValue)`
`static Throwable[]`	`getThrowables(Throwable throwable)` Returns the list of `Throwable` objects in the exception chain.
`static String`	`httpProtocolAndDomain(String url)` for a url, get the protocol and domain, e.g.
`static boolean`	`injectInException(Throwable t, String message)` If we can, inject this into the exception, else return false
`static Object`	`invokeMethod(Method method, Object invokeOn)` Safely invoke a reflection method that takes no args
`static Object`	`invokeMethod(Method method, Object invokeOn, Object paramsOrListOrArray)` Safely invoke a reflection method
`static boolean`	`isBlank(Object input)` See if the input is null or if string, if it is empty or blank (whitespace)
`static boolean`	`isBlank(String str)` Checks if a String is whitespace, empty ("") or null.
`static boolean`	`isNestedThrowable(Throwable throwable)` Checks whether this `Throwable` class can store a cause.
`static boolean`	`isThrowableNested()` Checks if the Throwable class has a `getCause` method.
`static Iterator`	`iterator(Object collection)` null safe iterator getter if the type if collection
`static int`	`length(Object arrayOrCollection)` Null safe array length or map
`static <T> T`	`newInstance(Class<T> theClass)` Construct a class
`static Object`	`next(Object arrayOrCollection, Iterator iterator, int index)` If array, get the element based on index, if Collection, get it based on iterator.
`static String`	`readFileContent(String fileName)`
`static String`	`readInputStreamContent(InputStream is)`
`static String`	`readResourceFileContent(String resourceName, boolean errorIfNotFound)`
`static <T> T[]`	`toArray(Collection collection, Class<T> theClass)` convert a list into an array of type of theClass
`static Object`	`toArray(Object objectOrArrayOrCollection)` Convert a list to an array with the type of the first element e.g.
`static String`	`toStringForLog(Object object)` print out various types of objects
`static String`	`toStringForLog(Object object, int maxChars)` print out various types of objects
`static <T> T`	`typeCast(Object value, Class<T> theClass)` If necessary, convert an object to another type.
`static <T> T`	`typeCast(Object value, Class<T> theClass, boolean convertNullToDefaultPrimitive, boolean useNewInstanceHooks)` If necessary, convert an object to another type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMPTY_OBJECT_ARRAY
```
public static final Object[] EMPTY_OBJECT_ARRAY
```
    An empty immutable Object array.
- Constructor Detail
  - CsrfGuardUtils
```
public CsrfGuardUtils()
```
- Method Detail
  - httpProtocolAndDomain
```
public static String httpProtocolAndDomain(String url)
```
    for a url, get the protocol and domain, e.g. for url https://a.b/path, will return https://a.b
    
    Parameters:
    url -
    
    Returns:
    the protocol and path
  - callMethod
```
public static Object callMethod(Class theClass,
                Object invokeOn,
                String methodName)
```
    helper method for calling a method with no params (could be in superclass)
    
    Parameters:
    theClass - the class which has the method
    invokeOn - to call on or null for static
    methodName - method name to call
    
    Returns:
    the data
  - callMethod
```
public static Object callMethod(Class theClass,
                Object invokeOn,
                String methodName,
                Object paramTypesOrArrayOrList,
                Object paramsOrListOrArray)
```
    helper method for calling a method (could be in superclass)
    
    Parameters:
    theClass - the class which has the method
    invokeOn - to call on or null for static
    methodName - method name to call
    paramTypesOrArrayOrList - types of the params
    paramsOrListOrArray - data
    
    Returns:
    the data
  - callMethod
```
public static Object callMethod(Class theClass,
                Object invokeOn,
                String methodName,
                Object paramTypesOrArrayOrList,
                Object paramsOrListOrArray,
                boolean callOnSupers)
```
    helper method for calling a method
    
    Parameters:
    theClass - the class which has the method
    invokeOn - to call on or null for static
    methodName - method name to call
    paramTypesOrArrayOrList - types of the params
    paramsOrListOrArray - data
    callOnSupers - if static and method not exists, try on supers
    
    Returns:
    the data
  - callMethod
```
public static Object callMethod(Class theClass,
                Object invokeOn,
                String methodName,
                Object paramTypesOrArrayOrList,
                Object paramsOrListOrArray,
                boolean callOnSupers,
                boolean overrideSecurity)
```
    helper method for calling a method
    
    Parameters:
    theClass - the class which has the method
    invokeOn - to call on or null for static
    methodName - method name to call
    paramTypesOrArrayOrList - types of the params
    paramsOrListOrArray - data
    callOnSupers - if static and method not exists, try on supers
    overrideSecurity - true to call on protected or private etc methods
    
    Returns:
    the data
  - forName
```
public static Class forName(String origClassName)
```
```
Returns the class object.
```
    Parameters:
    origClassName - is fully qualified
    
    Returns:
    the class
  - getInitParameter
```
public static String getInitParameter(javax.servlet.ServletConfig servletConfig,
                      String name,
                      String configFileDefaultParamValue,
                      String defaultValue)
```
  - readResourceFileContent
```
public static String readResourceFileContent(String resourceName,
                             boolean errorIfNotFound)
```
  - readFileContent
```
public static String readFileContent(String fileName)
```
  - readInputStreamContent
```
public static String readInputStreamContent(InputStream is)
```
  - injectInException
```
public static boolean injectInException(Throwable t,
                        String message)
```
    If we can, inject this into the exception, else return false
    
    Parameters:
    t -
    message -
    
    Returns:
    true if success, false if not
  - isBlank
```
public static boolean isBlank(Object input)
```
    See if the input is null or if string, if it is empty or blank (whitespace)
    
    Parameters:
    input -
    
    Returns:
    true if blank
  - isBlank
```
public static boolean isBlank(String str)
```
    Checks if a String is whitespace, empty ("") or null.
```
 isBlank(null)      = true
 isBlank("")        = true
 isBlank(" ")       = true
 isBlank("bob")     = false
 isBlank("  bob  ") = false
 
```
    Parameters:
    str - the String to check, may be null
    
    Returns:
    true if the String is null, empty or whitespace
    Since:
    
    2.0
  - assignField
```
public static void assignField(Class theClass,
               Object invokeOn,
               String fieldName,
               Object dataToAssign,
               boolean callOnSupers,
               boolean overrideSecurity,
               boolean typeCast,
               Class<? extends Annotation> annotationWithValueOverride)
```
    assign data to a field
    
    Parameters:
    theClass - the class which has the method
    invokeOn - to call on or null for static
    fieldName - method name to call
    dataToAssign - data
    callOnSupers - if static and method not exists, try on supers
    overrideSecurity - true to call on protected or private etc methods
    typeCast - true if we should typecast
    annotationWithValueOverride - annotation with value of override
  - toArray
```
public static Object toArray(Object objectOrArrayOrCollection)
```
    Convert a list to an array with the type of the first element e.g. if it is a list of Person objects, then the array is Person[]
    
    Parameters:
    objectOrArrayOrCollection - is a list
    
    Returns:
    the array of objects with type of the first element in the list
  - length
```
public static int length(Object arrayOrCollection)
```
    Null safe array length or map
    
    Parameters:
    arrayOrCollection -
    
    Returns:
    the length of the array (0 for null)
  - toArray
```
public static <T> T[] toArray(Collection collection,
              Class<T> theClass)
```
    convert a list into an array of type of theClass
    
    Type Parameters:
    T - is the type of the array
    Parameters:
    collection - list to convert
    theClass - type of array to return
    
    Returns:
    array of type theClass[] filled with the objects from list
  - assignField
```
public static void assignField(Object invokeOn,
               String fieldName,
               Object dataToAssign)
```
    assign data to a field. Will find the field in superclasses, will typecast, and will override security (private, protected, etc)
    
    Parameters:
    invokeOn - to call on or null for static
    fieldName - method name to call
    dataToAssign - data
  - invokeMethod
```
public static Object invokeMethod(Method method,
                  Object invokeOn)
```
    Safely invoke a reflection method that takes no args
    
    Parameters:
    method - to invoke
    invokeOn - if NO_PARAMS then will not pass in params.
    
    Returns:
    the result
  - invokeMethod
```
public static Object invokeMethod(Method method,
                  Object invokeOn,
                  Object paramsOrListOrArray)
```
    Safely invoke a reflection method
    
    Parameters:
    method - to invoke
    invokeOn -
    paramsOrListOrArray - must be an arg. If null, will pass null. if NO_PARAMS then will not pass in params.
    
    Returns:
    the result
  - className
```
public static String className(Object object)
```
    null safe classname method, gets the unenhanced name
    
    Parameters:
    object -
    
    Returns:
    the classname
  - classNameCollection
```
public static String classNameCollection(Object object)
```
    null safe classname method, max out at 20
    
    Parameters:
    object -
    
    Returns:
    the classname
  - iterator
```
public static Iterator iterator(Object collection)
```
    null safe iterator getter if the type if collection
    
    Parameters:
    collection -
    
    Returns:
    the iterator
  - next
```
public static Object next(Object arrayOrCollection,
          Iterator iterator,
          int index)
```
    If array, get the element based on index, if Collection, get it based on iterator.
    
    Parameters:
    arrayOrCollection -
    iterator -
    index -
    
    Returns:
    the object
  - assignField
```
public static void assignField(Field field,
               Object invokeOn,
               Object dataToAssign,
               boolean overrideSecurity,
               boolean typeCast,
               Class<? extends Annotation> annotationWithValueOverride)
```
    assign data to a field
    
    Parameters:
    field - is the field to assign to
    invokeOn - to call on or null for static
    dataToAssign - data
    overrideSecurity - true to call on protected or private etc methods
    typeCast - true if we should typecast
    annotationWithValueOverride - annotation with value of override, or null if none
  - field
```
public static Field field(Class theClass,
          String fieldName,
          boolean callOnSupers,
          boolean throwExceptionIfNotFound)
```
    get a field object for a class, potentially in superclasses
    
    Parameters:
    theClass -
    fieldName -
    callOnSupers - true if superclasses should be looked in for the field
    throwExceptionIfNotFound - will throw runtime exception if not found
    
    Returns:
    the field object or null if not found (or exception if param is set)
  - assignField
```
public static void assignField(Field field,
               Object invokeOn,
               Object dataToAssign,
               boolean overrideSecurity,
               boolean typeCast)
```
    assign data to a field
    
    Parameters:
    field - is the field to assign to
    invokeOn - to call on or null for static
    dataToAssign - data
    overrideSecurity - true to call on protected or private etc methods
    typeCast - true if we should typecast
  - typeCast
```
public static <T> T typeCast(Object value,
             Class<T> theClass)
```
    If necessary, convert an object to another type. if type is Object.class, just return the input. Do not convert null to an empty primitive
    
    Type Parameters:
    T - is template type
    Parameters:
    value -
    theClass -
    
    Returns:
    the object of that instance converted into something else
  - typeCast
```
public static <T> T typeCast(Object value,
             Class<T> theClass,
             boolean convertNullToDefaultPrimitive,
             boolean useNewInstanceHooks)
```
    If necessary, convert an object to another type. if type is Object.class, just return the input
    
    Type Parameters:
    T - is the type to return
    Parameters:
    value -
    theClass -
    convertNullToDefaultPrimitive - if the value is null, and theClass is primitive, should we convert the null to a primitive default value
    useNewInstanceHooks - if theClass is not recognized, then honor the string "null", "newInstance", or get a constructor with one param, and call it
    
    Returns:
    the object of that instance converted into something else
  - newInstance
```
public static <T> T newInstance(Class<T> theClass)
```
    Construct a class
    
    Type Parameters:
    T - template type
    Parameters:
    theClass -
    
    Returns:
    the instance
  - closeQuietly
```
public static void closeQuietly(Connection connection)
```
    close a connection null safe and dont throw exception
    
    Parameters:
    connection -
  - closeQuietly
```
public static void closeQuietly(InputStream input)
```
    Unconditionally close an InputStream. Equivalent to InputStream.close(), except any exceptions will be ignored.
    
    Parameters:
    input - A (possibly null) InputStream
  - closeQuietly
```
public static void closeQuietly(OutputStream output)
```
    Unconditionally close an OutputStream. Equivalent to OutputStream.close(), except any exceptions will be ignored.
    
    Parameters:
    output - A (possibly null) OutputStream
  - closeQuietly
```
public static void closeQuietly(Reader input)
```
    Unconditionally close an Reader. Equivalent to Reader.close(), except any exceptions will be ignored.
    
    Parameters:
    input - A (possibly null) Reader
  - closeQuietly
```
public static void closeQuietly(ResultSet resultSet)
```
    close a resultSet null safe and dont throw exception
    
    Parameters:
    resultSet -
  - closeQuietly
```
public static void closeQuietly(Statement statement)
```
    close a statement null safe and dont throw exception
    
    Parameters:
    statement -
  - closeQuietly
```
public static void closeQuietly(Writer writer)
```
    close a writer quietly
    
    Parameters:
    writer -
  - closeQuietly
```
public static void closeQuietly(XMLStreamWriter writer)
```
    close a writer quietly
    
    Parameters:
    writer -
  - toStringForLog
```
public static String toStringForLog(Object object)
```
    print out various types of objects
    
    Parameters:
    object -
    
    Returns:
    the string value
  - toStringForLog
```
public static String toStringForLog(Object object,
                    int maxChars)
```
    print out various types of objects
    
    Parameters:
    object -
    maxChars - is the max chars that should be returned (abbreviate if longer), or -1 for any amount
    
    Returns:
    the string value
  - abbreviate
```
public static String abbreviate(String str,
                int maxWidth)
```
    Abbreviates a String using ellipses. This will turn "Now is the time for all good men" into "Now is the time for..."
    
    Specifically:
    - If str is less than maxWidth characters long, return it.
    - Else abbreviate it to (substring(str, 0, max-3) + "...").
    - If maxWidth is less than 4, throw an IllegalArgumentException.
    - In no case will it return a String of length greater than maxWidth.
```
 StringUtils.abbreviate(null, *)      = null
 StringUtils.abbreviate("", 4)        = ""
 StringUtils.abbreviate("abcdefg", 6) = "abc..."
 StringUtils.abbreviate("abcdefg", 7) = "abcdefg"
 StringUtils.abbreviate("abcdefg", 8) = "abcdefg"
 StringUtils.abbreviate("abcdefg", 4) = "a..."
 StringUtils.abbreviate("abcdefg", 3) = IllegalArgumentException
 
```
    Parameters:
    str - the String to check, may be null
    maxWidth - maximum length of result String, must be at least 4
    
    Returns:
    abbreviated String, null if null String input
    
    Throws:
    
    IllegalArgumentException - if the width is too small
    Since:
    
    2.0
  - abbreviate
```
public static String abbreviate(String str,
                int offset,
                int maxWidth)
```
    Abbreviates a String using ellipses. This will turn "Now is the time for all good men" into "...is the time for..."
    
    Works like abbreviate(String, int), but allows you to specify a "left edge" offset. Note that this left edge is not necessarily going to be the leftmost character in the result, or the first character following the ellipses, but it will appear somewhere in the result.
    In no case will it return a String of length greater than maxWidth.
```
 StringUtils.abbreviate(null, *, *)                = null
 StringUtils.abbreviate("", 0, 4)                  = ""
 StringUtils.abbreviate("abcdefghijklmno", -1, 10) = "abcdefg..."
 StringUtils.abbreviate("abcdefghijklmno", 0, 10)  = "abcdefg..."
 StringUtils.abbreviate("abcdefghijklmno", 1, 10)  = "abcdefg..."
 StringUtils.abbreviate("abcdefghijklmno", 4, 10)  = "abcdefg..."
 StringUtils.abbreviate("abcdefghijklmno", 5, 10)  = "...fghi..."
 StringUtils.abbreviate("abcdefghijklmno", 6, 10)  = "...ghij..."
 StringUtils.abbreviate("abcdefghijklmno", 8, 10)  = "...ijklmno"
 StringUtils.abbreviate("abcdefghijklmno", 10, 10) = "...ijklmno"
 StringUtils.abbreviate("abcdefghijklmno", 12, 10) = "...ijklmno"
 StringUtils.abbreviate("abcdefghij", 0, 3)        = IllegalArgumentException
 StringUtils.abbreviate("abcdefghij", 5, 6)        = IllegalArgumentException
 
```
    Parameters:
    str - the String to check, may be null
    offset - left edge of source String
    maxWidth - maximum length of result String, must be at least 4
    
    Returns:
    abbreviated String, null if null String input
    
    Throws:
    
    IllegalArgumentException - if the width is too small
    Since:
    
    2.0
  - getFullStackTrace
```
public static String getFullStackTrace(Throwable throwable)
```
    A way to get the entire nested stack-trace of an throwable.
    
    Parameters:
    throwable - the Throwable to be examined
    
    Returns:
    the nested stack trace, with the root cause first
    Since:
    
    2.0
  - getThrowables
```
public static Throwable[] getThrowables(Throwable throwable)
```
    Returns the list of Throwable objects in the exception chain.
    
    A throwable without cause will return an array containing one element - the input throwable. A throwable with one cause will return an array containing two elements. - the input throwable and the cause throwable. A null throwable will return an array size zero.
    
    Parameters:
    throwable - the throwable to inspect, may be null
    
    Returns:
    the array of throwables, never null
  - isNestedThrowable
```
public static boolean isNestedThrowable(Throwable throwable)
```
    Checks whether this Throwable class can store a cause.
    
    This method does not check whether it actually does store a cause.
    
    Parameters:
    throwable - the Throwable to examine, may be null
    
    Returns:
    boolean true if nested otherwise false
    Since:
    
    2.0
  - getCause
```
public static Throwable getCause(Throwable throwable)
```
    Introspects the Throwable to obtain the cause.
    
    The method searches for methods with specific names that return a Throwable object. This will pick up most wrapping exceptions, including those from JDK 1.4, and NestableException.
    
    The default list searched for are:
    - getCause()
    - getNextException()
    - getTargetException()
    - getException()
    - getSourceException()
    - getRootCause()
    - getCausedByException()
    - getNested()
    In the absence of any such method, the object is inspected for a detail field assignable to a Throwable.
    
    If none of the above is found, returns null.
    Parameters:
    throwable - the throwable to introspect for a cause, may be null
    
    Returns:
    the cause of the Throwable, null if none found or null throwable input
    Since:
    
    1.0
  - getCause
```
public static Throwable getCause(Throwable throwable,
                 String[] methodNames)
```
    Introspects the Throwable to obtain the cause.
    1. Try known exception types.
    2. Try the supplied array of method names.
    3. Try the field 'detail'.
    A null set of method names means use the default set. A null in the set of method names will be ignored.
    Parameters:
    throwable - the throwable to introspect for a cause, may be null
    methodNames - the method names, null treated as default set
    
    Returns:
    the cause of the Throwable, null if none found or null throwable input
    Since:
    
    1.0
  - isThrowableNested
```
public static boolean isThrowableNested()
```
    Checks if the Throwable class has a getCause method.
    
    This is true for JDK 1.4 and above.
    
    Returns:
    true if Throwable is nestable
    Since:
    
    2.0
  - defaultString
```
public static String defaultString(String str)
```
    Returns either the passed in String, or if the String is null, an empty String ("").
```
 StringUtils.defaultString(null)  = ""
 StringUtils.defaultString("")    = ""
 StringUtils.defaultString("bat") = "bat"
 
```
    Parameters:
    str - the String to check, may be null
    
    Returns:
    the passed in String, or the empty String if it was null
    See Also:
    String.valueOf(Object)

Class CsrfGuardUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_OBJECT_ARRAY

Constructor Detail

CsrfGuardUtils

Method Detail

httpProtocolAndDomain

callMethod

callMethod

callMethod

callMethod

forName

getInitParameter

readResourceFileContent

readFileContent

readInputStreamContent

injectInException

isBlank

isBlank

assignField

toArray

length

toArray

assignField

invokeMethod

invokeMethod

className

classNameCollection

iterator

next

assignField

field

assignField

typeCast

typeCast

newInstance

closeQuietly

closeQuietly

closeQuietly

closeQuietly

closeQuietly

closeQuietly

closeQuietly

closeQuietly

toStringForLog

toStringForLog

abbreviate

abbreviate

getFullStackTrace

getThrowables

isNestedThrowable

getCause

getCause

isThrowableNested

defaultString