oracle.wsc.feature.webrtc.template.restclient

Interface RestResult

All Superinterfaces:

ResponseMessage, Serializable

public interface RestResult
extends ResponseMessage

Result of the Rest Invocation.

Method Summary

Modifier and Type	Method and Description
Set<String>	getAllow() Get the allowed HTTP methods from the Allow HTTP header.
List<javax.ws.rs.core.NewCookie>	getCookies() Get the list of cookies.
javax.ws.rs.core.EntityTag	getEntityTag() Get the entity tag.
javax.ws.rs.core.MultivaluedMap<String,String>	getHeaders() Get the HTTP headers of the response.
String	getLanguage() Get the language.
Date	getLastModified() Get the last modified date.
int	getLength() Get Content-Length.
URI	getLocation() Get the location.
Date	getResponseDate() Get response date (server side).
int	getStatus() Get the status code.
boolean	hasEntity() Checks if there is an entity available.
Object	value() Get the resolved content of the REST invocation.

Methods inherited from interface oracle.wsc.feature.webrtc.template.future.ResponseMessage

getSipApplicationSessionId, getType, isError

Method Detail

value

Object value()
      throws ExecutionException,
             InterruptedException

Get the resolved content of the REST invocation.

If the content-type is text/plain, this method will return a String.

If the content-type is application/json, this method will return a parsed JSON using groovy.json.JsonSlurper.

If the content-type is application/xml, it will return a parsed XML using groovy.util.XmlSlurper.

Refer to Groovy api documentation for more information.

Returns:

the value synchronously.

Throws:

ExecutionException - If there is failure in execution of the invocation.

InterruptedException - If the asynchronous execution is interrupted.

getStatus

int getStatus()

Get the status code.

Returns:

the status code.

getHeaders

javax.ws.rs.core.MultivaluedMap<String,String> getHeaders()

Get the HTTP headers of the response.

Returns:

the HTTP headers of the response.

hasEntity

boolean hasEntity()

Checks if there is an entity available.

Returns:

true if there is an entity present in the response.

getLocation

URI getLocation()

Get the location.

Returns:

the location, otherwise null if not present.

getEntityTag

javax.ws.rs.core.EntityTag getEntityTag()

Get the entity tag.

Returns:

the entity tag, otherwise null if not present.

getLastModified

Date getLastModified()

Get the last modified date.

Returns:

the last modified date, otherwise null if not present.

getResponseDate

Date getResponseDate()

Get response date (server side).

Returns:

the server side response date, otherwise null if not present.

getLanguage

String getLanguage()

Get the language.

Returns:

the language, otherwise null if not present.

getLength

int getLength()

Get Content-Length.

Returns:

Content-Length as integer if present and valid number. In other cases returns -1.

getCookies

List<javax.ws.rs.core.NewCookie> getCookies()

Get the list of cookies.

Returns:

the cookies.

getAllow

Set<String> getAllow()

Get the allowed HTTP methods from the Allow HTTP header.

Note that the Allow HTTP header will be returned from an OPTIONS request.

Returns:

the allowed HTTP methods, all methods will returned as upper case strings.