CommonHelper (pac4j core 1.9.6 API)

java.lang.Object
- org.pac4j.core.util.CommonHelper

```
public final class CommonHelper
extends Object
```
This class gathers all the utilities methods.

Since:

1.4.0

Author:

Jerome Leleu

Field Summary

Fields
Modifier and Type Field and Description

static String CLASSPATH_PREFIX

protected static String FILE_PREFIX

static String INVALID_PATH_MESSAGE

static String RESOURCE_PREFIX

Fields
Modifier and Type	Field and Description
`static String`	`CLASSPATH_PREFIX`
`protected static String`	`FILE_PREFIX`
`static String`	`INVALID_PATH_MESSAGE`
`static String`	`RESOURCE_PREFIX`

Constructor Summary

Constructors
Constructor and Description

CommonHelper()

Constructors
Constructor and Description
`CommonHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`addParameter(String url, String name, String value)` Add a new parameter to an url.
`static boolean`	`areEquals(String s1, String s2)` Compare two String to see if they are equals (both null is ok).
`static boolean`	`areEqualsIgnoreCaseAndTrim(String s1, String s2)` Compare two String to see if they are equals ignoring the case and the blank spaces (both null is ok).
`static boolean`	`areNotEquals(String s1, String s2)` Compare two String to see if they are not equals.
`static void`	`assertNotBlank(String name, String value)` Verify that a String is not blank otherwise throw a `TechnicalException`.
`static void`	`assertNotNull(String name, Object obj)` Verify that an Object is not `null` otherwise throw a `TechnicalException`.
`static void`	`assertNull(String name, Object obj)` Verify that an Object is `null` otherwise throw a `TechnicalException`.
`static void`	`assertTrue(boolean value, String message)` Verify that a boolean is true otherwise throw a `TechnicalException`.
`protected static String`	`extractPrefix(String name)` Extract the prefix of the name.
`static InputStream`	`getInputStreamFromName(String name)` Returns an `InputStream` from given name depending on its format: - loads from the classloader of this class if name starts with "resource:" (add a slash a the beginning if absent) - loads from the classloader of the current thread if name starts with "classpath:" - loads from the given url if name starts with "http:" or "https:" - loads as `FileInputStream` otherwise
`static Resource`	`getResource(String filePath)`
`static boolean`	`isBlank(String s)` Return if the String is blank.
`static boolean`	`isEmpty(Collection<?> coll)` Return if a collection is empty.
`static boolean`	`isNotBlank(String s)` Return if the String is not blank.
`static boolean`	`isNotEmpty(Collection<?> coll)` Return if a collection is not empty.
`static Date`	`newDate(Date original)` Copy a date.
`static String`	`randomString(int size)` Return a random string of a certain size.
`protected static String`	`startWithSlash(String path)` Add a slash at the beginning of a path if missing.
`static String`	`substringAfter(String str, String separator)`
`static String`	`substringBefore(String str, String separator)`
`static String`	`substringBetween(String str, String open, String close)`
`static String`	`toString(Class<?> clazz, Object... args)` Build a normalized "toString" text for an object.
`static String`	`urlEncode(String text)` URL encode a text using UTF-8.

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

- Field Detail
  - RESOURCE_PREFIX
```
public static final String RESOURCE_PREFIX
```
    See Also:
    
    Constant Field Values
  - CLASSPATH_PREFIX
```
public static final String CLASSPATH_PREFIX
```
    See Also:
    
    Constant Field Values
  - FILE_PREFIX
```
protected static final String FILE_PREFIX
```
    See Also:
    
    Constant Field Values
  - INVALID_PATH_MESSAGE
```
public static final String INVALID_PATH_MESSAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommonHelper
```
public CommonHelper()
```
- Method Detail
  - isNotBlank
```
public static boolean isNotBlank(String s)
```
    Return if the String is not blank.
    
    Parameters:
    
    s - string
    
    Returns:
    
    if the String is not blank
  - isBlank
```
public static boolean isBlank(String s)
```
    Return if the String is blank.
    
    Parameters:
    
    s - string
    
    Returns:
    
    if the String is blank
  - areEquals
```
public static boolean areEquals(String s1,
                                String s2)
```
    Compare two String to see if they are equals (both null is ok).
    
    Parameters:
    
    s1 - string
    
    s2 - string
    
    Returns:
    
    if two String are equals
  - areEqualsIgnoreCaseAndTrim
```
public static boolean areEqualsIgnoreCaseAndTrim(String s1,
                                                 String s2)
```
    Compare two String to see if they are equals ignoring the case and the blank spaces (both null is ok).
    
    Parameters:
    
    s1 - string
    
    s2 - string
    
    Returns:
    
    if two String are equals ignoring the case and the blank spaces
  - areNotEquals
```
public static boolean areNotEquals(String s1,
                                   String s2)
```
    Compare two String to see if they are not equals.
    
    Parameters:
    
    s1 - string
    
    s2 - string
    
    Returns:
    
    if two String are not equals
  - isEmpty
```
public static boolean isEmpty(Collection<?> coll)
```
    Return if a collection is empty.
    
    Parameters:
    
    coll - a collection
    
    Returns:
    
    whether it is empty
  - isNotEmpty
```
public static boolean isNotEmpty(Collection<?> coll)
```
    Return if a collection is not empty.
    
    Parameters:
    
    coll - a collection
    
    Returns:
    
    whether it is not empty
  - assertTrue
```
public static void assertTrue(boolean value,
                              String message)
```
    Verify that a boolean is true otherwise throw a TechnicalException.
    
    Parameters:
    
    value - the value to be checked for truth
    
    message - the message to include in the exception if the value is false
  - assertNotBlank
```
public static void assertNotBlank(String name,
                                  String value)
```
    Verify that a String is not blank otherwise throw a TechnicalException.
    
    Parameters:
    
    name - name if the string
    
    value - value of the string
  - assertNotNull
```
public static void assertNotNull(String name,
                                 Object obj)
```
    Verify that an Object is not null otherwise throw a TechnicalException.
    
    Parameters:
    
    name - name of the object
    
    obj - object
  - assertNull
```
public static void assertNull(String name,
                              Object obj)
```
    Verify that an Object is null otherwise throw a TechnicalException.
    
    Parameters:
    
    name - name of the object
    
    obj - object
  - addParameter
```
public static String addParameter(String url,
                                  String name,
                                  String value)
```
    Add a new parameter to an url.
    
    Parameters:
    
    url - url
    
    name - name of the parameter
    
    value - value of the parameter
    
    Returns:
    
    the new url with the parameter appended
  - urlEncode
```
public static String urlEncode(String text)
```
    URL encode a text using UTF-8.
    
    Parameters:
    
    text - text to encode
    
    Returns:
    
    the encoded text
  - toString
```
public static String toString(Class<?> clazz,
                              Object... args)
```
    Build a normalized "toString" text for an object.
    
    Parameters:
    
    clazz - class
    
    args - arguments
    
    Returns:
    
    a normalized "toString" text
  - extractPrefix
```
protected static String extractPrefix(String name)
```
    Extract the prefix of the name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the prefix
  - startWithSlash
```
protected static String startWithSlash(String path)
```
    Add a slash at the beginning of a path if missing.
    
    Parameters:
    
    path - the path
    
    Returns:
    
    the completed path
  - getInputStreamFromName
```
public static InputStream getInputStreamFromName(String name)
```
    Returns an InputStream from given name depending on its format: - loads from the classloader of this class if name starts with "resource:" (add a slash a the beginning if absent) - loads from the classloader of the current thread if name starts with "classpath:" - loads from the given url if name starts with "http:" or "https:" - loads as FileInputStream otherwise
    Caller is responsible for closing inputstream
    
    Parameters:
    
    name - name of the resource
    
    Returns:
    
    the input stream
  - getResource
```
public static Resource getResource(String filePath)
```
  - randomString
```
public static String randomString(int size)
```
    Return a random string of a certain size.
    
    Parameters:
    
    size - the size
    
    Returns:
    
    the random size
  - newDate
```
public static Date newDate(Date original)
```
    Copy a date.
    
    Parameters:
    
    original - original date
    
    Returns:
    
    date copy
  - substringBetween
```
public static String substringBetween(String str,
                                      String open,
                                      String close)
```
  - substringAfter
```
public static String substringAfter(String str,
                                    String separator)
```
  - substringBefore
```
public static String substringBefore(String str,
                                     String separator)
```

Class CommonHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESOURCE_PREFIX

CLASSPATH_PREFIX

FILE_PREFIX

INVALID_PATH_MESSAGE

Constructor Detail

CommonHelper

Method Detail

isNotBlank

isBlank

areEquals

areEqualsIgnoreCaseAndTrim

areNotEquals

isEmpty

isNotEmpty

assertTrue

assertNotBlank

assertNotNull

assertNull

addParameter

urlEncode

toString

extractPrefix

startWithSlash

getInputStreamFromName

getResource

randomString

newDate

substringBetween

substringAfter

substringBefore