org.waarp.gateway.kernel.rest

Class RestArgument

java.lang.Object

org.waarp.gateway.kernel.rest.RestArgument

public class RestArgument
extends Object

Rest object that contains all arguments or answers once all tasks are over:
- ARG_HASBODY, ARG_METHOD, ARG_PATH, ARG_BASEPATH, ARGS_SUBPATH, ARG_X_AUTH_KEY, ARG_X_AUTH_USER, ARG_X_AUTH_TIMESTAMP, ARG_X_AUTH_ROLE: root elements (query only)
- ARG_METHOD, ARG_PATH, ARG_BASEPATH, ARGS_SUBPATH, ARG_X_AUTH_USER, JSON_STATUSMESSAGE, JSON_STATUSCODE, JSON_COMMAND: root elements (answer only)
- ARGS_URI: uri elements (query only)
- ARGS_HEADER: header elements (query only)
- ARG_COOKIE: cookie elements
- ARGS_BODY: body elements (query only)
- ARGS_ANSWER: answer part (answer only)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestArgument.DATAMODEL
static class	RestArgument.REST_FIELD
static class	RestArgument.REST_GROUP
static class	RestArgument.REST_ROOT_FIELD

Constructor Summary

Constructors

Constructor and Description
RestArgument(com.fasterxml.jackson.databind.node.ObjectNode emptyArgument) Create a RestArgument

Method Summary

Modifier and Type	Method and Description
void	addAnswer(com.fasterxml.jackson.databind.node.ObjectNode node)
void	addCountLimit(long count, long limit)
void	addFilter(com.fasterxml.jackson.databind.node.ObjectNode filter)
void	addIdToUriArgs()
void	addOptions(String allow, String path, com.fasterxml.jackson.databind.node.ArrayNode detailedAllow) Add options in answer
void	addResult(com.fasterxml.jackson.databind.node.ObjectNode result)
void	addSubUriToUriArgs(String name, int rank)
void	checkBaseAuthent(HmacSha256 hmacSha256, String extraKey, long maxInterval) This implementation of authentication is as follow: if X_AUTH is included in the URI or Header 0) Check that timestamp is correct (|curtime - timestamp| < maxinterval) from ARG_X_AUTH_TIMESTAMP, if maxInterval is 0, not mandatory 1) Get all URI args (except ARG_X_AUTH_KEY itself, but including timestamp), lowered case, in alphabetic order 2) Add an extra Key if not null (from ARG_X_AUTH_INTERNALKEY) 3) Compute an hash (SHA-1 or SHA-256) 4) Compare this hash with ARG_X_AUTH_KEY
void	checkTime(long maxInterval) Check Time only (no signature)
void	clean() Clean all internal values
protected static String	computeKey(HmacSha256 hmacSha256, String extraKey, TreeMap<String,String> treeMap, String argPath)
static com.fasterxml.jackson.databind.node.ObjectNode	fillDetailedAllow(HttpRestHandler.METHOD method, String path, String command, com.fasterxml.jackson.databind.node.ObjectNode body, com.fasterxml.jackson.databind.JsonNode result)
String	getAllowOption()
String	getAllowUrisOption()
com.fasterxml.jackson.databind.node.ObjectNode	getAnswer()
static String[]	getBaseAuthent(HmacSha256 hmacSha256, io.netty.handler.codec.http.QueryStringEncoder encoder, String user, String extraKey) The encoder is completed with extra necessary URI part containing ARG_X_AUTH_TIMESTAMP & ARG_X_AUTH_KEY
String	getBaseUri()
com.fasterxml.jackson.databind.node.ObjectNode	getBody()
DataModelRestMethodHandler.COMMAND_TYPE	getCommand()
String	getCommandField()
com.fasterxml.jackson.databind.node.ObjectNode	getCookieArgs()
long	getCount()
String	getDetail()
com.fasterxml.jackson.databind.node.ArrayNode	getDetailedAllowOption()
com.fasterxml.jackson.databind.node.ObjectNode	getFilter()
com.fasterxml.jackson.databind.node.ObjectNode	getHeaderArgs()
com.fasterxml.jackson.databind.JsonNode	getId()
static com.fasterxml.jackson.databind.JsonNode	getId(com.fasterxml.jackson.databind.node.ObjectNode node)
long	getLimit()
long	getLimitFromUri()
HttpRestHandler.METHOD	getMethod()
com.fasterxml.jackson.databind.node.ArrayNode	getResults()
int	getStatusCode()
String	getStatusMessage()
Iterator<com.fasterxml.jackson.databind.JsonNode>	getSubUri()
int	getSubUriSize()
String	getUri()
com.fasterxml.jackson.databind.node.ObjectNode	getUriArgs()
String	getXAuthKey()
RoleDefault.ROLE	getXAuthRole()
String	getXAuthTimestamp()
String	getXAuthUser()
void	methodFromHeader() set method From Header
void	methodFromUri() set method From URI
String	prettyPrint()
void	setCommand(DataModelRestMethodHandler.COMMAND_TYPE command)
void	setCommand(String cmd)
void	setCookieArgs(String cookieString) set values from Cookies into arguments.path(ARGS_COOKIE)
void	setDetail(String detail)
void	setFromArgument(RestArgument source) Set X_AUTH_USER, Method, Path, Basepath and Cookie from source
void	setHeaderArgs(Iterator<Map.Entry<CharSequence,CharSequence>> iterator) set values from Header into arguments.path(ARGS_HEADER)
void	setHeaderArgs(List<Map.Entry<String,String>> list) set values from Header into arguments.path(ARGS_HEADER)
void	setRequest(io.netty.handler.codec.http.HttpRequest request) Set values according to the request URI
void	setResult(io.netty.handler.codec.http.HttpResponseStatus status)
void	setXAuthRole(RoleDefault role)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RestArgument

public RestArgument(com.fasterxml.jackson.databind.node.ObjectNode emptyArgument)

Create a RestArgument

Parameters:

emptyArgument - might be null, but might be also already initialized with some values

Method Detail

clean

public final void clean()

Clean all internal values

setRequest

public final void setRequest(io.netty.handler.codec.http.HttpRequest request)

Set values according to the request URI

Parameters:

request -

setFromArgument

public final void setFromArgument(RestArgument source)

Set X_AUTH_USER, Method, Path, Basepath and Cookie from source

Parameters:

source -

getUri

public final String getUri()

Returns:

the full Path of the URI

getBaseUri

public final String getBaseUri()

Returns:

the base Path of the URI (first item between '/')

getSubUri

public final Iterator<com.fasterxml.jackson.databind.JsonNode> getSubUri()

Returns:

An iterator of JsonNode, which values can be retrieved by item.asText()

getSubUriSize

public final int getSubUriSize()

addSubUriToUriArgs

public final void addSubUriToUriArgs(String name,
                                     int rank)

addIdToUriArgs

public final void addIdToUriArgs()

getId

public final com.fasterxml.jackson.databind.JsonNode getId()

getId

public static com.fasterxml.jackson.databind.JsonNode getId(com.fasterxml.jackson.databind.node.ObjectNode node)

getLimitFromUri

public final long getLimitFromUri()

getXAuthKey

public final String getXAuthKey()

getXAuthUser

public final String getXAuthUser()

getXAuthTimestamp

public final String getXAuthTimestamp()

setXAuthRole

public final void setXAuthRole(RoleDefault role)

getXAuthRole

public final RoleDefault.ROLE getXAuthRole()

getUriArgs

public final com.fasterxml.jackson.databind.node.ObjectNode getUriArgs()

Returns:

The ObjectNode containing all couples key/value

getMethod

public final HttpRestHandler.METHOD getMethod()

Returns:

the method or null

setHeaderArgs

public final void setHeaderArgs(List<Map.Entry<String,String>> list)

set values from Header into arguments.path(ARGS_HEADER)

Throws:

HttpIncorrectRequestException

setHeaderArgs

public final void setHeaderArgs(Iterator<Map.Entry<CharSequence,CharSequence>> iterator)

set values from Header into arguments.path(ARGS_HEADER)

Throws:

HttpIncorrectRequestException

getHeaderArgs

public final com.fasterxml.jackson.databind.node.ObjectNode getHeaderArgs()

Returns:

The ObjectNode containing all couples key/value

methodFromUri

public final void methodFromUri()

set method From URI

methodFromHeader

public final void methodFromHeader()

set method From Header

setCookieArgs

public final void setCookieArgs(String cookieString)

set values from Cookies into arguments.path(ARGS_COOKIE)

getCookieArgs

public final com.fasterxml.jackson.databind.node.ObjectNode getCookieArgs()

Returns:

The ObjectNode containing all couples key/value

getBody

public final com.fasterxml.jackson.databind.node.ObjectNode getBody()

Returns:

The ObjectNode containing all couples key/value

getAnswer

public final com.fasterxml.jackson.databind.node.ObjectNode getAnswer()

Returns:

The ObjectNode containing all couples key/value

addAnswer

public final void addAnswer(com.fasterxml.jackson.databind.node.ObjectNode node)

setResult

public final void setResult(io.netty.handler.codec.http.HttpResponseStatus status)

getStatusCode

public final int getStatusCode()

Returns:

the Http Status code

getStatusMessage

public final String getStatusMessage()

Returns:

the Http Status message according to the Http Status code

setDetail

public final void setDetail(String detail)

getDetail

public final String getDetail()

Returns:

the detail information on error (mainly)

setCommand

public final void setCommand(DataModelRestMethodHandler.COMMAND_TYPE command)

setCommand

public final void setCommand(String cmd)

getCommandField

public final String getCommandField()

Returns:

the COMMAND field, to be transformed either into COMMAND_TYPE or ACTIONS_TYPE

getCommand

public final DataModelRestMethodHandler.COMMAND_TYPE getCommand()

Returns:

the COMMAND_TYPE but might be null if not found or if of ACTIONS_TYPE

addFilter

public final void addFilter(com.fasterxml.jackson.databind.node.ObjectNode filter)

Parameters:

filter - the filter used in multi get

getFilter

public final com.fasterxml.jackson.databind.node.ObjectNode getFilter()

Returns:

the filter used in multi get

getResults

public final com.fasterxml.jackson.databind.node.ArrayNode getResults()

Returns:

the array of results (in DataModel multi get)

addResult

public final void addResult(com.fasterxml.jackson.databind.node.ObjectNode result)

Parameters:

result - added to the array of results (in DataModel multi get)

addCountLimit

public final void addCountLimit(long count,
                                long limit)

Parameters:

count - added to answer if > 0

limit - added to answer

getCount

public final long getCount()

Returns:

the count of element (-1 if not found)

getLimit

public final long getLimit()

addOptions

public final void addOptions(String allow,
                             String path,
                             com.fasterxml.jackson.databind.node.ArrayNode detailedAllow)

Add options in answer

Parameters:

allow -

path -

detailedAllow -

getAllowOption

public final String getAllowOption()

getAllowUrisOption

public final String getAllowUrisOption()

getDetailedAllowOption

public final com.fasterxml.jackson.databind.node.ArrayNode getDetailedAllowOption()

getBaseAuthent

public static String[] getBaseAuthent(HmacSha256 hmacSha256,
                                      io.netty.handler.codec.http.QueryStringEncoder encoder,
                                      String user,
                                      String extraKey)
                               throws HttpInvalidAuthenticationException

The encoder is completed with extra necessary URI part containing ARG_X_AUTH_TIMESTAMP & ARG_X_AUTH_KEY

Parameters:

hmacSha256 - SHA-256 key to create the signature

encoder -

user - might be null

extraKey - might be null

Returns:

an array of 2 value in order ARG_X_AUTH_TIMESTAMP and ARG_X_AUTH_KEY

Throws:

HttpInvalidAuthenticationException - if the computation of the authentication failed

checkTime

public final void checkTime(long maxInterval)
                     throws HttpInvalidAuthenticationException

Check Time only (no signature)

Parameters:

maxInterval -

Throws:

HttpInvalidAuthenticationException

checkBaseAuthent

public final void checkBaseAuthent(HmacSha256 hmacSha256,
                                   String extraKey,
                                   long maxInterval)
                            throws HttpInvalidAuthenticationException

This implementation of authentication is as follow: if X_AUTH is included in the URI or Header
0) Check that timestamp is correct (|curtime - timestamp| < maxinterval) from ARG_X_AUTH_TIMESTAMP, if maxInterval is 0, not mandatory
1) Get all URI args (except ARG_X_AUTH_KEY itself, but including timestamp), lowered case, in alphabetic order
2) Add an extra Key if not null (from ARG_X_AUTH_INTERNALKEY)
3) Compute an hash (SHA-1 or SHA-256)
4) Compare this hash with ARG_X_AUTH_KEY

Parameters:

hmacSha256 - SHA-256 key to create the signature

extraKey - will be added as ARG_X_AUTH_INTERNALKEY might be null

maxInterval - ARG_X_AUTH_TIMESTAMP will be tested if value > 0

Throws:

HttpInvalidAuthenticationException - if the authentication failed

computeKey

protected static String computeKey(HmacSha256 hmacSha256,
                                   String extraKey,
                                   TreeMap<String,String> treeMap,
                                   String argPath)
                            throws HttpInvalidAuthenticationException

Parameters:

hmacSha256 - SHA-256 key to create the signature

extraKey - might be null

treeMap -

argPath -

Throws:

HttpInvalidAuthenticationException

toString

public String toString()

Overrides:

toString in class Object

prettyPrint

public final String prettyPrint()

fillDetailedAllow

public static com.fasterxml.jackson.databind.node.ObjectNode fillDetailedAllow(HttpRestHandler.METHOD method,
                                                                               String path,
                                                                               String command,
                                                                               com.fasterxml.jackson.databind.node.ObjectNode body,
                                                                               com.fasterxml.jackson.databind.JsonNode result)