pl.chilldev.commons.jsonrpc.json

Class ParamsRetriever

java.lang.Object

com.thetransactioncompany.jsonrpc2.util.ParamsRetriever

com.thetransactioncompany.jsonrpc2.util.NamedParamsRetriever

pl.chilldev.commons.jsonrpc.json.ParamsRetriever

public class ParamsRetriever
extends com.thetransactioncompany.jsonrpc2.util.NamedParamsRetriever

Enhanced version of parameters retriever.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULTPARAM_COUNT Default result set size parameter name.
static String	DEFAULTPARAM_LIMIT Default records limit parameter name.
static String	DEFAULTPARAM_PAGE Default page number parameter name.
static String	DEFAULTPARAM_RECORDS Default page records parameter name.
static String	DEFAULTPARAM_SORT Default sort specification parameter name.
static com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER Jackson data binder.

Constructor Summary

Constructors

Constructor and Description
ParamsRetriever(com.thetransactioncompany.jsonrpc2.JSONRPC2Request request) Initializes retriever for given request.
ParamsRetriever(Map<String,Object> params) Initializes retriever with given parameters set.

Method Summary

Modifier and Type	Method and Description
<Type> Type	getBean(Class<Type> type) Retrieves typed bean from current parameters.
<Type> Type	getBean(String param, Class<Type> type) Retrieves typed bean from sub-map located under specified entry.
<Type> Type	getBean(String param, Class<Type> type, boolean allowNull) Retrieves typed bean from sub-map located under specified entry.
UUID	getOptUuid(String param) Returns UUID identifier from given optional parameter (not allowing null).
UUID	getOptUuid(String param, boolean allowNull) Returns UUID identifier from given optional parameter.
org.springframework.data.domain.Pageable	getPageable(int defaultLimit) Builds paged request data from default parameters names.
org.springframework.data.domain.Pageable	getPageable(String pageParam, String limitParam, String sortParam, int defaultLimit) Builds sort ordering criteria list.
org.springframework.data.domain.Sort	getSort(String param) Builds sort ordering criteria list.
UUID	getUuid(String param) Returns UUID identifier from given parameter (not allowing null).
UUID	getUuid(String param, boolean allowNull) Returns UUID identifier from given parameter.

Methods inherited from class com.thetransactioncompany.jsonrpc2.util.NamedParamsRetriever

ensureParam, ensureParam, ensureParam, ensureParameter, ensureParameter, ensureParameter, ensureParameters, ensureParameters, ensureParams, ensureParams, get, get, get, getBoolean, getDouble, getEnum, getEnum, getEnumString, getEnumString, getFloat, getInt, getList, getList, getLong, getMap, getMap, getNames, getOpt, getOpt, getOptBoolean, getOptDouble, getOptEnum, getOptEnum, getOptEnumString, getOptEnumString, getOptFloat, getOptInt, getOptList, getOptList, getOptLong, getOptMap, getOptMap, getOptString, getOptString, getOptStringArray, getOptStringArray, getParams, getString, getString, getStringArray, getStringArray, hasParam, hasParameter, hasParameters, hasParameters, hasParams, hasParams, size

Methods inherited from class com.thetransactioncompany.jsonrpc2.util.ParamsRetriever

getEnumStringMatch, getEnumStringMatch

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULTPARAM_PAGE

public static final String DEFAULTPARAM_PAGE

Default page number parameter name.

See Also:

Constant Field Values

DEFAULTPARAM_LIMIT

public static final String DEFAULTPARAM_LIMIT

Default records limit parameter name.

See Also:

Constant Field Values

DEFAULTPARAM_SORT

public static final String DEFAULTPARAM_SORT

Default sort specification parameter name.

See Also:

Constant Field Values

DEFAULTPARAM_RECORDS

public static final String DEFAULTPARAM_RECORDS

Default page records parameter name.

See Also:

Constant Field Values

DEFAULTPARAM_COUNT

public static final String DEFAULTPARAM_COUNT

Default result set size parameter name.

See Also:

Constant Field Values

OBJECT_MAPPER

public static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

Jackson data binder.

Constructor Detail

ParamsRetriever

public ParamsRetriever(Map<String,Object> params)

Initializes retriever with given parameters set.

Parameters:

params - Parameters map.

ParamsRetriever

public ParamsRetriever(com.thetransactioncompany.jsonrpc2.JSONRPC2Request request)

Initializes retriever for given request.

Parameters:

request - JSON-RPC request.

Method Detail

getUuid

public UUID getUuid(String param)
             throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Returns UUID identifier from given parameter (not allowing null).

Parameters:

param - Parameter name.

Returns:

Parsed UUID identifier.

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - On a missing parameter, bad type or null value (JSONRPC2Error.INVALID_PARAMS).

getUuid

public UUID getUuid(String param,
                    boolean allowNull)
             throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Returns UUID identifier from given parameter.

Parameters:

param - Parameter name.

allowNull - Whether to allow NULL values or throw exception in such case.

Returns:

Parsed UUID identifier.

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - On a missing parameter or bad type or null value (JSONRPC2Error.INVALID_PARAMS).

getOptUuid

public UUID getOptUuid(String param)
                throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Returns UUID identifier from given optional parameter (not allowing null).

Parameters:

param - Parameter name.

Returns:

Parsed UUID identifier. Note, that it may be NULL, if parameter is not set, but not when set to NULL.

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - On a missing parameter, bad type or null value (JSONRPC2Error.INVALID_PARAMS).

getOptUuid

public UUID getOptUuid(String param,
                       boolean allowNull)
                throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Returns UUID identifier from given optional parameter.

Parameters:

param - Parameter name.

allowNull - Whether to allow NULL values or throw exception in such case.

Returns:

Parsed UUID identifier.

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - On a missing parameter, bad type or null value (JSONRPC2Error.INVALID_PARAMS).

getSort

public org.springframework.data.domain.Sort getSort(String param)
                                             throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Builds sort ordering criteria list.

Parameters:

param - Parameter name.

Returns:

Parsed sort ordering criteria (NULL if empty).

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - On a missing parameter, bad type or null value (JSONRPC2Error.INVALID_PARAMS).

getPageable

public org.springframework.data.domain.Pageable getPageable(String pageParam,
                                                            String limitParam,
                                                            String sortParam,
                                                            int defaultLimit)
                                                     throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Builds sort ordering criteria list.

Parameters:

pageParam - Page number parameter name.

limitParam - Results limit parameter name.

sortParam - Sort specification parameter name.

defaultLimit - Default page limit.

Returns:

Paged request specification.

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - On a missing parameter, bad type or null value (JSONRPC2Error.INVALID_PARAMS).

getPageable

public org.springframework.data.domain.Pageable getPageable(int defaultLimit)
                                                     throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Builds paged request data from default parameters names.

Parameters:

defaultLimit - Default page limit.

Returns:

Paged request specification.

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - On a missing parameter, bad type or null value (JSONRPC2Error.INVALID_PARAMS).

getBean

public <Type> Type getBean(Class<Type> type)

Retrieves typed bean from current parameters.

Type Parameters:

Type - Destination bean type.

Parameters:

type - Destination bean class.

Returns:

Populated bean.

getBean

public <Type> Type getBean(String param,
                           Class<Type> type,
                           boolean allowNull)
                    throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Retrieves typed bean from sub-map located under specified entry.

Type Parameters:

Type - Destination bean type.

Parameters:

param - Property map parameter name.

type - Destination bean class.

allowNull - Whether NULL should be accepted as bean value.

Returns:

Populated bean.

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - When parameters reading fails.

getBean

public <Type> Type getBean(String param,
                           Class<Type> type)
                    throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error

Retrieves typed bean from sub-map located under specified entry.

Type Parameters:

Type - Destination bean type.

Parameters:

param - Property map parameter name.

type - Destination bean class.

Returns:

Populated bean.

Throws:

com.thetransactioncompany.jsonrpc2.JSONRPC2Error - When parameters reading fails.