oracle.apiplatform.policies.sdk.context

Interface OutgoingMessage

All Superinterfaces:

IncomingMessage

All Known Subinterfaces:

ApiResponse, ServiceRequest

public interface OutgoingMessage
extends IncomingMessage

The outgoing message.

Method Summary

Modifier and Type	Method and Description
Body	getOrDefaultBody()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getOrDefaultHeaders()
OutgoingMessage	setBody(Body body)
OutgoingMessage	setHeader(java.lang.String name, java.lang.String value) Adds or overrides a header with a given name for outbound request
OutgoingMessage	setHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers) Overrides the set of headers to be used for outbound request with the given map
OutgoingMessage	withoutHeader(java.lang.String name) Send the message without this header.

Methods inherited from interface oracle.apiplatform.policies.sdk.context.IncomingMessage

getBody, getHeader, getHeaders

Method Detail

setBody

OutgoingMessage setBody(Body body)
                 throws java.io.IOException

Throws:

java.io.IOException

getOrDefaultBody

Body getOrDefaultBody()
               throws java.io.IOException

Returns:

the payload that was set to service request or the one from the corresponding Api request

Throws:

java.io.IOException

setHeader

OutgoingMessage setHeader(java.lang.String name,
                          java.lang.String value)

Adds or overrides a header with a given name for outbound request

Returns:

setHeaders

OutgoingMessage setHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Overrides the set of headers to be used for outbound request with the given map

Parameters:

headers -

Returns:

getOrDefaultHeaders

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getOrDefaultHeaders()

Returns:

All the headers. Including set/add and excluding without-headers, based on the incoming message

withoutHeader

OutgoingMessage withoutHeader(java.lang.String name)

Send the message without this header. Will remove header if 'setHeader' has been called before this.

Parameters:

name -

Returns: