public class

ODataClientRequest

extends Object
java.lang.Object
   ↳ org.odata4j.consumer.ODataClientRequest

Class Overview

Generic OData http request builder. Only interesting for developers of custom OClientBehavior implementations.

Summary

Fields
private final Map<String, String> headers
private final String method
private final Object payload
private final Map<String, String> queryParams
private final String url
Public Constructors
ODataClientRequest(String method, String url, Map<String, String> headers, Map<String, String> queryParams, Object payload)
Public Methods
static ODataClientRequest delete(String url)
Creates a new DELETE request.
static ODataClientRequest get(String url)
Creates a new GET request.
Map<String, String> getHeaders()
Gets the request http headers.
String getMethod()
Gets the request http method.
Object getPayload()
Gets the normalized OData payload.
Map<String, String> getQueryParams()
Gets the request query parameters.
String getUrl()
Gets the request url.
ODataClientRequest header(String name, String value)
Sets an http request header.
static ODataClientRequest merge(String url, SingleLink link)
Creates a new MERGE request.
static ODataClientRequest merge(String url, Entry entry)
Creates a new MERGE request.
ODataClientRequest method(String method)
Sets the http request method.
static ODataClientRequest post(String url, Entry entry)
Creates a new POST request.
static ODataClientRequest post(String url, SingleLink link)
Creates a new POST request.
static ODataClientRequest put(String url, SingleLink link)
Creates a new PUT request.
static ODataClientRequest put(String url, Entry entry)
Creates a new PUT request.
ODataClientRequest queryParam(String name, String value)
Sets a request query parameter.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private final Map<String, String> headers

private final String method

private final Object payload

private final Map<String, String> queryParams

private final String url

Public Constructors

public ODataClientRequest (String method, String url, Map<String, String> headers, Map<String, String> queryParams, Object payload)

Parameters
method
url
headers
queryParams
payload

Public Methods

public static ODataClientRequest delete (String url)

Creates a new DELETE request.

Parameters
url The request url
Returns
  • a new request builder

public static ODataClientRequest get (String url)

Creates a new GET request.

Parameters
url The request url
Returns
  • a new request builder

public Map<String, String> getHeaders ()

Gets the request http headers.

Returns
  • the headers

public String getMethod ()

Gets the request http method.

Returns
  • the http method

public Object getPayload ()

Gets the normalized OData payload.

Returns
  • the normalized OData payload

public Map<String, String> getQueryParams ()

Gets the request query parameters.

Returns
  • the query parameters

public String getUrl ()

Gets the request url.

Returns
  • the url

public ODataClientRequest header (String name, String value)

Sets an http request header.

Parameters
name The header name
value The header value
Returns
  • the request builder

public static ODataClientRequest merge (String url, SingleLink link)

Creates a new MERGE request.

Parameters
url The request url
link The link
Returns
  • a new request builder

public static ODataClientRequest merge (String url, Entry entry)

Creates a new MERGE request.

Parameters
url The request url
entry The normalized OData payload
Returns
  • a new request builder

public ODataClientRequest method (String method)

Sets the http request method.

Parameters
method The method
Returns
  • the request builder

public static ODataClientRequest post (String url, Entry entry)

Creates a new POST request.

Parameters
url The request url
entry The normalized OData payload
Returns
  • a new request builder

public static ODataClientRequest post (String url, SingleLink link)

Creates a new POST request.

Parameters
url The request url
link The link
Returns
  • a new request builder

public static ODataClientRequest put (String url, SingleLink link)

Creates a new PUT request.

Parameters
url The request url
link The link
Returns
  • a new request builder

public static ODataClientRequest put (String url, Entry entry)

Creates a new PUT request.

Parameters
url The request url
entry The normalized OData payload
Returns
  • a new request builder

public ODataClientRequest queryParam (String name, String value)

Sets a request query parameter.

Parameters
name The query parameter name
value The query parameter value
Returns
  • the request builder