Skip navigation links
Oracle Communications Services Gatekeeper Actions Java API Reference
E65004-01
6.1
A B C D E F G H I M O P R S T U V W 

A

Action<T> - Interface in oracle.sdp.daf.action.api
Action interface.
ActionConfigurationException - Exception in oracle.sdp.daf.action.api
Configuration failed for an Action.
ActionConfigurationException(List<ValidationError>) - Constructor for exception oracle.sdp.daf.action.api.ActionConfigurationException
Constructor.
ActionConfigurationException(ValidationError...) - Constructor for exception oracle.sdp.daf.action.api.ActionConfigurationException
Constructor.
ActionConfigurationException(Exception, ValidationError...) - Constructor for exception oracle.sdp.daf.action.api.ActionConfigurationException
Constructor.
ActionConfigurationException(List<ValidationError>, Exception) - Constructor for exception oracle.sdp.daf.action.api.ActionConfigurationException
Constructor.
ActionInstanceId - Interface in oracle.sdp.daf.action.api
The interface for Action to provide action instance ID.
ActionProcessingError - Exception in oracle.sdp.daf.action.api
Action processing error.
ActionProcessingError(int, String) - Constructor for exception oracle.sdp.daf.action.api.ActionProcessingError
Processing error.
ActionProcessingError(int, String, Throwable) - Constructor for exception oracle.sdp.daf.action.api.ActionProcessingError
Processing error.
add(Headers) - Method in interface oracle.sdp.daf.action.api.Headers
Add all from another Headers object.
addHeader(String, String) - Method in interface oracle.sdp.daf.action.api.Headers
Add header.
addHeader(String, String) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Adds a header.
API_ID - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
ApiContext - Interface in oracle.sdp.daf.action.api
API Context.
AppContextFactory - Interface in oracle.sdp.daf.spi
Application Context Factory.
ApplicationContext - Interface in oracle.sdp.daf.spi
Application context.
attachAndGetRequestContext() - Method in interface oracle.sdp.daf.spi.RequestContextContainer
Attach saved request context to Thread local.
attachRequestContextToCurrentThread() - Method in interface oracle.sdp.daf.spi.RequestContextContainer
Attach saved request context to Thread local.

B

BEARER - Static variable in exception oracle.sdp.daf.spi.OAuthDenyException
 
build() - Method in interface oracle.sdp.daf.action.api.ExternalCalloutBuilder
Build the callout.

C

Callout - Interface in oracle.sdp.daf.action.api
The callout interface.
CalloutBuilder - Interface in oracle.sdp.daf.action.api
Callout builder.
ConfigManipulatorAction<T> - Interface in oracle.sdp.daf.action.api
Actions that wants to manipulate the API configuration should implement this interface.
createApplicationContext() - Method in interface oracle.sdp.daf.spi.AppContextFactory
Create the application context.
createCallout() - Method in interface oracle.sdp.daf.action.api.HttpContext
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.

D

delete(String) - Method in interface oracle.sdp.daf.spi.UrlPathTree
Remove the URI from the tree.
destroy() - Method in interface oracle.sdp.daf.action.api.Action
Destruction.
discontinueActionChain() - Method in interface oracle.sdp.daf.action.api.HttpContext
Discontinue action flow.

E

EMPTY_INSTANCE_ID - Static variable in enum oracle.sdp.daf.action.api.PredefinedActionInstanceId
 
ERROR_CATEGORY - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
ERROR_CATEGORY_ACTION - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
ERROR_CATEGORY_PEER - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
ERROR_CATEGORY_SERVICE - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
ExceptionAwareAction - Interface in oracle.sdp.daf.action.api
An action implementing this interface will be called if an exception happened after this action has been processed.
exceptionHappened(ActionProcessingError, HttpContext) - Method in interface oracle.sdp.daf.action.api.ExceptionAwareAction
Called if an action processing error happened later in the chain.
ExternalCalloutBuilder - Interface in oracle.sdp.daf.action.api
Used for in-action callouts.

F

forceResponse() - Method in interface oracle.sdp.daf.action.api.HttpContext
This will force whatever values set on the clientResponse to be returned to the client, skipping the rest of the request and response chain.

G

GEGERAL_STAUS - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
GENERAL_STATUS_ERROR - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
GENERAL_STATUS_REJECT - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
GENERAL_STATUS_SUCCESS - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
get() - Method in interface oracle.sdp.daf.action.api.Headers
Retrieve headers.
getApiContext() - Method in interface oracle.sdp.daf.action.api.HttpContext
Retrieves the runtime API context.
getApiPathInfo() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the path info related to this API.
getApiRuntimeConfiguration() - Method in interface oracle.sdp.daf.action.api.ApiContext
Gets the processing API runtime configuration.
getAppContext() - Method in interface oracle.sdp.daf.action.api.HttpContext
Retrieve the application context.
getAppId() - Method in interface oracle.sdp.daf.spi.ApplicationContext
Retrieve the application identifier.
getAppKey() - Method in interface oracle.sdp.daf.spi.ApplicationContext
Retrieve the application key, optionally used by the application to call the API and action chain.
getAttribute(String) - Method in interface oracle.sdp.daf.action.api.HttpContext
Retrieves the object based on an I.
getBodyAsObject() - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Gets the body as an object.
getBodyAsStream() - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Gets the body as a stream.
getBodyAsType(Class<T>) - Method in interface oracle.sdp.daf.action.api.HttpMessage
Retrieves the body information of the HTTP message as a particular type.
getBodyAsType(Class<T>) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Retrieves the body information of the call out message as a particular type.
getClientRequest() - Method in interface oracle.sdp.daf.action.api.HttpContext
Gets the request between the Client and the Dynamic API Framework.
getClientResponse() - Method in interface oracle.sdp.daf.action.api.HttpContext
Allows actions to affect the response back to the application.
getCombinedHeaders(HttpMessage) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Retrieve all the headers.
getEndColumn() - Method in class oracle.sdp.daf.action.api.SyntaxValidationError
 
getEndLine() - Method in class oracle.sdp.daf.action.api.SyntaxValidationError
 
getErrorCode() - Method in exception oracle.sdp.daf.spi.OAuthDenyException
get error code.
getErrorCode() - Method in exception oracle.sdp.daf.spi.SLAException
get error code.
getErrorDescription() - Method in exception oracle.sdp.daf.spi.OAuthDenyException
get error description.
getExceptionList() - Method in exception oracle.sdp.daf.action.api.ActionConfigurationException
 
getFirstHeaders() - Method in interface oracle.sdp.daf.action.api.Headers
Retrieve a flat list of headers - i.e.
getHeader(String) - Method in interface oracle.sdp.daf.action.api.HttpMessage
Gets the specific header if it exists.
getHeader(String) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Gets the specific header if it exists.
getHeaders() - Method in interface oracle.sdp.daf.action.api.HttpMessage
Get the headers.
getInstanceId() - Method in interface oracle.sdp.daf.action.api.ActionInstanceId
Gets the action instance ID.
getMessage() - Method in exception oracle.sdp.daf.action.api.ActionConfigurationException
 
getMessage() - Method in class oracle.sdp.daf.action.api.ValidationError
Get the message.
getMethod() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the method.
getOAuth2Validator() - Method in interface oracle.sdp.daf.action.api.SystemContext
Retrieve the application facing OAuth2 Validator.
getPathInfo() - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Retrieve the path info - the resource part of the url.
getPathInfo() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the path information.
getQueryParameter(String) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Gets the query parameter corresponding to the key.
getQueryParameters() - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Returns the query parameters.
getQueryParameters() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the query parameters.
getQueryString() - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Gets the query string.
getQueryString() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the query string.
getRemoteHost() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the remote host.
getRemotePort() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the remote port.
getRequestMethod() - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Gets the request Method.
getRequestURI() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the request URI.
getRequestUrl() - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Gets the request URL.
getResponseCode() - Method in exception oracle.sdp.daf.action.api.ActionProcessingError
Returns the response code.
getSLAEnforcement() - Method in interface oracle.sdp.daf.action.api.SystemContext
Retrieve the SLA Enforcement.
getSouthboundCallout() - Method in interface oracle.sdp.daf.action.api.HttpContext
Retrieves the network facing callout, which is the "proxying" request to the server.
getSouthboundResponse() - Method in interface oracle.sdp.daf.action.api.HttpContext
Gets the response from the network (readonly).
getStartColumn() - Method in class oracle.sdp.daf.action.api.SyntaxValidationError
 
getStartLine() - Method in class oracle.sdp.daf.action.api.SyntaxValidationError
 
getStatus() - Method in interface oracle.sdp.daf.action.api.HttpResponse
Response status code.
getStatus() - Method in interface oracle.sdp.daf.action.api.ResponseBuilder
Retrieve the status of the response.
getSystemContext() - Method in interface oracle.sdp.daf.action.api.ApiContext
Gets the system context, which is the parent context.
getTrafficLogger() - Method in interface oracle.sdp.daf.action.api.SystemContext
Retrieve the traffic logger.
getType() - Method in exception oracle.sdp.daf.spi.OAuthDenyException
get error type.

H

handleResponse(HttpResponse, HttpContext) - Method in interface oracle.sdp.daf.action.api.ResponseCallback
Handle the response.
Headers - Interface in oracle.sdp.daf.action.api
Headers.
HTTP_CODE_NOT_FOUND - Static variable in exception oracle.sdp.daf.spi.SLAException
 
HTTP_METHOD - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
HTTP_STATUS - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
HttpContext - Interface in oracle.sdp.daf.action.api
Contains information that is helpful for actions retrieving information from HTTP requests and responses.
HttpMessage - Interface in oracle.sdp.daf.action.api
HTTP Message.
HttpRequest - Interface in oracle.sdp.daf.action.api
Http Request.
HttpResponse - Interface in oracle.sdp.daf.action.api
Http Response.

I

ignoreAllRequestHeaders(boolean) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Remove all the headers which are from client request message.
ignoreAllRequestQueryParameters(boolean) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Removes all query parameters from the original client request message.
init(T, ApiConfiguration) - Method in interface oracle.sdp.daf.action.api.Action
Initialization.
INSUFFICIENT_SCOPE - Static variable in exception oracle.sdp.daf.spi.OAuthDenyException
 
INVALID_REQUEST - Static variable in exception oracle.sdp.daf.spi.OAuthDenyException
 
isRequest() - Method in interface oracle.sdp.daf.action.api.HttpContext
Returns a request or response to the direction.
isTraceActionEnabled() - Method in interface oracle.sdp.daf.spi.TrafficLogger
If traffic tracing on Actions should be performed.
isTraceEnabled() - Method in interface oracle.sdp.daf.spi.TrafficLogger
If traffic tracing should be performed.
isTraceGetMethodEnabled() - Method in interface oracle.sdp.daf.spi.TrafficLogger
If traffic tracing on Methods that get information should be performed.
isTraceSetMethodEnabled() - Method in interface oracle.sdp.daf.spi.TrafficLogger
If traffic tracing on Methods that set information should be performed.

M

manipulate(ApiConfiguration) - Method in interface oracle.sdp.daf.action.api.ConfigManipulatorAction
Manipulates the API configuration, for example adding a schema based on another schema.
MessageBuilder - Interface in oracle.sdp.daf.action.api
Message builder.

O

OAuth2Validator - Interface in oracle.sdp.daf.spi
OAuth2Validator interface.
OAuthDenyException - Exception in oracle.sdp.daf.spi
OAuth Deny Exception.
OAuthDenyException(String, int, String, String) - Constructor for exception oracle.sdp.daf.spi.OAuthDenyException
Constructor.
OAuthDenyException(String, int, String) - Constructor for exception oracle.sdp.daf.spi.OAuthDenyException
Constructor.
OAuthDenyException(String, int) - Constructor for exception oracle.sdp.daf.spi.OAuthDenyException
Constructor.
OAuthDenyException(String) - Constructor for exception oracle.sdp.daf.spi.OAuthDenyException
Constructor.
oracle.sdp.daf.action.api - package oracle.sdp.daf.action.api
 
oracle.sdp.daf.spi - package oracle.sdp.daf.spi
 

P

PATH_INFO - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
PredefinedActionInstanceId - Enum in oracle.sdp.daf.action.api
The predefined action instance ID for the actions which configuration are hidden.
process(HttpContext) - Method in interface oracle.sdp.daf.action.api.Action
Process the request.

R

removeHeader(String) - Method in interface oracle.sdp.daf.action.api.Headers
Remove header.
REQ_BODY_SZ - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
REQUEST_POLICY - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
REQUEST_URL - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
RequestContextContainer - Interface in oracle.sdp.daf.spi
Container class to help transfer Request Context between threads.
RESPONSE_POLICY - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
ResponseBuilder - Interface in oracle.sdp.daf.action.api
Builds the response.
ResponseCallback - Interface in oracle.sdp.daf.action.api
Response callback for asynchronous requests.
retrieve(String) - Method in interface oracle.sdp.daf.spi.UrlPathTree
Retrieve the URI matching the pathInfo from the tree.
retrieve(String, String) - Method in interface oracle.sdp.daf.spi.UrlPathTree
Retrieve the URI matching the pathInfo and version from the tree.
retrieveBudget(Principal, String, String, String, String, String) - Method in interface oracle.sdp.daf.spi.SLAEnforcement
This method is used to get the matched budget Ids.
revive() - Method in interface oracle.sdp.daf.action.api.ReviveContext
Reviving a discontinued action chain flow.
ReviveContext - Interface in oracle.sdp.daf.action.api
Revive context.
RSP_BODY_SZ - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 

S

saveCurrentRequestContext() - Method in interface oracle.sdp.daf.spi.RequestContextContainer
Reads RequestContext from thread local and save it to this object.
send() - Method in interface oracle.sdp.daf.action.api.Callout
Synchronous call.
send(String) - Method in interface oracle.sdp.daf.action.api.Callout
Asynchronous call.
SERVICE_URI - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
set(Headers) - Method in interface oracle.sdp.daf.action.api.Headers
Set all from another Headers object.
setAttribute(String, Object) - Method in interface oracle.sdp.daf.action.api.HttpContext
Allows the storage of objects between invocations in the action chain; however, objects will not be stored between request and response.
setHeader(String, String) - Method in interface oracle.sdp.daf.action.api.Headers
Set header.
SLAEnforcement - Interface in oracle.sdp.daf.spi
Interface SLAEnforcement.
SLAException - Exception in oracle.sdp.daf.spi
SLA Exception class.
SLAException(int, String) - Constructor for exception oracle.sdp.daf.spi.SLAException
constructor.
STATE - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
store(String) - Method in interface oracle.sdp.daf.spi.UrlPathTree
Store the URI into the tree.
stringSubstitute(String) - Method in interface oracle.sdp.daf.action.api.HttpContext
Helper method that parses the string and exchanges the syntax ${attribute} to whatever that attribute is.
SyntaxValidationError - Class in oracle.sdp.daf.action.api
Syntax validation error information.
SyntaxValidationError(String, int, int, int, int) - Constructor for class oracle.sdp.daf.action.api.SyntaxValidationError
Constructor.
SystemContext - Interface in oracle.sdp.daf.action.api
System wide state.

T

TIMESTAMP - Static variable in interface oracle.sdp.daf.spi.TrafficLogger
 
trace(String, String, String, HttpMessage, Map<String, String>) - Method in interface oracle.sdp.daf.spi.TrafficLogger
Trace traffic that happens in DAF.
traceAction(String, String, String, String) - Method in interface oracle.sdp.daf.spi.TrafficLogger
The Action interaction that should be logged.
traceException(String, String, String, Exception, Map<String, String>) - Method in interface oracle.sdp.daf.spi.TrafficLogger
Exception which should be traced.
traceMethod(String, String, String, String) - Method in interface oracle.sdp.daf.spi.TrafficLogger
Method invocation that should be traced.
tracePolicy(String, String) - Method in interface oracle.sdp.daf.spi.TrafficLogger
Trace policy, API for Glacier.
traceWithRequestContext(String, String, String, HttpMessage, Map<String, String>, RequestContext) - Method in interface oracle.sdp.daf.spi.TrafficLogger
Method invocation that should be traced using given RequestContext.
TrafficLogger - Interface in oracle.sdp.daf.spi
Logs traffic.
TrafficLogger.Position - Enum in oracle.sdp.daf.spi
Enum value of traffic positions.

U

UNAUTHORIZED - Static variable in exception oracle.sdp.daf.spi.OAuthDenyException
 
update(T, ApiConfiguration) - Method in interface oracle.sdp.daf.action.api.Action
Update.
UrlPathTree - Interface in oracle.sdp.daf.spi
URL Path Tree interface.

V

validateOAuth(String, String) - Method in interface oracle.sdp.daf.spi.OAuth2Validator
validate whether the request OAuth token is valid.
validateSLA(Subject, String, String, String, String, String) - Method in interface oracle.sdp.daf.spi.SLAEnforcement
This method is used to validate the request API against SLA's validation time.
ValidationError - Class in oracle.sdp.daf.action.api
Validation error.
ValidationError(String) - Constructor for class oracle.sdp.daf.action.api.ValidationError
Constructor.
valueOf(String) - Static method in enum oracle.sdp.daf.action.api.PredefinedActionInstanceId
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.sdp.daf.spi.TrafficLogger.Position
Returns the enum constant of this type with the specified name.
values() - Static method in enum oracle.sdp.daf.action.api.PredefinedActionInstanceId
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.sdp.daf.spi.TrafficLogger.Position
Returns an array containing the constants of this enum type, in the order they are declared.

W

withBodyAsObject(Object) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Sets the output as an object such as an XMLNode, String or JSON.
withBodyAsStream(InputStream) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Sets the output of a body as an inputstream.
withHeader(String, String) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Sets a header.
withHeaders(Map<String, String>) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Sets multiple headers.
withoutHeader(String) - Method in interface oracle.sdp.daf.action.api.MessageBuilder
Send the message without this header.
withoutQueryParameter(String) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Sends the request message without a query parameter that you specify.
withPathInfo(String) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
PathInfo.
withQueryParameter(String, String) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Adds or overwrites an individual query parameter.
withQueryString(String) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Changes queryString parameters.
withRequestMethod(String) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Changes the request method.
withRequestUrl(String) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Changes the request URL.
withStatus(int) - Method in interface oracle.sdp.daf.action.api.ResponseBuilder
Sets the status of the response.
A B C D E F G H I M O P R S T U V W 
Skip navigation links
Oracle Communications Services Gatekeeper Actions Java API Reference
E65004-01
6.1

Copyright © 2014, 2016, Oracle and/or its affiliates. All rights reserved.