oracle.sdp.daf.action.api

Interface HttpContext

public interface HttpContext

Contains information that is helpful for actions retrieving information from HTTP requests and responses. Contains a reference to API Context which contains a reference to the System context. The API Context contains the runtime configuration. The System context contains helper services.

Method Summary

Modifier and Type	Method and Description
ExternalCalloutBuilder	createCallout() Creates an "in-chain" callout that enables a callout within an action chain execution to perform a RESTful WebService invocation that could, for instance, look up profile data.
ReviveContext	discontinueActionChain() Discontinue action flow.
void	forceResponse() This will force whatever values set on the clientResponse to be returned to the client, skipping the rest of the request and response chain.
ApiContext	getApiContext() Retrieves the runtime API context.
ApplicationContext	getAppContext() Retrieve the application context.
Object	getAttribute(String id) Retrieves the object based on an I.
HttpRequest	getClientRequest() Gets the request between the Client and the Dynamic API Framework.
ResponseBuilder	getClientResponse() Allows actions to affect the response back to the application.
CalloutBuilder	getSouthboundCallout() Retrieves the network facing callout, which is the "proxying" request to the server.
HttpResponse	getSouthboundResponse() Gets the response from the network (readonly).
default boolean	isInternalError() Gets it is internal error when communicate with the back-end service.
boolean	isRequest() Returns a request or response to the direction.
void	setAttribute(String id, Object o) Allows the storage of objects between invocations in the action chain; however, objects will not be stored between request and response.
String	stringSubstitute(String s) Helper method that parses the string and exchanges the syntax ${attribute} to whatever that attribute is.

Method Detail

getClientRequest

HttpRequest getClientRequest()

Gets the request between the Client and the Dynamic API Framework. The request is read only.

Returns:

The readonly request

getSouthboundResponse

HttpResponse getSouthboundResponse()

Gets the response from the network (readonly). Before the network has been called, this will be null.

Returns:

The response the network sent back to DAF.

setAttribute

void setAttribute(String id,
                  Object o)

Allows the storage of objects between invocations in the action chain; however, objects will not be stored between request and response.

Parameters:

id - The id of the object to be stored

o - The object to be stored

getAttribute

Object getAttribute(String id)

Retrieves the object based on an I. The ID could have been set by another action.

Parameters:

id - The ID to lookup

Returns:

The object matching the id, null if there is no match

getSouthboundCallout

CalloutBuilder getSouthboundCallout()

Retrieves the network facing callout, which is the "proxying" request to the server. After this callout is invoked and a response is received, the response chain will start. Note: If an Action tries to call the send method on this, an exception will be thrown.

Returns:

The callout builder.

getClientResponse

ResponseBuilder getClientResponse()

Allows actions to affect the response back to the application.

Returns:

The response builder.

1. When Content-Encoding = gzip|deflate in the response header from the network, the uncompressed network response is contained.
2. When no Content-Encoding in the response header from the network, the raw network response is contained.
3. After the client response is set in actions, it contains the last content which is set.

createCallout

ExternalCalloutBuilder createCallout()

Creates an "in-chain" callout that enables a callout within an action chain execution to perform a RESTful WebService invocation that could, for instance, look up profile data.

Returns:

The callout builder.

getApiContext

ApiContext getApiContext()

Retrieves the runtime API context.

Returns:

the runtime API context.

stringSubstitute

String stringSubstitute(String s)
                 throws ActionProcessingError

Helper method that parses the string and exchanges the syntax ${attribute} to whatever that attribute is. For example, if getAttribute("key") returns "value", then "this is my string ${key} test" returns "this is my string value test".

Parameters:

s - The string which includes or does not include the ${parameter}

Returns:

The string with the substituted value

Throws:

ActionProcessingError - if the attribute could not be found an ActionProcessingError is thrown.

isRequest

boolean isRequest()

Returns a request or response to the direction.

Returns:

true if request, false if response

discontinueActionChain

ReviveContext discontinueActionChain()

Discontinue action flow. This will totally "suspend" the request/response. Since the message flow asynchronous this will not block threads. Use 'revive' method on the returned ReviveContext to revive this request/response.

Returns:

revive context

forceResponse

void forceResponse()

This will force whatever values set on the clientResponse to be returned to the client, skipping the rest of the request and response chain. Can be invoked both on the request chain or response chain.

getAppContext

ApplicationContext getAppContext()

Retrieve the application context.

Returns:

the application context.

isInternalError

default boolean isInternalError()

Gets it is internal error when communicate with the back-end service. Default method, returns false as default.

Returns:

True when it is internal error; False, other wise.