- getApiId() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Returns unique API Id
- getApiId() - Method in interface oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeInitContext
-
Returns unique API Id associated with this policy runtime
- getApiRequest() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Returns the object to help access the contents in API request
- getApiResponse() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Returns the object to help manipulate the contents of API response
- getApiUrl() - Method in interface oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeInitContext
-
Returns the relative URL of the API endpoint
- getAppId() - Method in interface oracle.apiplatform.policies.sdk.context.ApplicationContext
-
Retrieve application identifier
- getAppKey() - Method in interface oracle.apiplatform.policies.sdk.context.ApplicationContext
-
Retrieve application-specific key, optionally used by the application to call the API and policy chain.
- getApplicationContext() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Retrieve the object to help access information about an application associated with this API request, if any
- getAttribute(String) - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Retrieves the object based on a name.
- getBody() - Method in interface oracle.apiplatform.policies.sdk.context.IncomingMessage
-
- getContentType() - Method in interface oracle.apiplatform.policies.sdk.context.Body
-
Returns the payload content type, if available
- getContentType() - Method in class oracle.apiplatform.policies.sdk.context.InputStreamBodyImpl
-
- getContentType() - Method in class oracle.apiplatform.policies.sdk.context.StringBodyImpl
-
- getDetail() - Method in exception oracle.apiplatform.policies.sdk.exceptions.PolicyProcessingException
-
Returns the detail
- getEdr(String) - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Retrieves the value of event data record with a given key, if previously set with setEdr()
- getGatewayId() - Method in interface oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeInitContext
-
Returns the Id of the gateway instance on which the API is deployed
- getGatewayType() - Method in interface oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeInitContext
-
For those few "special" policies, where policy runtime behavior depends on the type of the gateway code is being executed on.
- getHeader(String) - Method in interface oracle.apiplatform.policies.sdk.context.IncomingMessage
-
Gets the specific header if it exists.
- getHeaders() - Method in interface oracle.apiplatform.policies.sdk.context.IncomingMessage
-
Gets all transport-level headers associated with the message
- getHttpCode() - Method in exception oracle.apiplatform.policies.sdk.exceptions.PolicyProcessingException
-
Returns the HTTP code
- getId() - Method in exception oracle.apiplatform.policies.sdk.exceptions.PolicyProcessingException
-
Returns the ID
- getIterationId() - Method in interface oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeInitContext
-
Returns API iteration Id
- getMethod() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRequest
-
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
- getMethod() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Returns the HTTP method to be used for outbound service request only if one was explicitly set via setMethod()
- getOrDefaultBody() - Method in interface oracle.apiplatform.policies.sdk.context.OutgoingMessage
-
Returns the body of the outgoing message to be sent out
- getOrDefaultHeaders() - Method in interface oracle.apiplatform.policies.sdk.context.OutgoingMessage
-
Returns the entire set of transport-level headers to be used for outgoing message.
- getOrDefaultMethod() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Returns the HTTP method to be used for outbound service request which was either set set explicitly or passed through from API request
- getOrDefaultQueryParams() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Returns query parameters to be used for outbound service request.
- getPathInfo() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRequest
-
Returns any extra path information associated with the URL the client sent when it made this request.
- getPathInfo() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Returns the path info - the resource part of the url.
- getPolicyInstanceId() - Method in interface oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeInitContext
-
Returns policy instance id
- getQueryParams() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRequest
-
Retrieves the query parameters
- getQueryParams() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Returns query parameters to be used for outbound service request in a map keyed by parameter name
- getQueryString() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRequest
-
Retrieves the query string
- getRemoteHost() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRequest
-
Returns the fully qualified name of the client or the last proxy that sent the request.
- getRequestURI() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRequest
-
Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
- getRequestURL() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Returns the URL to be used for outbound service request
- getRuntime(PolicyRuntimeInitContext, JSONObject) - Method in interface oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeFactory
-
Will be called by the policy execution engine at initialization time in order to "create" an instance of a given policy
- getService() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
- getService() - Method in interface oracle.apiplatform.policies.sdk.runtime.ServiceRequestPolicyRuntime
-
- getServiceAccount() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
- getServiceAccount() - Method in interface oracle.apiplatform.policies.sdk.runtime.ServiceRequestPolicyRuntime
-
- getServiceRequest() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Retrieve the object to help manipulate the contents of outbound service request
- getServiceRequest(ApiRuntimeContext) - Method in interface oracle.apiplatform.policies.sdk.runtime.ServiceRequestPolicyRuntime
-
- getServiceResponse() - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Retrieve the object to help access the contents in outbound service response
- getStatusCode() - Method in interface oracle.apiplatform.policies.sdk.context.ApiResponse
-
Returns the status code associated with this response
- getStatusCode() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceResponse
-
Returns the status code, e.g.
- getStatusText() - Method in interface oracle.apiplatform.policies.sdk.context.ApiResponse
-
Returns the status text associated with this response
- getStatusText() - Method in interface oracle.apiplatform.policies.sdk.context.ServiceResponse
-
Returns the status text
- getSystemService(Class<T>) - Method in interface oracle.apiplatform.policies.sdk.runtime.PolicyRuntimeInitContext
-
Returns an instance of the "system"-provided service identified by the class name.
- ServiceRequest - Interface in oracle.apiplatform.policies.sdk.context
-
Service Request.
- ServiceRequestPolicyRuntime - Interface in oracle.apiplatform.policies.sdk.runtime
-
- ServiceResponse - Interface in oracle.apiplatform.policies.sdk.context
-
Service Response.
- setAttribute(String, Object) - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Allows the storage of objects between invocations in the policy pipeline.
- setBody(Body) - Method in interface oracle.apiplatform.policies.sdk.context.OutgoingMessage
-
Lets the caller set the body of the outgoing message
- setEdr(String, Object) - Method in interface oracle.apiplatform.policies.sdk.context.ApiRuntimeContext
-
Adds or "publishes" an event data record with a given key
- setHeader(String, String) - Method in interface oracle.apiplatform.policies.sdk.context.OutgoingMessage
-
Adds or overrides a transport-level header with a given name for outgoing message
- setHeaders(Map<String, List<String>>) - Method in interface oracle.apiplatform.policies.sdk.context.OutgoingMessage
-
Overrides the entire set of transport-level headers to be used for outgoing message with the given map
- setMethod(String) - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Sets the HTTP method string to be used for outbound request.
- setPathInfo(String) - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Sets the path info to add additional strings to the request Url, without touching the request URL.
- setQueryParam(String, String) - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Sets a single query parameter to be used for outbound service request to a given value
- setQueryParams(Map<String, List<String>>) - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Sets the entire set of query parameters to be used for outbound request in a map keyed by parameter name
- setRequestURL(String) - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Sets the request url to the given value
- setService(String) - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Sets the service object to be associated with outbound service request
- setServiceAccount(String) - Method in interface oracle.apiplatform.policies.sdk.context.ServiceRequest
-
Sets the service account to be associated with outbound service request The account may be basic auth or OAuth
- setStatusCode(int) - Method in interface oracle.apiplatform.policies.sdk.context.ApiResponse
-
Sets the status code for this response.
- setStatusText(String) - Method in interface oracle.apiplatform.policies.sdk.context.ApiResponse
-
Sets the status text for this response.
- StringBodyImpl - Class in oracle.apiplatform.policies.sdk.context
-
A utility class that implements
Body
interface based on the String as the source of payload
- StringBodyImpl(String, String) - Constructor for class oracle.apiplatform.policies.sdk.context.StringBodyImpl
-