oracle.sdp.daf.action.api

Interface CalloutBuilder

All Superinterfaces:

MessageBuilder

All Known Subinterfaces:

ExternalCalloutBuilder

public interface CalloutBuilder
extends MessageBuilder

Callout builder. Used to build a callout HTTP request.

Method Summary

Modifier and Type	Method and Description
default CalloutCallbackHandler	getCallbackHandler() Gets the callback handler associated with this builder.
String	getPathInfo() Retrieve the path info - the resource part of the url.
String	getQueryParameter(String key) Gets the query parameter corresponding to the key.
Map<String,String>	getQueryParameters() Deprecated. Use getQueryParametersMultiValue instead
default Map<String,String[]>	getQueryParametersMultiValue() Returns the query parameters as multi-value array.
String	getQueryString() Gets the query string.
String	getRequestMethod() Gets the request Method.
String	getRequestUrl() Gets the request URL.
void	ignoreAllRequestQueryParameters(boolean ignore) Removes all query parameters from the original client request message.
default CalloutBuilder	withCallback(CalloutCallbackHandler callbackHandler) Adds callback handler.
void	withoutQueryParameter(String key) Sends the request message without a query parameter that you specify.
CalloutBuilder	withPathInfo(String pathInfo) PathInfo.
CalloutBuilder	withQueryParameter(String key, String value) Adds or overwrites an individual query parameter.
default CalloutBuilder	withQueryParameterMultiValue(String key, String[] values) Adds or overwrites an individual query parameter with ability to provide multi-value array.
CalloutBuilder	withQueryString(String queryString) Changes queryString parameters.
CalloutBuilder	withRequestMethod(String method) Changes the request method.
CalloutBuilder	withRequestUrl(String url) Changes the request URL.

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

addHeader, getBodyAsObject, getBodyAsStream, getBodyAsType, getCombinedHeaders, getHeader, ignoreAllRequestHeaders, withBodyAsObject, withBodyAsStream, withHeader, withHeaders, withoutHeader

Method Detail

withCallback

default CalloutBuilder withCallback(CalloutCallbackHandler callbackHandler)

Adds callback handler.

Parameters:

callbackHandler - The callback for this builder

Returns:

The builder

Since:

7.0.0.0

getCallbackHandler

default CalloutCallbackHandler getCallbackHandler()

Gets the callback handler associated with this builder.

Returns:

The callback handler

Since:

7.0.0.0

withRequestUrl

CalloutBuilder withRequestUrl(String url)

Changes the request URL.

Parameters:

url - The URL

Returns:

The builder

withPathInfo

CalloutBuilder withPathInfo(String pathInfo)

PathInfo. Optional. Can be used to add additional strings to the request Url, without touching the request URL.

Parameters:

pathInfo - pathInfo

Returns:

the builder

getPathInfo

String getPathInfo()

Retrieve the path info - the resource part of the url. Only set if withPathInfo has been called in this action chain execution.

Returns:

the path info string

getRequestUrl

String getRequestUrl()

Gets the request URL.

Returns:

the request URL

withQueryString

CalloutBuilder withQueryString(String queryString)

Changes queryString parameters. Overwrites individual keys if they exist, and creates them if they don't. The string syntax is "key1=value1&key2=value2..." The question mark wildcard character "?" is allowed at the beginning of a string.

Parameters:

queryString - The string containing the query parameters

Returns:

The builder

withQueryParameter

CalloutBuilder withQueryParameter(String key,
                                  String value)

Adds or overwrites an individual query parameter.

Parameters:

key - The key of the query parameter

value - The value of the query parameter

Returns:

The builder

withQueryParameterMultiValue

default CalloutBuilder withQueryParameterMultiValue(String key,
                                                    String[] values)

Adds or overwrites an individual query parameter with ability to provide multi-value array.

Parameters:

key - The key of the query parameter

values - The multi-value array of the query parameter

Returns:

The builder

Since:

7.0.0.0

getQueryString

String getQueryString()

Gets the query string.

Returns:

The query string.

getQueryParameter

String getQueryParameter(String key)

Gets the query parameter corresponding to the key.

Parameters:

key - The the key to find the parameter value under

Returns:

The query parameter value corresponding to the key

withoutQueryParameter

void withoutQueryParameter(String key)

Sends the request message without a query parameter that you specify. Removes the query parameter if 'withQueryParameter' has been called before this.

Parameters:

key - the query parameter to remove

ignoreAllRequestQueryParameters

void ignoreAllRequestQueryParameters(boolean ignore)

Removes all query parameters from the original client request message.

Parameters:

ignore - true to remove all request query parameters, false (the default) merges the parameters with others.

getQueryParameters

@Deprecated
Map<String,String> getQueryParameters()

Deprecated. Use getQueryParametersMultiValue instead

Returns the query parameters.

Returns:

The query parameters.

getQueryParametersMultiValue

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

Returns the query parameters as multi-value array.

Returns:

The query parameters.

Since:

7.0.0.0

withRequestMethod

CalloutBuilder withRequestMethod(String method)

Changes the request method.

Parameters:

method - The method

Returns:

The builder.

getRequestMethod

String getRequestMethod()

Gets the request Method.

Returns:

the request method