oracle.epm.api.model.rest

Class HttpRequestWithBody

java.lang.Object

oracle.epm.api.model.rest.BaseRequest

oracle.epm.api.model.rest.HttpRequest

oracle.epm.api.model.rest.HttpRequestWithBody

public class HttpRequestWithBody
extends HttpRequest

This object represents an HTTP request with a body specified to an external or an Oracle Cloud Service resource.

By default, parameters are case insensitive and may not be null or empty unless otherwise specified.

Field Summary

Fields inherited from class oracle.epm.api.model.rest.HttpRequest

bodyEntity

Fields inherited from class oracle.epm.api.model.rest.BaseRequest

connection, httpRequest

Method Summary

Modifier and Type	Method and Description
HttpRequestWithBody	body(java.lang.String body) Returns this object after setting the body as a String.
HttpRequestWithBody	header(java.lang.String name, java.lang.String value) Returns this request after setting the specified header.
HttpRequestWithBody	headers(java.util.Map<java.lang.String,java.lang.String> headerMap) Returns this request after setting the specified headers.
HttpRequestWithBody	pathParam(java.lang.String name, java.lang.String value) Returns this request after setting the sepcified dynamic parameter value in the URL.
HttpRequestWithBody	queryParam(java.util.Map<java.lang.String,?> parameters) Returns this request after setting the specified query parameters.
HttpRequestWithBody	queryParam(java.lang.String name, java.lang.Object value) Returns this request after setting the specified query parameter.

Methods inherited from class oracle.epm.api.model.rest.HttpRequest

getAccessToken, getBodyEntity, getHeaders, getHttpMethod, getPassword, getQueryParams, getUrl, getUserName, isLocalHost, queryParam, queryParams

Methods inherited from class oracle.epm.api.model.rest.BaseRequest

asString, getHttpRequest, getHttpRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

body

public HttpRequestWithBody body(java.lang.String body)

Returns this object after setting the body as a String.

Parameters:

body - body as String

Returns:

this object after setting the body as a String

header

public HttpRequestWithBody header(java.lang.String name,
                                  java.lang.String value)

Returns this request after setting the specified header.

The request headers will be merged into the default headers configured/saved with the connection. The request header will win if a header with the same name exists in both the default and the request headers.

Overrides:

header in class HttpRequest

Parameters:

name - name of the header

value - value for the header

Returns:

this request after setting the specified header

headers

public HttpRequestWithBody headers(java.util.Map<java.lang.String,java.lang.String> headerMap)

Returns this request after setting the specified headers.

This method can be called to set multiple request headers at once.

The request headers will be merged into the default headers configured/saved with the connection. The request header will win if a header with the same name exists in both the default and the request headers.

Overrides:

headers in class HttpRequest

Parameters:

headerMap - map of headers and the correponding values

Returns:

this request after setting the specified headers

pathParam

public HttpRequestWithBody pathParam(java.lang.String name,
                                     java.lang.String value)

Returns this request after setting the sepcified dynamic parameter value in the URL.

This method can be called to set the value for dynamic parameters if there are placeholders in the URL configured in the connection.

Overrides:

pathParam in class HttpRequest

Parameters:

name - name of the dynamic parameter

value - value for dynamic parameter

Returns:

this request after setting the sepcified dynamic parameter value in the URL

queryParam

public HttpRequestWithBody queryParam(java.util.Map<java.lang.String,?> parameters)

Returns this request after setting the specified query parameters.

This method can be called to set multiple query parameters at once.

The query parameters will be merged into the default query parameters configured/saved with the connection. The request query parameters will win if a query parameters with the same name exists in both the default and the request query parameters.

This method has been deprecated and replaced by HttpRequest.queryParams(Map)

Overrides:

queryParam in class HttpRequest

Parameters:

parameters - map of query parameters and the correponding values

Returns:

this request after setting the specified query parameters

queryParam

public HttpRequestWithBody queryParam(java.lang.String name,
                                      java.lang.Object value)

Returns this request after setting the specified query parameter.

The query parameter will be merged into the default query parameters configured/saved with the connection. The request query parameters will win if a query parameters with the same name exists in both the default and the request query parameters.

Overrides:

queryParam in class HttpRequest

Parameters:

name - name of the query parameter

value - value for the query parameter

Returns:

this request after setting the specified query parameter