me.adaptive.arp.api

Class ServiceRequest

java.lang.Object

me.adaptive.arp.api.APIBean

me.adaptive.arp.api.ServiceRequest

public class ServiceRequest
extends APIBean

Represents a local or remote service request.

Since:

v2.0

Constructor Summary

Constructors

Constructor and Description
ServiceRequest() Default constructor.
ServiceRequest(java.lang.String content, ServiceToken serviceToken) Convenience constructor.

Method Summary

Modifier and Type	Method and Description
ServiceRequestParameter[]	getBodyParameters() Gets the body parameters of the request.
java.lang.String	getContent() Returns the content
IServiceContentEncoding	getContentEncoding() Returns the content encoding
int	getContentLength() Returns the content length
java.lang.String	getContentType() Returns the content type
ServiceRequestParameter[]	getQueryParameters() Gets the query parameters of the request.
java.lang.String	getRefererHost() Returns the referer host (origin) of the request.
ServiceHeader[]	getServiceHeaders() Returns the array of ServiceHeader
ServiceSession	getServiceSession() Getter for service session
ServiceToken	getServiceToken() Gets the ServiceToken of the request.
java.lang.String	getUserAgent() Gets the overridden user-agent string.
void	setBodyParameters(ServiceRequestParameter[] bodyParameters) Sets the body parameters of the request.
void	setContent(java.lang.String content) Set the content
void	setContentEncoding(IServiceContentEncoding contentEncoding) Set the content encoding
void	setContentLength(int contentLength) Set the content length
void	setContentType(java.lang.String contentType) Set the content type
void	setQueryParameters(ServiceRequestParameter[] queryParameters) Sets the query parameters of the request.
void	setRefererHost(java.lang.String refererHost) Sets the value for the referer host of the request.
void	setServiceHeaders(ServiceHeader[] serviceHeaders) Set the array of ServiceHeader
void	setServiceSession(ServiceSession serviceSession) Setter for service session
void	setServiceToken(ServiceToken serviceToken) Sets the ServiceToken of the request.
void	setUserAgent(java.lang.String userAgent) Sets the user-agent to override the default user-agent string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceRequest

public ServiceRequest()

Default constructor.

Since:

v2.0

ServiceRequest

public ServiceRequest(java.lang.String content,
                      ServiceToken serviceToken)

Convenience constructor.

Parameters:

content - Content payload.

serviceToken - ServiceToken for the request.

Since:

v2.0.6

Method Detail

getContentEncoding

public IServiceContentEncoding getContentEncoding()

Returns the content encoding

Returns:

contentEncoding

Since:

v2.0

setContentEncoding

public void setContentEncoding(IServiceContentEncoding contentEncoding)

Set the content encoding

Parameters:

contentEncoding - Encoding of the binary payload - by default assumed to be UTF8.

Since:

v2.0

getBodyParameters

public ServiceRequestParameter[] getBodyParameters()

Gets the body parameters of the request.

Returns:

ServiceRequestParameter array or null if none are specified.

Since:

v2.0.6

setBodyParameters

public void setBodyParameters(ServiceRequestParameter[] bodyParameters)

Sets the body parameters of the request.

Parameters:

bodyParameters - ServiceRequestParameter array or null if none are specified.

Since:

v2.0.6

getContent

public java.lang.String getContent()

Returns the content

Returns:

content

Since:

v2.0

setContent

public void setContent(java.lang.String content)

Set the content

Parameters:

content - Request/Response data content (plain text)

Since:

v2.0

getContentLength

public int getContentLength()

Returns the content length

Returns:

contentLength

Since:

v2.0

setContentLength

public void setContentLength(int contentLength)

Set the content length

Parameters:

contentLength - The length in bytes for the Content field.

Since:

v2.0

getContentType

public java.lang.String getContentType()

Returns the content type

Returns:

contentType

Since:

v2.0

setContentType

public void setContentType(java.lang.String contentType)

Set the content type

Parameters:

contentType - The request/response content type (MIME TYPE).

Since:

v2.0

getQueryParameters

public ServiceRequestParameter[] getQueryParameters()

Gets the query parameters of the request.

Returns:

ServiceRequestParameter array or null if none are specified.

Since:

v2.0.6

setQueryParameters

public void setQueryParameters(ServiceRequestParameter[] queryParameters)

Sets the query parameters of the request.

Parameters:

queryParameters - ServiceRequestParameter array or null if none are specified.

Since:

v2.0.6

getRefererHost

public java.lang.String getRefererHost()

Returns the referer host (origin) of the request.

Returns:

Referer host of the request

Since:

v2.1.4

setRefererHost

public void setRefererHost(java.lang.String refererHost)

Sets the value for the referer host of the request.

Parameters:

refererHost - Referer host of the request

Since:

v2.1.4

getServiceHeaders

public ServiceHeader[] getServiceHeaders()

Returns the array of ServiceHeader

Returns:

serviceHeaders

Since:

v2.0

setServiceHeaders

public void setServiceHeaders(ServiceHeader[] serviceHeaders)

Set the array of ServiceHeader

Parameters:

serviceHeaders - The serviceHeaders array (name,value pairs) to be included on the I/O service request.

Since:

v2.0

getServiceSession

public ServiceSession getServiceSession()

Getter for service session

Returns:

The element service session

Since:

v2.0

setServiceSession

public void setServiceSession(ServiceSession serviceSession)

Setter for service session

Parameters:

serviceSession - The element service session

Since:

v2.0

getServiceToken

public ServiceToken getServiceToken()

Gets the ServiceToken of the request.

Returns:

ServiceToken.

Since:

v2.0.6

setServiceToken

public void setServiceToken(ServiceToken serviceToken)

Sets the ServiceToken of the request.

Parameters:

serviceToken - ServiceToken to be used for the invocation.

Since:

v2.0.6

getUserAgent

public java.lang.String getUserAgent()

Gets the overridden user-agent string.

Returns:

User-agent string.

Since:

v2.0.6

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Sets the user-agent to override the default user-agent string.

Parameters:

userAgent - User-agent string.

Since:

v2.0.6