oracle.apiplatform.policies.sdk.context

Interface ServiceRequest

All Superinterfaces:

IncomingMessage, OutgoingMessage

public interface ServiceRequest
extends OutgoingMessage

Service Request

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMethod()
java.lang.String	getOrDefaultMethod()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getOrDefaultQueryParams()
java.lang.String	getPathInfo()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getQueryParams()
java.lang.String	getRequestURL()
ServiceRequest	setMethod(java.lang.String method)
ServiceRequest	setPathInfo(java.lang.String pathInfo)
ServiceRequest	setQueryParam(java.lang.String name, java.lang.String value)
ServiceRequest	setQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)
ServiceRequest	setRequestURL(java.lang.String url) sets the request url to the given value
ServiceRequest	withoutQueryParam(java.lang.String name) Send the message without this query parameter.

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

getMethod

java.lang.String getMethod()

setMethod

ServiceRequest setMethod(java.lang.String method)

getOrDefaultMethod

java.lang.String getOrDefaultMethod()

Returns:

method that was set to service request or the one from corresponding Api request

getQueryParams

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getQueryParams()

setQueryParams

ServiceRequest setQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)

setQueryParam

ServiceRequest setQueryParam(java.lang.String name,
                             java.lang.String value)

getPathInfo

java.lang.String getPathInfo()

setPathInfo

ServiceRequest setPathInfo(java.lang.String pathInfo)
                    throws java.io.IOException

Throws:

java.io.IOException

setRequestURL

ServiceRequest setRequestURL(java.lang.String url)
                      throws java.io.IOException

sets the request url to the given value

Parameters:

url -

Returns:

Throws:

java.io.IOException

getRequestURL

java.lang.String getRequestURL()

Returns:

the request url

getOrDefaultQueryParams

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getOrDefaultQueryParams()

Returns:

All the query-params including ones from the incoming message

withoutQueryParam

ServiceRequest withoutQueryParam(java.lang.String name)

Send the message without this query parameter. Will remove query parameter if 'setQueryParam' has been called before this.

Parameters:

name -

Returns: