Package io.clonecloudstore.common.standard.system

Class ParametersChecker

java.lang.Object

io.clonecloudstore.common.standard.system.ParametersChecker

public final class ParametersChecker
extends Object

Checker for Parameters

Can be used for String (testing also emptiness) and for general Object.
For null String only, use the special method.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BUCKET_LENGTH
static final String	INVALID_INPUT
static final String	INVALID_URI
static final int	OBJECT_LENGTH
static final int	SITE_LENGTH

Method Summary

Modifier and Type	Method	Description
static void	checkParameter(String errorMessage, Object... parameters)	Check if any parameter are null or empty and if so, throw an CcsInvalidArgumentRuntimeException
static void	checkParameterNullOnly(String errorMessage, Object... parameters)	Check if any parameter are null and if so, throw an CcsInvalidArgumentRuntimeException
static void	checkSanity(Object... objects)	Check external argument (null is considered as correct)
static void	checkSanityBucketName(String bucketName)	Check external argument to avoid Path Traversal attack
static void	checkSanityMap(Map<String,String> map)	Check external argument to avoid Path Traversal attack
static void	checkSanityMapKey(String mapKey)	Check external argument to avoid Path Traversal attack
static void	checkSanityObjectName(String objectName)	Check external argument to avoid Path Traversal attack
static void	checkSanityString(String value)	Check external argument to avoid Path Traversal attack
static void	checkSanityString(String... strings)	Check external argument (null is considered as correct)
static void	checkSanityUri(String uri)	Check external argument to avoid Path Traversal attack
static void	checkValue(String name, long variable, long minValue)	Check if an integer parameter is greater or equals to minValue
static String	getSanitizedBucketName(String bucketName)	Check external argument to avoid Path Traversal attack
static String	getSanitizedName(String objectName)
static String	getSanitizedObjectName(String objectName)	Check external argument to avoid Path Traversal attack
static boolean	hasNotEmpty(Object... parameters)	Check if at least one parameter is not null and not empty and if so, return true
static boolean	isEmpty(Object... parameters)	Check if any parameter are null or empty and if so, return true
static boolean	isNotEmpty(Object... parameters)	Check if any parameter are null or empty and if so, return false
static String	urlDecodePathParam(String path)

Methods inherited from class java.lang.Object

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

Field Details

BUCKET_LENGTH

public static final int BUCKET_LENGTH

See Also:

• Constant Field Values

OBJECT_LENGTH

public static final int OBJECT_LENGTH

See Also:

• Constant Field Values

SITE_LENGTH

public static final int SITE_LENGTH

See Also:

• Constant Field Values

INVALID_INPUT

public static final String INVALID_INPUT

See Also:

• Constant Field Values

INVALID_URI

public static final String INVALID_URI

See Also:

• Constant Field Values

Method Details

checkParameter

public static void checkParameter(String errorMessage,
 Object... parameters)
                           throws CcsInvalidArgumentRuntimeException

Check if any parameter are null or empty and if so, throw an CcsInvalidArgumentRuntimeException

Parameters:

errorMessage - the error message

parameters - parameters to be checked

Throws:

CcsInvalidArgumentRuntimeException - if null or empty

checkParameterNullOnly

public static void checkParameterNullOnly(String errorMessage,
 Object... parameters)
                                   throws CcsInvalidArgumentRuntimeException

Check if any parameter are null and if so, throw an CcsInvalidArgumentRuntimeException

Parameters:

errorMessage - the error message

parameters - parameters to be checked

Throws:

CcsInvalidArgumentRuntimeException - if null

checkValue

public static void checkValue(String name,
 long variable,
 long minValue)
                       throws CcsInvalidArgumentRuntimeException

Check if an integer parameter is greater or equals to minValue

Parameters:

name - name of the variable

variable - the value of variable to check

minValue - the min value

Throws:

CcsInvalidArgumentRuntimeException - if invalid

checkSanityString

public static void checkSanityString(String value)
                              throws CcsInvalidArgumentRuntimeException

Check external argument to avoid Path Traversal attack

Parameters:

value - to check

Throws:

CcsInvalidArgumentRuntimeException - if invalid

checkSanity

public static void checkSanity(Object... objects)
                        throws CcsInvalidArgumentRuntimeException

Check external argument (null is considered as correct)

Parameters:

objects - the array to check (toString)

Throws:

CcsInvalidArgumentRuntimeException - if invalid

checkSanityString

public static void checkSanityString(String... strings)
                              throws CcsInvalidArgumentRuntimeException

Check external argument (null is considered as correct)

Parameters:

strings - the String array to check

Throws:

CcsInvalidArgumentRuntimeException - if invalid

checkSanityBucketName

public static void checkSanityBucketName(String bucketName)
                                  throws CcsInvalidArgumentRuntimeException

Check external argument to avoid Path Traversal attack

Parameters:

bucketName - to check

Throws:

CcsInvalidArgumentRuntimeException - if invalid

checkSanityObjectName

public static void checkSanityObjectName(String objectName)
                                  throws CcsInvalidArgumentRuntimeException

Check external argument to avoid Path Traversal attack

Parameters:

objectName - to check

Throws:

CcsInvalidArgumentRuntimeException - if invalid

checkSanityMapKey

public static void checkSanityMapKey(String mapKey)
                              throws CcsInvalidArgumentRuntimeException

Check external argument to avoid Path Traversal attack

Parameters:

mapKey - for Map key check

Throws:

CcsInvalidArgumentRuntimeException - if invalid

checkSanityMap

public static void checkSanityMap(Map<String,String> map)
                           throws CcsInvalidArgumentRuntimeException

Check external argument to avoid Path Traversal attack

Parameters:

map - where key and value are to be checked

Throws:

CcsInvalidArgumentRuntimeException - if invalid

isEmpty

public static boolean isEmpty(Object... parameters)

Check if any parameter are null or empty and if so, return true

Parameters:

parameters - set of parameters

Returns:

True if any is null or empty or containing only spaces

isNotEmpty

public static boolean isNotEmpty(Object... parameters)

Check if any parameter are null or empty and if so, return false

Parameters:

parameters - set of parameters

Returns:

True if not null and not empty neither containing only spaces

hasNotEmpty

public static boolean hasNotEmpty(Object... parameters)

Check if at least one parameter is not null and not empty and if so, return true

Parameters:

parameters - set of parameters

Returns:

True if at least one is not null and not empty neither containing only spaces

checkSanityUri

public static void checkSanityUri(String uri)
                           throws CcsInvalidArgumentRuntimeException

Check external argument to avoid Path Traversal attack

Parameters:

uri - to check

Throws:

CcsInvalidArgumentRuntimeException - if invalid

getSanitizedName

public static String getSanitizedName(String objectName)

Returns:

the sanitized name

getSanitizedBucketName

public static String getSanitizedBucketName(String bucketName)
                                     throws CcsInvalidArgumentRuntimeException

Check external argument to avoid Path Traversal attack

Parameters:

bucketName - to check

Returns:

the sanitized name

Throws:

CcsInvalidArgumentRuntimeException - if invalid

getSanitizedObjectName

public static String getSanitizedObjectName(String objectName)
                                     throws CcsInvalidArgumentRuntimeException

Check external argument to avoid Path Traversal attack

Parameters:

objectName - to check

Returns:

the sanitized name

Throws:

CcsInvalidArgumentRuntimeException - if invalid

urlDecodePathParam

public static String urlDecodePathParam(String path)