oracle.wsc.feature.webrtc.template.restclient

Interface RestRequest

All Superinterfaces:

Serializable, WscMessage

public interface RestRequest
extends WscMessage

Represents the request in a REST client invocation.

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value) Add an arbitrary header.
RestFuture	send() Marks the message as ready to send.
RestFuture	send(Object entity, RestMediaType mediaType) Trigger the REST request invocation.
void	setAccept(RestMediaType... mediaTypes) Set the media types used in the invocation.
void	setAcceptLanguage(String... locales) Add acceptable languages used in the invocation.
void	setCredentials(String userName, byte[] password) Set basic auth username and password.
void	setDigestCredentials(String userName, byte[] password) Set digest auth username and password.
void	setEntity(Object entity, RestMediaType mediaType) Set the request entity for POST and PUT.
void	setStackConfiguration(String name, Object value) Add a property supported by underlying REST stack implementation.

Method Detail

send

RestFuture send(Object entity,
                RestMediaType mediaType)

Trigger the REST request invocation. Equivalent to invoking setEntity(Object, String) followed by send()

Parameters:

entity - Entity content for the PUT or POST requests.

mediaType - Type of the supported media.

Returns:

Future of the REST invocation.

send

RestFuture send()

Description copied from interface: WscMessage

Marks the message as ready to send. This method should be invoked to send the message to the destination. This method returns a future object if the message supports futures, otherwise, it returns null.

Specified by:

send in interface WscMessage

Returns:

A future object or null if future is not supported by this message

setAccept

void setAccept(RestMediaType... mediaTypes)

Set the media types used in the invocation.

Parameters:

mediaTypes - Accepted media types..

setAcceptLanguage

void setAcceptLanguage(String... locales)

Add acceptable languages used in the invocation.

Parameters:

locales - Acceptable languages.

addHeader

void addHeader(String name,
               String value)

Add an arbitrary header.

Parameters:

name - Name of the header.

value - Value of the header.

setCredentials

void setCredentials(String userName,
                    byte[] password)

Set basic auth username and password. An encrypted password may be obtained using weblogic.security.Encrypt utility.

Parameters:

userName - User name.

password - Password.

setDigestCredentials

void setDigestCredentials(String userName,
                          byte[] password)

Set digest auth username and password. An encrypted password may be obtained using weblogic.security.Encrypt utility.

Parameters:

userName - User name.

password - Password.

setStackConfiguration

void setStackConfiguration(String name,
                           Object value)

Add a property supported by underlying REST stack implementation.

Parameters:

name - Name of the property.

value - Value of the property.

setEntity

void setEntity(Object entity,
               RestMediaType mediaType)

Set the request entity for POST and PUT. If the mediaType is text/plain, then the entity should be a java.lang.String.

If the mediaType is application/xml, then the entity object should be a groovy.lang.Closure as expected by bind() method of groovy.xml.StreamingMarkupBuilder or a groovy.lang.Writable object obtained from StreamingMarkupBuilder.

If the mediaType is application/json, then the entity object should be any object expected by call() method of groovy.json.JsonBuilder or a groovy.json.JsonBuilder object which is a groovy.lang.Writable.

Refer to Groovy api documentation for more information.

Parameters:

entity - Entity content for the PUT or POST requests.

mediaType - Type of the supported media.