oracle.sdp.daf.action.api

Interface HttpRequest

All Superinterfaces:

HttpMessage

public interface HttpRequest
extends HttpMessage

Http Request.

Method Summary

Modifier and Type	Method and Description
String	getApiPathInfo() Retrieves the path info related to this API.
String	getMethod() Retrieves the method.
String	getPathInfo() Retrieves the path information.
Map<String,String>	getQueryParameters() Deprecated. Use getQueryParametersMultiValue instead
default Map<String,String[]>	getQueryParametersMultiValue() Retrieves the query parameters as multi-value array.
String	getQueryString() Retrieves the query string.
String	getRemoteHost() Retrieves the remote host.
Integer	getRemotePort() Retrieves the remote port.
String	getRequestURI() Retrieves the request URI.

Methods inherited from interface oracle.sdp.daf.action.api.HttpMessage

getBodyAsType, getHeader, getHeaders

Method Detail

getMethod

String getMethod()

Retrieves the method.

Returns:

The method

getRequestURI

String getRequestURI()

Retrieves the request URI.

Returns:

The request URI.

getQueryParameters

@Deprecated
Map<String,String> getQueryParameters()

Deprecated. Use getQueryParametersMultiValue instead

Retrieves the query parameters.

Returns:

A map of query parameters

getQueryParametersMultiValue

default Map<String,String[]> getQueryParametersMultiValue()

Retrieves the query parameters as multi-value array.

Returns:

A map of query parameters

Since:

7.0.0.0

getPathInfo

String getPathInfo()

Retrieves the path information.

Returns:

the path information

getQueryString

String getQueryString()

Retrieves the query string.

Returns:

The query string

getRemoteHost

String getRemoteHost()

Retrieves the remote host.

Returns:

The remote host

getRemotePort

Integer getRemotePort()

Retrieves the remote port.

Returns:

The remote port

getApiPathInfo

String getApiPathInfo()

Retrieves the path info related to this API. Example: If the context root of this API is '/myapi/' and the pathInfo is '/myapi/mypage/test' then this will return 'mypage/test'

Returns:

the path info without the APIs service URL.