oracle.maf.api.dc.ws.rest

Interface RestServiceAdapter

public interface RestServiceAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_TYPE_DELETE
static String	REQUEST_TYPE_GET
static String	REQUEST_TYPE_POST
static String	REQUEST_TYPE_PUT

Method Summary

Modifier and Type	Method and Description
void	addRequestProperty(String key, String value) Add request property to the request header.
void	clearRequestProperties() Clear all previously set request properties.
void	close(javax.microedition.io.HttpConnection connection) Close the provided connection.
String	getConnectionEndPoint(String connName) Return the end point of the connection, for the specified connection name, found in connections.xml.
String	getConnectionName() Set the connection name (referenced in connections.xml) that REST requests should be directed to.
javax.microedition.io.HttpConnection	getHttpConnection(String requestMethod, String request, Object httpHeadersValue) Initializes and returns an HttpConnection, using the provided request method, request, and HTTP headers value.
String	getHttpStatusMessage(int httpStatusCode)
java.io.InputStream	getInputStream(javax.microedition.io.HttpConnection connection) Open and return an input stream for the provided connection.
java.io.OutputStream	getOutputStream(javax.microedition.io.HttpConnection connection) Open and return an output stream for the provided connection.
String	getRequestMethod()
java.util.Map<String,String>	getRequestProperties()
String	getRequestURI()
String	getResponseContentType() Retrieve the content type of the response
String	getResponseHeader(String key) Retrieve response header.
java.util.Map<String,String>	getResponseHeaders()
String	getResponseMessage()
int	getResponseStatus()
int	getRetryLimit()
boolean	isGenerateAnalyticsEvents()
void	removeRequestProperty(String key) Remove a request property from the request header.
String	send(String payload) Send the REST request with the given payload
byte[]	sendReceive(String payload) Send the REST request with the given payload
java.io.InputStream	sendRequest(String payload) Send a REST request with the given payload.
void	setConnectionName(String name) Set the connection name (referenced in connections.xml) that REST requests should be directed to.
void	setGenerateAnalyticsEvents(boolean value) Set the boolean value for indicating whether Analytics should be logged for a webservice call
void	setRequestMethod(String method) Set the request method for the REST call.
void	setRequestURI(String uri) Set the additional request URI
void	setRetryLimit(int retries) Set the maximum retries any request should attempt before determining the request will not succeed.

Field Detail

REQUEST_TYPE_GET

static final String REQUEST_TYPE_GET

See Also:

Constant Field Values

REQUEST_TYPE_POST

static final String REQUEST_TYPE_POST

See Also:

Constant Field Values

REQUEST_TYPE_PUT

static final String REQUEST_TYPE_PUT

See Also:

Constant Field Values

REQUEST_TYPE_DELETE

static final String REQUEST_TYPE_DELETE

See Also:

Constant Field Values

Method Detail

addRequestProperty

void addRequestProperty(String key,
                        String value)

Add request property to the request header.

Parameters:

key - must not be null.

value - must not be null.

clearRequestProperties

void clearRequestProperties()

Clear all previously set request properties.

removeRequestProperty

void removeRequestProperty(String key)

Remove a request property from the request header.

Parameters:

key - must not be null.

getRequestProperties

java.util.Map<String,String> getRequestProperties()

Returns:

an unmodifiable map of all the previously set request properties.

getResponseHeader

String getResponseHeader(String key)

Retrieve response header.

Parameters:

key - must not be null.

Returns:

the value of this response header, or null if the key does not exist.

getResponseHeaders

java.util.Map<String,String> getResponseHeaders()

Returns:

an unmodifiable map of all the response headers.

setRequestMethod

void setRequestMethod(String method)

Set the request method for the REST call.

Parameters:

method - should be either GET, POST, PUT, or DELETE

getRequestMethod

String getRequestMethod()

Returns:

either GET, POST, PUT, or DELETE.

getRetryLimit

int getRetryLimit()

Returns:

the maximum retries any request should attempt before determining the request will not succeed.

setRetryLimit

void setRetryLimit(int retries)

Set the maximum retries any request should attempt before determining the request will not succeed.

Parameters:

retries -

getConnectionName

String getConnectionName()

Set the connection name (referenced in connections.xml) that REST requests should be directed to.

Returns:

the connection name (referenced in connections.xml) that requests should be directed to

setConnectionName

void setConnectionName(String name)

Set the connection name (referenced in connections.xml) that REST requests should be directed to.

Parameters:

name -

send

String send(String payload)
     throws java.io.IOException

Send the REST request with the given payload

Parameters:

payload -

Returns:

the response as a string

Throws:

java.io.IOException

See Also:

RestWebServiceOperation.invoke(java.lang.String, java.util.Map)

sendReceive

byte[] sendReceive(String payload)
            throws java.io.IOException

Send the REST request with the given payload

Parameters:

payload -

Returns:

the response as a byte[]

Throws:

java.io.IOException

See Also:

RestWebServiceOperation.invoke(java.lang.String, java.util.Map)

sendRequest

java.io.InputStream sendRequest(String payload)
                         throws java.io.IOException

Send a REST request with the given payload. The response stream returned from the server may be chunked. The stream reader can handle the chunking itself or use the ChunkedInputStreamclass to read the stream.

See .6.1

Parameters:

payload - the payload to send to the server.

Returns:

input stream containing the response payload.

Throws:

java.io.IOException

getHttpConnection

javax.microedition.io.HttpConnection getHttpConnection(String requestMethod,
                                                       String request,
                                                       Object httpHeadersValue)
                                                throws java.io.IOException

Initializes and returns an HttpConnection, using the provided request method, request, and HTTP headers value. This also injects basic authentication into the request headers, from the credential store.

 
  // Create an instance of a RestServiceAdapter
  RestServiceAdapter restServiceAdapter = Model.createRestServiceAdapter();

  // Clear any previously set request properties, if any
  restServiceAdapter.clearRequestProperties();

  // Specify the type of request
  String requestMethod = RestServiceAdapter.REQUEST_TYPE_GET;

  // Get the connection end point from connections.xml
  String requestEndPoint = restServiceAdapter.getConnectionEndPoint("GeoIP");

  // Get the URI which is defined after the end point
  String requestURI = "/xml/" + someIpAddress;

  // The request is the end point + the URI being set
  String request = requestEndPoint + requestURI;

  // Specify some custom request headers
  HashMap httpHeadersValue = new HashMap();
  httpHeadersValue.put("Accept-Language", "en-US");
  httpHeadersValue.put("My-Custom-Header-Item", "CustomItem1");

  // Get the connection
  HttpConnection connection = restServiceAdapter.getHttpConnection(requestMethod, request, httpHeadersValue);
 
 

Parameters:

requestMethod - should be either GET, POST, PUT, or DELETE

request - the fully qualified request (end point + request URI)

httpHeadersValue - An Object that implements the Map interface. Its key/value pairs are assigned as request properties to the returned connection.

Returns:

the connection

Throws:

java.io.IOException

See Also:

HttpConnection

getOutputStream

java.io.OutputStream getOutputStream(javax.microedition.io.HttpConnection connection)
                              throws java.io.IOException

Open and return an output stream for the provided connection. Use this to stream your request from your application.

Parameters:

connection -

Returns:

the output stream for the connection

Throws:

Exception

java.io.IOException

See Also:

HttpConnection

getInputStream

java.io.InputStream getInputStream(javax.microedition.io.HttpConnection connection)
                            throws java.io.IOException

Open and return an input stream for the provided connection. Use this to stream the result into your application. Use the HttpConnection getResponseStatus to determine the status of the request. The request status, response headers, and response content type are stored in this rest service adapter. If the response status is "OK" (200), the cookies in the cookie store will be updated from the contents of "Set-Cookie" in the response headers.

Parameters:

connection -

Returns:

the input stream for the connection

Throws:

java.io.IOException

See Also:

HttpConnection

close

void close(javax.microedition.io.HttpConnection connection)

Close the provided connection. Call this when using streams to send a REST request, or receive a REST response, with a custom payload.

Parameters:

connection -

See Also:

HttpConnection

getConnectionEndPoint

String getConnectionEndPoint(String connName)

Return the end point of the connection, for the specified connection name, found in connections.xml. Also, apply the connection's credential store key, if any, to this rest service adapter.

Parameters:

connName - the connection name of the connection to find in connections.xml

Returns:

the end point of the connection

getResponseStatus

int getResponseStatus()

Returns:

the response status corresponding to the last response received

getHttpStatusMessage

String getHttpStatusMessage(int httpStatusCode)

Parameters:

httpStatusCode - a HTTP status code.

Returns:

a customized/translated message string for the status code.

getResponseMessage

String getResponseMessage()

Returns:

the response message corresponding to the last response received.

getResponseContentType

String getResponseContentType()

Retrieve the content type of the response

Returns:

the response content type

setRequestURI

void setRequestURI(String uri)

Set the additional request URI

Parameters:

uri -

getRequestURI

String getRequestURI()

Returns:

the additional request URI

setGenerateAnalyticsEvents

void setGenerateAnalyticsEvents(boolean value)

Set the boolean value for indicating whether Analytics should be logged for a webservice call

Parameters:

true- - if analytics should be generated for the webservice call false- If analytics should be suppressed for the webservice call

isGenerateAnalyticsEvents

boolean isGenerateAnalyticsEvents()

Returns:

boolean value true - If analytics should be generated for the webservice call false - If anlaytics should be suppressed for the webservice call