org.pac4j.core.util

Class CommonHelper

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
static String	INVALID_PATH_MESSAGE
static String	RESOURCE_PREFIX

Constructor Summary

Constructors

Constructor and Description
CommonHelper()

Method Summary

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	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.
static InputStream	getInputStreamFromName(String name) Returns an InputStream from given name depending on its format: - loads from the classloader if name starts with "resource:" - loads as FileInputStream otherwise Caller is responsible for closing inputstream
static Resource	getResource(String filePath)
static boolean	isBlank(String s) Return if the String is blank.
static boolean	isNotBlank(String s) Return if the String is not blank.
static String	toString(Class<?> clazz, Object... args) Build a normalized "toString" text for an object.

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

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

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

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

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

getInputStreamFromName

public static InputStream getInputStreamFromName(String name)

Returns an InputStream from given name depending on its format: - loads from the classloader if name starts with "resource:" - 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)