com.softwareag.mobile.runtime.toolkit.rest

Class AbstractRestOperation

java.lang.Object

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

public abstract class AbstractRestOperation
extends java.lang.Object

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 IServiceDelegate'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 and POST calls. To mark the operation as a POST, set the data to be sent by using postData.

Version:

9.6.0.0000-0237

Constructor Summary

Constructors

Constructor and Description
AbstractRestOperation()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeaderParameter(java.lang.String name, java.lang.String value) Adds a parameter to the HTTP header.
void	addHeaderParameter(java.lang.String name, java.lang.String[] values) Adds a header parameter with multiple values.
void	addQueryParameter(java.lang.String name, java.lang.String[] values) Adds a new query parameter with multiple values.
void	addServiceDelegate(IServiceDelegate delegate) Adds a new IServiceDelegate to watch the state of this operation.
byte[]	getByteResult() Returns the result of this operation as an byte array.
java.lang.String[]	getCookies() Returns all cookies sent by the server after a successfully communication.
java.lang.String[]	getHeader() Returns the header parameters.
int	getResponseCode() Returns the response code of the underlying HttpConnection.
java.lang.String	getResult() Returns the result of this operation as a String.
java.lang.String	getResult(java.lang.String encoding) Returns the result of this operation as a String by passing an encoding.
java.lang.String	getUrl() Returns the used URL in combination with all query parameters.
void	removeServiceDelegate(IServiceDelegate delegate) Removes the delivered IServiceDelegate.
void	setUrl(java.lang.String url) Sets the url.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRestOperation

public AbstractRestOperation()

Method Detail

addQueryParameter

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

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

addHeaderParameter

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

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

Parameters:

name - of the parameter

values - must not be null

See Also:

addHeaderParameter(String, String)

addHeaderParameter

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

Adds a parameter to the HTTP header.

Parameters:

name -

value -

getUrl

public final java.lang.String getUrl()

Returns the used URL in combination with all query parameters.

Returns:

setUrl

public final 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 -

addServiceDelegate

public final void addServiceDelegate(IServiceDelegate delegate)

Adds a new IServiceDelegate to watch the state of this operation.

Parameters:

delegate -

removeServiceDelegate

public final void removeServiceDelegate(IServiceDelegate delegate)

Removes the delivered IServiceDelegate.

Parameters:

delegate -

getResponseCode

public final int getResponseCode()

Returns the response code of the underlying HttpConnection.

Returns:

getHeader

public final java.lang.String[] getHeader()

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

Returns:

getCookies

public final java.lang.String[] getCookies()

Returns all cookies sent by the server after a successfully communication.

Returns:

getResult

public final java.lang.String getResult()

Returns the result of this operation as a String.
This method uses the default encoding. If a another encoding is required, see getResult(String).

Returns:

See Also:

getResult(String), getByteResult()

getResult

public final java.lang.String getResult(java.lang.String encoding)
                                 throws java.io.UnsupportedEncodingException

Returns the result of this operation as a String by passing an encoding.
Throws a UnsupportedEncodingException if the delivered encoding is invalid.

Parameters:

encoding -

Returns:

Throws:

java.io.UnsupportedEncodingException

getByteResult

public final byte[] getByteResult()

Returns the result of this operation as an byte array.

Returns: