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:

IOperation

Direct Known Subclasses:

AbstractMultipartRestOperation

public abstract class AbstractRestOperation
extends AbstractSynchronizableOperation
implements IOperation

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() 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:

9.12.0.0000-0266

Constructor Summary

Constructors

Constructor and Description
AbstractRestOperation()

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.
java.lang.String[]	getHeader() Returns the header parameters.
java.util.Hashtable	getHeaderParameters() Returns all header parameters used for the request.
int	getHTTPMethod() Returns the HTTP method used for this operation.
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.
void	reset() Resets the request and it's properties to it's initial state.
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	setUrl(java.lang.String url) Sets the url. This method sets only the URL and must not be used to set query parameters.

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

addOperationDelegate, execute, getRawResult, getResult, getResult, getResultCode, removeOperationDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.softwareag.mobile.runtime.toolkit.operations.IOperation

addOperationDelegate, execute, getRawResult, getResult, getResult, getResultCode, removeOperationDelegate

Constructor Detail

AbstractRestOperation

public AbstractRestOperation()

Method Detail

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 -

value -

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.

Returns:

getPostData

public byte[] getPostData()

Returns the set post data payload as a byte array.

Returns:

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 - of the parameter

values - must not be null

urlEncode - if true: the value 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 -

value -

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.

Returns:

getUrl

public java.lang.String getUrl()

Returns the used URL in combination with all query parameters.

Returns:

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).

Parameters:

url -

getHeader

public java.lang.String[] getHeader()

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

Returns:

setPostData

public void setPostData(byte[] postData)

Sets the data if POST or PUT is required.

Parameters:

postData - as String

setPostData

public void setPostData(java.lang.String postData)

Sets the data if POST or PUT is required.

Parameters:

postData - as byte array

getHTTPMethod

public int getHTTPMethod()

Returns the HTTP method used for this operation. Client may overwrite this method to change the HTTP method name. Defaults to HttpConnectionHandler.ACTION_GET.

Supported types are (listed in HttpConnectionHandler):

• HttpConnectionHandler.ACTION_GET
• HttpConnectionHandler.ACTION_POST
• HttpConnectionHandler.ACTION_PUT
• HttpConnectionHandler.ACTION_DELETE

Returns: