com.softwareag.mobile.runtime.toolkit.rest

Class AbstractRestOperation

java.lang.Object

com.softwareag.mobile.runtime.toolkit.operations.AbstractSynchronizableOperation

com.softwareag.mobile.runtime.toolkit.rest.AbstractRestOperation

All Implemented Interfaces:

com.softwareag.mobile.runtime.comms.IConnectionCallback, IOperation

Direct Known Subclasses:

AbstractMultipartRestOperation, AbstractVirtualOperation

public class AbstractRestOperation
extends AbstractSynchronizableOperation
implements com.softwareag.mobile.runtime.comms.IConnectionCallback

The AbstractRestOperation is an thread save, derivable abstraction for remote communication using Representational state transfer (REST).

This class contains the necessary implementation to establish the connection to the remote host. Clients can register one ore more IOperationDelegate's to listen to the operations state.
By extending, clients need to set the URL by using setUrl(String). The connection can be parameterized using query ( addQueryParameter(String, String) or header addHeaderParameter(String, String) parameters.

The MD HTTP connection layer supports GET, POST, PUT and DELETE calls. Clients have to overwrite getHTTPMethod() or use setHttpMethod(String) to change the default HTTP method.

The AbstractRestOperation enables automatic HTTP Basic authentication if the Credentials are set in the Session for the calling URL. This behavior can be changed by overwriting applyCredentials().

Version:

10.3.0.0004-0525

Field Summary

Fields inherited from class com.softwareag.mobile.runtime.toolkit.operations.AbstractSynchronizableOperation

OPERATION_FAILED, OPERATION_SUCCESSFUL

Constructor Summary

Constructors

Constructor and Description
AbstractRestOperation() Create a GET operation
AbstractRestOperation(java.lang.String url) Create a GET operation for the given URL
AbstractRestOperation(java.lang.String httpMethod, java.lang.String url) Create a REST operation for the given URL with the given REST method.

Method Summary

Modifier and Type	Method and Description
void	addHeaderParameter(java.lang.String name, java.lang.String value) see addHeaderParameter(String, String, boolean) where urlEncode is set to false
void	addHeaderParameter(java.lang.String name, java.lang.String[] values) see addHeaderParameter(String, String[], boolean) where urlEncode is set to false
void	addHeaderParameter(java.lang.String name, java.lang.String[] values, boolean urlEncode) Adds a header parameter with multiple values.
void	addHeaderParameter(java.lang.String name, java.lang.String value, boolean urlEncode) Adds a parameter to the HTTP header.
void	addQueryParameter(java.lang.String key, java.lang.String value) see addQueryParameter(String, String, boolean) where urlEncode is set to false
void	addQueryParameter(java.lang.String name, java.lang.String[] values) see addQueryParameter(String, String[], boolean) where urlEncode is set to false
void	addQueryParameter(java.lang.String name, java.lang.String[] values, boolean urlEncode) Adds a new query parameter with multiple values. Delegates to addQueryParameter(String, String).
void	addQueryParameter(java.lang.String key, java.lang.String value, boolean urlEncode) Adds a query parameter with a single value.
void	execute() Executes this operation.
java.lang.String[]	getHeader() Returns the header parameters.
java.util.Hashtable	getHeaderParameters() Returns all header parameters used for the request.
java.lang.String	getHTTPMethod() Returns the HTTP method used for this operation.
com.softwareag.mobile.runtime.comms.HttpResponse	getHttpResponse()
byte[]	getPostData() Returns the set post data payload as a byte array.
java.util.Hashtable	getQueryParameters() Returns all query parameters used for the request.
java.lang.String	getUrl() Returns the used URL in combination with all query parameters.
boolean	isExecuteAsynchronous()
boolean	isFollowingRedirects()
void	onResponse(com.softwareag.mobile.runtime.comms.HttpResponse response) This method will be called when a response is available.
void	reset() Resets the request and it's properties to it's initial state.
void	setExecuteAsynchronous(boolean async)
void	setFollowRedirects(boolean followRedirects)
void	setHttpMethod(java.lang.String httpMethod) Sets the HTTP method used for this operation.
void	setPostData(byte[] postData) Sets the data if POST or PUT is required.
void	setPostData(java.lang.String postData) Sets the data if POST or PUT is required.
void	setResponse(com.softwareag.mobile.runtime.comms.HttpResponse resp)
void	setUrl(java.lang.String url) Sets the url. This method sets only the URL and must not be used to set query parameters.
java.lang.String	toString()

Methods inherited from class com.softwareag.mobile.runtime.toolkit.operations.AbstractSynchronizableOperation

addOperationDelegate, getOperationDelegates, getResponse, removeOperationDelegate, setCacheHandler, setResponse

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractRestOperation

public AbstractRestOperation()

Create a GET operation

AbstractRestOperation

public AbstractRestOperation(java.lang.String url)

Create a GET operation for the given URL

AbstractRestOperation

public AbstractRestOperation(java.lang.String httpMethod,
                             java.lang.String url)

Create a REST operation for the given URL with the given REST method.

Method Detail

execute

public void execute()

Description copied from interface: IOperation

Executes this operation.

Specified by:

execute in interface IOperation

Overrides:

execute in class AbstractSynchronizableOperation

setResponse

public void setResponse(com.softwareag.mobile.runtime.comms.HttpResponse resp)

getHttpResponse

public com.softwareag.mobile.runtime.comms.HttpResponse getHttpResponse()

onResponse

public void onResponse(com.softwareag.mobile.runtime.comms.HttpResponse response)

Description copied from interface: com.softwareag.mobile.runtime.comms.IConnectionCallback

This method will be called when a response is available.

Specified by:

onResponse in interface com.softwareag.mobile.runtime.comms.IConnectionCallback

Parameters:

response - - data received from server.

reset

public void reset()

Resets the request and it's properties to it's initial state.

addQueryParameter

public final void addQueryParameter(java.lang.String name,
                                    java.lang.String[] values,
                                    boolean urlEncode)

Adds a new query parameter with multiple values.
Delegates to addQueryParameter(String, String).

Parameters:

name - of the parameter

values - all values for this parameter, must not be null

urlEncode - if true: the value will be URL-Encoded

addQueryParameter

public final void addQueryParameter(java.lang.String name,
                                    java.lang.String[] values)

see addQueryParameter(String, String[], boolean) where urlEncode is set to false

addQueryParameter

public final void addQueryParameter(java.lang.String key,
                                    java.lang.String value,
                                    boolean urlEncode)

Adds a query parameter with a single value.
Query parameters are added to the end of the URL using the following syntax:

 http://host:port?key=value&key2=value
 

Parameters:

key - the key of the parameter

value - the value of the parameter

urlEncode - if true: the value will be URL-Encoded

addQueryParameter

public final void addQueryParameter(java.lang.String key,
                                    java.lang.String value)

see addQueryParameter(String, String, boolean) where urlEncode is set to false

getQueryParameters

public java.util.Hashtable getQueryParameters()

Returns all query parameters used for the request.

getPostData

public byte[] getPostData()

Returns the set post data payload as a byte array.

addHeaderParameter

public void addHeaderParameter(java.lang.String name,
                               java.lang.String[] values,
                               boolean urlEncode)

Adds a header parameter with multiple values.
Delegates to addHeaderParameter(String, String).

Parameters:

name - the name of the parameter

values - the values of the parameter; must not be null

urlEncode - if true: the values will be URL-Encoded

See Also:

addHeaderParameter(String, String)

addHeaderParameter

public void addHeaderParameter(java.lang.String name,
                               java.lang.String[] values)

see addHeaderParameter(String, String[], boolean) where urlEncode is set to false

addHeaderParameter

public void addHeaderParameter(java.lang.String name,
                               java.lang.String value,
                               boolean urlEncode)

Adds a parameter to the HTTP header.

Parameters:

name - the name of the parameter

value - the value of the parameter

urlEncode - if true: the value will be URL-Encoded

addHeaderParameter

public void addHeaderParameter(java.lang.String name,
                               java.lang.String value)

see addHeaderParameter(String, String, boolean) where urlEncode is set to false

getHeaderParameters

public java.util.Hashtable getHeaderParameters()

Returns all header parameters used for the request.

getUrl

public java.lang.String getUrl()

Returns the used URL in combination with all query parameters.

setUrl

public void setUrl(java.lang.String url)

Sets the url.
This method sets only the URL and must not be used to set query parameters. For adding query parameters, please see addQueryParameter(String, String).

getHeader

public java.lang.String[] getHeader()

Returns the header parameters.
Should be used to access cookies and header parameters after a successfully communication.

setPostData

public void setPostData(byte[] postData)

Sets the data if POST or PUT is required.

Parameters:

postData - the data (as String) that should be sent

setPostData

public void setPostData(java.lang.String postData)

Sets the data if POST or PUT is required.

Parameters:

postData - the data (as byte[]) that should be sent

getHTTPMethod

public java.lang.String getHTTPMethod()

Returns the HTTP method used for this operation. Client may overwrite this method or use setHttpMethod(String) to change the HTTP method name.

Defaults to Connection.METHOD_GET.

Supported types are (listed in Connection):

• Connection.METHOD_GET
• Connection.METHOD_POST
• Connection.METHOD_PUT
• Connection.METHOD_DELETE
• Connection.METHOD_HEAD

setHttpMethod

public void setHttpMethod(java.lang.String httpMethod)

Sets the HTTP method used for this operation. Clients can also overwrite getHTTPMethod().

Supported types are (listed in Connection), see getHTTPMethod() for details.

setFollowRedirects

public void setFollowRedirects(boolean followRedirects)

isFollowingRedirects

public boolean isFollowingRedirects()

setExecuteAsynchronous

public void setExecuteAsynchronous(boolean async)

isExecuteAsynchronous

public boolean isExecuteAsynchronous()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object