oracle.apiplatform.policies.sdk.context

Interface ApiResponse

All Superinterfaces:

IncomingMessage, OutgoingMessage

public interface ApiResponse
extends OutgoingMessage

API Response object. Defines an object to assist a policy runtime in sending a response to the client.

Method Summary

Modifier and Type	Method and Description
int	getStatusCode() Returns the status code associated with this response
java.lang.String	getStatusText() Returns the status text associated with this response
ApiResponse	setStatusCode(int code) Sets the status code for this response.
ApiResponse	setStatusText(java.lang.String text) Sets the status text for this response.

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

getOrDefaultBody, getOrDefaultHeaders, setBody, setHeader, setHeaders, withoutHeader

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

getBody, getHeader, getHeaders

Method Detail

setStatusCode

ApiResponse setStatusCode(int code)

Sets the status code for this response.

Parameters:

code - for the response, e.g. 200 or 500

Returns:

this ApiResponse instance

getStatusCode

int getStatusCode()

Returns the status code associated with this response

Returns:

status code

getStatusText

java.lang.String getStatusText()

Returns the status text associated with this response

Returns:

a String of the status

setStatusText

ApiResponse setStatusText(java.lang.String text)

Sets the status text for this response.

Parameters:

text - for the response status

Returns:

this ApiResponse instance