oracle.sdp.daf.action.api

Interface MessageBuilder

All Known Subinterfaces:

CalloutBuilder, ExternalCalloutBuilder, ResponseBuilder

public interface MessageBuilder

Message builder.

Method Summary

Modifier and Type	Method and Description
MessageBuilder	addHeader(String key, String value) Adds a header.
Object	getBodyAsObject() Gets the body as an object.
InputStream	getBodyAsStream() Gets the body as a stream.
<T> T	getBodyAsType(Class<T> clazz) Retrieves the body information of the call out message as a particular type.
Headers	getCombinedHeaders(HttpMessage pHttpMessage) Retrieve all the headers.
String	getHeader(String key) Gets the specific header if it exists.
MessageBuilder	ignoreAllRequestHeaders(boolean ignore) Remove all the headers which are from client request message.
MessageBuilder	withBodyAsObject(Object body) Sets the output as an object such as an XMLNode, String or JSON.
MessageBuilder	withBodyAsStream(InputStream body) Sets the output of a body as an input stream.
MessageBuilder	withHeader(String key, String value) Sets a header.
MessageBuilder	withHeaders(Map<String,String> headers) Sets multiple headers.Overwrite the value which is set by addHeader(String, String) before in the invocation sequence.
MessageBuilder	withoutHeader(String key) Send the message without this header.

Method Detail

withBodyAsObject

MessageBuilder withBodyAsObject(Object body)

Sets the output as an object such as an XMLNode, String or JSON.

Parameters:

body - Body

Returns:

the builder

getBodyAsType

<T> T getBodyAsType(Class<T> clazz)

Retrieves the body information of the call out message as a particular type. A Streamer provides the information.

Type Parameters:

T - The type of the class

Parameters:

clazz - The class

Returns:

the object of the type

getHeader

String getHeader(String key)

Gets the specific header if it exists.

Parameters:

key - The key pointing to the header value

Returns:

The header value, or null if not found

withBodyAsStream

MessageBuilder withBodyAsStream(InputStream body)

Sets the output of a body as an input stream.

Parameters:

body - Body

Returns:

The builder

getBodyAsObject

Object getBodyAsObject()

Gets the body as an object.

Returns:

Body as an object

getBodyAsStream

InputStream getBodyAsStream()

Gets the body as a stream.

Returns:

Body as a stream

withHeader

MessageBuilder withHeader(String key,
                          String value)

Sets a header. Overwrite the value which is set by addHeader(String, String) before in the invocation sequence.

Parameters:

key - The key pointing to the header value

value - Value of the header

Returns:

The builder

addHeader

MessageBuilder addHeader(String key,
                         String value)

Adds a header. This value can be overwrote by withHeader(String, String) and withHeaders(Map) later in the invocation sequence.

Parameters:

key - The key pointing to the header value

value - Value of the header

Returns:

The builder

withHeaders

MessageBuilder withHeaders(Map<String,String> headers)

Sets multiple headers.Overwrite the value which is set by addHeader(String, String) before in the invocation sequence.

Parameters:

headers - Map with multiple headers

Returns:

The builder

withoutHeader

MessageBuilder withoutHeader(String key)

Send the message without this header.

Parameters:

key - header to remove from message

Returns:

the builder

ignoreAllRequestHeaders

MessageBuilder ignoreAllRequestHeaders(boolean ignore)

Remove all the headers which are from client request message.

Parameters:

ignore - true to remove all request headers from message, false will be merged with others.

Returns:

the builder

getCombinedHeaders

Headers getCombinedHeaders(HttpMessage pHttpMessage)

Retrieve all the headers. Including set/add and excluding without-headers, based on the provided httpMessage

Parameters:

pHttpMessage - the httpMessage to include the headers from to see what is possibly sent out

Returns:

headers