me.adaptive.arp.api

Class ServiceResponse

java.lang.Object

me.adaptive.arp.api.APIBean

me.adaptive.arp.api.ServiceResponse

public class ServiceResponse
extends APIBean

Represents a local or remote service response.

Since:

v2.0

Constructor Summary

Constructors

Constructor and Description
ServiceResponse() Default constructor.
ServiceResponse(java.lang.String content, java.lang.String contentType, IServiceContentEncoding contentEncoding, int contentLength, ServiceHeader[] serviceHeaders, ServiceSession serviceSession, int statusCode) Constructor with fields

Method Summary

Modifier and Type	Method and Description
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
ServiceHeader[]	getServiceHeaders() Returns the array of ServiceHeader
ServiceSession	getServiceSession() Getter for service session
int	getStatusCode() Returns the status code of the response.
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	setServiceHeaders(ServiceHeader[] serviceHeaders) Set the array of ServiceHeader
void	setServiceSession(ServiceSession serviceSession) Setter for service session
void	setStatusCode(int statusCode) Sets the status code of the response

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceResponse

public ServiceResponse()

Default constructor.

Since:

v2.0

ServiceResponse

public ServiceResponse(java.lang.String content,
                       java.lang.String contentType,
                       IServiceContentEncoding contentEncoding,
                       int contentLength,
                       ServiceHeader[] serviceHeaders,
                       ServiceSession serviceSession,
                       int statusCode)

Constructor with fields

Parameters:

content - Request/Response data content (plain text).

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

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

contentLength - The length in bytes for the Content field.

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

serviceSession - Information about the session

statusCode - HTTP Status code of the response.

Since:

v2.0

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

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

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

getStatusCode

public int getStatusCode()

Returns the status code of the response.

Returns:

HTTP status code

Since:

v2.1.4

setStatusCode

public void setStatusCode(int statusCode)

Sets the status code of the response

Parameters:

statusCode - HTTP status code

Since:

v2.1.4