Package com.aquima.interactions.communication.impl

Class RestRequestMessage

java.lang.Object

com.aquima.interactions.communication.impl.RestMessage

com.aquima.interactions.communication.impl.RestRequestMessage

All Implemented Interfaces:

IRestMessage, IRestRequestMessage, Serializable

public final class RestRequestMessage
extends RestMessage
implements IRestRequestMessage

Rest request message implementation.

Since:

9.0

Author:

Arjan Pragt

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RestRequestMessage(HttpMethodType httpMethod, String path, MultiValueMap arguments, RestMessage message)
RestRequestMessage(HttpMethodType httpMethod, String path, MultiValueMap arguments, MultiValueMap headers, String body)
RestRequestMessage(HttpMethodType httpMethod, String path, MultiValueMap arguments, MultiValueMap headers, String body, boolean validated)

Method Summary

Modifier and Type	Method	Description
void	addArguments(String name, String value)
String[]	getArgumentNames()	This method returns the argument names for this request message.
MultiValueMap	getArguments()
String[]	getArgumentValues(String name)	This method returns the argument values for the requested name.
HttpMethodType	getHttpMethod()	This method returns the http method for this request message.
String	getPath()	This method returns the path for this request message.
boolean	hasArgument(String name)	This method returns if the request message contains an argument.
boolean	isValidated()	This method returns whether the attributes should be validated after the rest request message is parsed

Methods inherited from class com.aquima.interactions.communication.impl.RestMessage

getAcceptType, getBody, getContentType, getHeaderNames, getHeaders, getHeaderValues, getSingleHeaderValue, setAcceptType, setBody, setContentType, setHeaders, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.communication.IRestMessage

getBody, getContentType, getHeaderNames, getHeaderValues

Methods inherited from interface com.aquima.interactions.communication.IRestRequestMessage

getAcceptType

Constructor Details

RestRequestMessage

public RestRequestMessage(HttpMethodType httpMethod,
 String path,
 MultiValueMap arguments,
 MultiValueMap headers,
 String body,
 boolean validated)

RestRequestMessage

public RestRequestMessage(HttpMethodType httpMethod,
 String path,
 MultiValueMap arguments,
 RestMessage message)

RestRequestMessage

public RestRequestMessage(HttpMethodType httpMethod,
 String path,
 MultiValueMap arguments,
 MultiValueMap headers,
 String body)

Method Details

getHttpMethod

public HttpMethodType getHttpMethod()

Description copied from interface: IRestRequestMessage

This method returns the http method for this request message.

Specified by:

getHttpMethod in interface IRestRequestMessage

Returns:

The request method, never null.

getPath

public String getPath()

Description copied from interface: IRestRequestMessage

This method returns the path for this request message.

Specified by:

getPath in interface IRestRequestMessage

Returns:

The path, may be null.

getArguments

public MultiValueMap getArguments()

addArguments

public void addArguments(String name,
 String value)

getArgumentNames

public String[] getArgumentNames()

Description copied from interface: IRestRequestMessage

This method returns the argument names for this request message.

Specified by:

getArgumentNames in interface IRestRequestMessage

Returns:

The argument names, never null, but may be an empty array.

hasArgument

public boolean hasArgument(String name)

Description copied from interface: IRestRequestMessage

This method returns if the request message contains an argument.

Specified by:

hasArgument in interface IRestRequestMessage

Parameters:

name - the name of the argument

Returns:

If the request message contains the argument.

getArgumentValues

public String[] getArgumentValues(String name)

Description copied from interface: IRestRequestMessage

This method returns the argument values for the requested name.

Specified by:

getArgumentValues in interface IRestRequestMessage

Parameters:

name - the name of the argument

Returns:

The argument values, may be null.

isValidated

public boolean isValidated()

Description copied from interface: IRestRequestMessage

This method returns whether the attributes should be validated after the rest request message is parsed

Specified by:

isValidated in interface IRestRequestMessage

Returns:

if the attributes should be validated after the rest request message is parsed