Skip navigation links
Oracle© Communications Services Gatekeeper Actions Java API Reference
E96579-01
7.0
A B C D E F G H I K 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) - Constructor for exception oracle.sdp.daf.action.api.ActionProcessingError
Processing error that will generate a HTTP response based on deny code mappings.
ActionProcessingError(int, String) - Constructor for exception oracle.sdp.daf.action.api.ActionProcessingError
Processing error.
ActionProcessingError(int, String, 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.
addInterface(String, String, boolean) - Method in class oracle.sdp.daf.configurations.DafCSTypeConfig
Add CSInterfaceConfig instance.
addServiceType(String, String) - Method in class oracle.sdp.daf.configurations.DafCSConfig
Add DafCSTypeConfig instance if not exists, or return the existing one.
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.
CalloutCallbackHandler - Interface in oracle.sdp.daf.action.api
Used for in-action callouts' callback processing.
callOutRetryTimes - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Defines the retry times when failed to call on south bound service.
CHUNKED_HEADER - Static variable in enum oracle.sdp.daf.configurations.SouthBoundChunkedSetting
The chunked header name.
clone(Predicate<DafCSTypeConfig>, Function<DafCSTypeConfig, DafCSTypeConfig>) - Method in class oracle.sdp.daf.configurations.DafCSConfig
Clone new DafCSConfig instance with the specified filter.
clone(Predicate<CSInterfaceConfig>) - Method in class oracle.sdp.daf.configurations.DafCSTypeConfig
Clone new DafCSTypeConfig instance with the specified filter.
ConfigManipulatorAction<T> - Interface in oracle.sdp.daf.action.api
Actions that wants to manipulate the API configuration should implement this interface.
connectTimeoutMs - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Defines the connection time out value in Milliseconds.
continueResponseCallFlow - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Continues or breaks the response action call flow when OCSG does not get the response from the south bound services.
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.
CSInterfaceConfig - Class in oracle.sdp.daf.configurations
The class for configuration of communication service interfaces.
CSInterfaceConfig() - Constructor for class oracle.sdp.daf.configurations.CSInterfaceConfig
Default Constructor.
CSInterfaceConfig(String, String, boolean) - Constructor for class oracle.sdp.daf.configurations.CSInterfaceConfig
Constructor.

D

DafConfigurationsMBean - Interface in oracle.sdp.daf.configurations
MBean implementation for the DAF general information configuration.
DafCSConfig - Class in oracle.sdp.daf.configurations
Communication Service Configuration for DAF.
DafCSConfig() - Constructor for class oracle.sdp.daf.configurations.DafCSConfig
 
DafCSTypeConfig - Class in oracle.sdp.daf.configurations
Communication Service Type Configuration for DAF.
DafCSTypeConfig() - Constructor for class oracle.sdp.daf.configurations.DafCSTypeConfig
Default Constructor.
DafCSTypeConfig(String, String) - Constructor for class oracle.sdp.daf.configurations.DafCSTypeConfig
Constructor.
DafCSTypeConfig(String, String, List<CSInterfaceConfig>) - Constructor for class oracle.sdp.daf.configurations.DafCSTypeConfig
Constructor.
DafGeneralInfoHelper - Class in oracle.sdp.daf.configurations
Helper class to communicate with data store.
DafGeneralInfoHelper() - Constructor for class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Constructor.
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
 
enableSouthCookie - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
If true, allows applications to communicate with backend servers using cookies.
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

GENERAL_STATUS - 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.
get(String) - Method in interface oracle.sdp.daf.action.api.Headers
Retrieve the header values after a case-insensitive lookup.
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.
getCachedKeepNorthSession() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Get Cached keepNorthSession value.
getCallbackHandler() - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Gets the callback handler associated with this builder.
getCallOutRetryTimes() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Gets the retry times when failed to call on south bound service.
getCallOutRetryTimes() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
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.
getConnectTimeoutMs() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get configured performance parameter connectTimeoutMs.
getConnectTimeoutMs() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getContentType() - Method in exception oracle.sdp.daf.action.api.ActionProcessingError
Returns the content type header value.
getContentType() - Method in exception oracle.sdp.daf.spi.SLAException
get content type.
getDenyCodeDefinitions() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getDisplayName() - Method in class oracle.sdp.daf.configurations.CSInterfaceConfig
 
getDisplayName() - Method in class oracle.sdp.daf.configurations.DafCSTypeConfig
 
getEnableSouthCookie() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get configured performance parameter enableSouthCookie.
getEnableSouthCookie() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
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.
getInstallerVersion() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get current installer version.
getInstallerVersion() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getInstanceId() - Method in interface oracle.sdp.daf.action.api.ActionInstanceId
Gets the action instance ID.
getInterfaces() - Method in class oracle.sdp.daf.configurations.DafCSTypeConfig
Get CSInterfaceConfig list.
getKeepNorthSession() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get configured performance parameter keepNorthSession.
getKeepNorthSession() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getMapping(int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getMappings(int, int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getMaxTotalConnections() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get configured performance parameter maxTotalConnections.
getMaxTotalConnections() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getMessage() - Method in exception oracle.sdp.daf.action.api.ActionConfigurationException
 
getMessage() - Method in exception oracle.sdp.daf.action.api.ActionProcessingError
 
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.
getName() - Method in class oracle.sdp.daf.configurations.CSInterfaceConfig
 
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
Deprecated.
Use getQueryParametersMultiValue instead
getQueryParameters() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Deprecated.
Use getQueryParametersMultiValue instead
getQueryParametersMultiValue() - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Returns the query parameters as multi-value array.
getQueryParametersMultiValue() - Method in interface oracle.sdp.daf.action.api.HttpRequest
Retrieves the query parameters as multi-value array.
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.
getResourceGetter() - Method in interface oracle.sdp.daf.action.api.SystemContext
Retrieve resource getter to get api resources.
getResources(String) - Method in interface oracle.sdp.daf.spi.ResourceGetter
Get resources for an api.
getResponseCode() - Method in exception oracle.sdp.daf.action.api.ActionProcessingError
Returns the response code.
getReuseAddress() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get configured performance parameter reuseAddress.
getReuseAddress() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getSendSouthConnCloseThreshold() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Gets the sendSouthConnCloseThreshold value.
getSendSouthConnCloseThreshold() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getServiceType() - Method in class oracle.sdp.daf.configurations.DafCSTypeConfig
 
getServiceTypes() - Method in class oracle.sdp.daf.configurations.DafCSConfig
 
getSLAEnforcement() - Method in interface oracle.sdp.daf.action.api.SystemContext
Retrieve the SLA Enforcement.
getSLAValidationErrorCode() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Override the default HTTP response message to use for SLA validation errors.
getSLAValidationErrorCode() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Override the default HTTP response message to use for SLA validation errors.
getSLAValidationErrorMessage() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Override the default HTTP response message to use for SLA validation errors.
getSLAValidationErrorMessage() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Override the default HTTP response message to use for SLA validation errors.
getSocketTimeoutMs() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get configured performance parameter socketTimeoutMs.
getSocketTimeoutMs() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getSouthboundCallout() - Method in interface oracle.sdp.daf.action.api.HttpContext
Retrieves the network facing callout, which is the "proxying" request to the server.
getSouthBoundChunkedSetting() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Return the configured southBoundChunkedSetting.
getSouthBoundChunkedSetting() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
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.
getUseSession() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get configured performance parameter useSession.
getUseSession() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
getValidSetting(String) - Static method in enum oracle.sdp.daf.configurations.SouthBoundChunkedSetting
Validate the SouthBoundChunkedSetting input and return a valid value.

H

handleAbort(HttpContext) - Method in interface oracle.sdp.daf.spi.SLAEnforcement
This method is called when traffic cannot reach south bound.
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_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.
installerVersion - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Defines the OCSG version information currently installed.
INSUFFICIENT_SCOPE - Static variable in exception oracle.sdp.daf.spi.OAuthDenyException
 
INVALID_REQUEST - Static variable in exception oracle.sdp.daf.spi.OAuthDenyException
 
isContinueResponseCallFlow() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Gets continueResponseCallflow value.
isContinueResponseCallFlow() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
isEnable() - Method in class oracle.sdp.daf.configurations.CSInterfaceConfig
 
isInternalError() - Method in interface oracle.sdp.daf.action.api.HttpContext
Gets it is internal error when communicate with the back-end service.
isRequest() - Method in interface oracle.sdp.daf.action.api.HttpContext
Returns a request or response to the direction.
isSendSouthConnectionCloseHeader() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Gets the sendSouthConnectionCloseHeader value.
isSendSouthConnectionCloseHeader() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
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.

K

keepNorthSession - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
If true, keeps the session open after the request is complete.
KEY_BLACKLIST_MTD - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Black list method key.
KEY_BLACKLIST_PKG - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Black list package key.
KEY_CALLOUT_RETRY_TIMES - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
CalloutRetryTimes key.
KEY_CONNECT_TIMEOUT_MS - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
ConnectTimeoutMS key.
KEY_CONTINUE_SOUTH_RESPONSE_CALLFLOW - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Continue the response call flow.
KEY_CS_CONFIG - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Communication service plugin configuration key.
KEY_ENABLE_SOUTH_COOKIE - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
enable south cookie Key.
KEY_KEEP_NORTH_SESSION - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
keepNorthSession key.
KEY_MAX_TOTAL_CONNECTIONS - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
MaxTotalConnections key.
KEY_REUSE_ADDRESS - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
ReuseAddress key.
KEY_SLA_ERROR_CODE - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Configuration key for integer status code to use for SLA violations.
KEY_SLA_ERROR_MSG - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Configuration key for String message to use in HTTP responses for SLA violations.
KEY_SOCKET_TIMEOUT_MS - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
SocketTimeoutMS key.
KEY_SOUTH_CHUNCKED_SETTING - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
South bound chunked setting.
KEY_SOUTH_CONNECT_CLOSE_HEADER - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
South bound connection close header setting.
KEY_SOUTH_CONNECT_CLOSE_THRESHOLD - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
South bound connection close header request pay load threshold in byte.
KEY_USE_SESSION - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
use session key.
KEY_WHITELIST_MTD - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
White list method key.
KEY_WHITELIST_PKG - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
White list package key.

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.
maxTotalConnections - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Sets the maximum total allowed network connections.
MessageBuilder - Interface in oracle.sdp.daf.action.api
Message builder.
MODULE_NAME - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Store module name.

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.configurations - package oracle.sdp.daf.configurations
 
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.
process(HttpContext) - Method in interface oracle.sdp.daf.action.api.CalloutCallbackHandler
Called on callout completion.

R

refresh() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
removeHeader(String) - Method in interface oracle.sdp.daf.action.api.Headers
Remove header.
removeMapping(int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
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.
ResourceGetter - Interface in oracle.sdp.daf.spi
Get resources for api.
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.
retrieveAvailableDafCSConfigurations() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get the configurations of deployed and enabled communication services.
retrieveAvailableDafCSConfigurations() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
retrieveBlackMethodList() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Retrieve the black method list.
retrieveBlackMethodList() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
retrieveBlackPackageList() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Retrieve the black package list.
retrieveBlackPackageList() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
retrieveDafCSConfigurations() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get the configurations of communication services.
retrieveDafCSConfigurations() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
retrieveListAll() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get all of the black and white list.
retrieveListAll() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
retrievePerformanceSets() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Get all of the performance settings.
retrievePerformanceSets() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
retrieveWhiteMethodList() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Retrieve the white method list.
retrieveWhiteMethodList() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
retrieveWhitePackageList() - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Retrieve the white package list.
retrieveWhitePackageList() - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
reuseAddress - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
If true, allows Services Gatekeeper to make use of the normally unused extra time that TCP reserves before closing sockets (the time_wait state) The default value is true.
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.
sendSouthConnCloseThreshold - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Sets the threshold size in byte of the request payload which is sent to the south bound services.
sendSouthConnectionCloseHeader - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Sends the connection close header to the south bound services or not.
SERVICE_NAME - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Service name for this mbean.
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.
setCallOutRetryTimes(int) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Sets the retry times when failed to call on south bound service.
setCallOutRetryTimes(int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setConnectTimeoutMs(int) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set configured performance parameter connectTimeoutMs.
setConnectTimeoutMs(int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setContinueResponseCallFlow(boolean) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Sets break or not break the response action call flow when OCSG does not get the response from the southbound services.
setContinueResponseCallFlow(boolean) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setDisplayName(String) - Method in class oracle.sdp.daf.configurations.CSInterfaceConfig
 
setDisplayName(String) - Method in class oracle.sdp.daf.configurations.DafCSTypeConfig
 
setEnable(boolean) - Method in class oracle.sdp.daf.configurations.CSInterfaceConfig
 
setEnableSouthCookie(boolean) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set configured performance parameter enableSouthCookie.
setEnableSouthCookie(boolean) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setHeader(String, String) - Method in interface oracle.sdp.daf.action.api.Headers
Set header.
setInterfaces(List<CSInterfaceConfig>) - Method in class oracle.sdp.daf.configurations.DafCSTypeConfig
 
setKeepNorthSession(boolean) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set configured performance parameter keepNorthSession.
setKeepNorthSession(boolean) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setMapping(int, int, String, String) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setMaxTotalConnections(int) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set configured performance parameter maxTotalConnections.
setMaxTotalConnections(int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setName(String) - Method in class oracle.sdp.daf.configurations.CSInterfaceConfig
 
setReuseAddress(boolean) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set configured performance parameter reuseAddress.
setReuseAddress(boolean) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setSendSouthConnCloseThreshold(int) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Sets the sendSouthConnCloseThreshold value.
setSendSouthConnCloseThreshold(int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setSendSouthConnectionCloseHeader(boolean) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Sets the sendSouthConnectionCloseHeader value.
setSendSouthConnectionCloseHeader(boolean) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setServiceType(String) - Method in class oracle.sdp.daf.configurations.DafCSTypeConfig
 
setServiceTypes(ArrayList<DafCSTypeConfig>) - Method in class oracle.sdp.daf.configurations.DafCSConfig
 
setSLAValidationErrorCode(int) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Override the default HTTP status code to use for SLA validation errors.
setSLAValidationErrorCode(int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Override the default HTTP status code to use for SLA validation errors.
setSLAValidationErrorMessage(String) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Override the default HTTP body in error response when SLA is violated.
setSLAValidationErrorMessage(String) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
Override the default HTTP body in error response when SLA is violated.
setSocketTimeoutMs(int) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set configured performance parameter socketTimeoutMs.
setSocketTimeoutMs(int) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setSouthBoundChunkedSetting(String) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set the southBoundChunkedSetting configuration.
setSouthBoundChunkedSetting(String) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
setUseSession(boolean) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set configured performance parameter useSession.
setUseSession(boolean) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
SHARED_STORE - Static variable in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
store shared name.
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.
SLAException(int, String, String) - Constructor for exception oracle.sdp.daf.spi.SLAException
constructor.
SLAValidationErrorCode - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Defines which HTTP status code to use for SLA violations.
SLAValidationErrorMessage - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Defines which message to include in HTTP response in the event of SLA violation.
socketTimeoutMs - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Defines the socket time out value in Milliseconds.
southBoundChunkedSetting - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Defines whether to use the "trunked" way to send request to the backend servers or not.
SouthBoundChunkedSetting - Enum in oracle.sdp.daf.configurations
The valid settings for parameter southBoundChunkedSetting.
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
 
toString() - Method in exception oracle.sdp.daf.spi.SLAException
Returns a string representation of the object.
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.
tracePolicy(String, ArrayNode) - 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.
updateBlackMethodList(String) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Update the black method list.
updateBlackMethodList(String) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
updateBlackPackageList(String) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Update the black package list.
updateBlackPackageList(String) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
updateDafCSConfigurations(String) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Set the configurations of communication services.
updateDafCSConfigurations(String) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
updateWhiteMethodList(String) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Update the white method list.
updateWhiteMethodList(String) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
updateWhitePackageList(String) - Method in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
Update the white package list.
updateWhitePackageList(String) - Method in class oracle.sdp.daf.configurations.DafGeneralInfoHelper
 
UrlPathTree - Interface in oracle.sdp.daf.spi
URL Path Tree interface.
useSession - Static variable in interface oracle.sdp.daf.configurations.DafConfigurationsMBean
If true, allows an application to use a session when communicating with backend servers The default value is false.

V

validateOAuth(String, String) - Method in interface oracle.sdp.daf.spi.OAuth2Validator
validate whether the request OAuth token is valid.
validateSLA(HttpContext, Subject, 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.configurations.SouthBoundChunkedSetting
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.configurations.SouthBoundChunkedSetting
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 input stream.
withCallback(CalloutCallbackHandler) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Adds callback handler.
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.Overwrite the value which is set by MessageBuilder.addHeader(String, String) before in the invocation sequence.
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.
withQueryParameterMultiValue(String, String[]) - Method in interface oracle.sdp.daf.action.api.CalloutBuilder
Adds or overwrites an individual query parameter with ability to provide multi-value array.
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 K M O P R S T U V W 
Skip navigation links
Oracle© Communications Services Gatekeeper Actions Java API Reference
E96579-01
7.0

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