org.apache.olingo.client.core.communication.request

Class AbstractODataRequest

java.lang.Object

org.apache.olingo.client.core.communication.request.AbstractRequest

org.apache.olingo.client.core.communication.request.AbstractODataRequest

All Implemented Interfaces:

org.apache.olingo.client.api.communication.request.ODataRequest

Direct Known Subclasses:

AbstractODataBasicRequest, AbstractODataStreamedRequest, ODataRawRequestImpl

public abstract class AbstractODataRequest
extends AbstractRequest
implements org.apache.olingo.client.api.communication.request.ODataRequest

Abstract representation of an OData request. Get instance by using factories.

See Also:

CUDRequestFactory, BatchRequestFactory, InvokeRequestFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.HttpClient	httpClient HTTP client.
protected org.apache.olingo.commons.api.http.HttpMethod	method OData request method.
protected org.apache.olingo.client.api.ODataClient	odataClient
protected org.apache.olingo.client.api.communication.header.ODataHeaders	odataHeaders OData request header.
protected org.apache.http.client.methods.HttpUriRequest	request HTTP request.
protected URI	uri Target URI.

Fields inherited from class org.apache.olingo.client.core.communication.request.AbstractRequest

LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractODataRequest(org.apache.olingo.client.api.ODataClient odataClient, org.apache.olingo.commons.api.http.HttpMethod method, URI uri) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.olingo.client.api.communication.request.ODataRequest	addCustomHeader(String name, String value)
protected org.apache.http.HttpResponse	doExecute() Builds the request and execute it.
String	getAccept()
String	getContentType()
abstract org.apache.olingo.commons.api.format.ContentType	getDefaultFormat()
org.apache.olingo.client.api.communication.header.ODataHeaders	getHeader() Gets request headers.
String	getHeader(String name)
Collection<String>	getHeaderNames()
String	getIfMatch()
String	getIfNoneMatch()
org.apache.olingo.commons.api.http.HttpMethod	getMethod()
String	getPrefer()
<V extends org.apache.olingo.client.api.communication.response.ODataResponse> V	getResponseTemplate() Gets an empty response that can be initialized by a stream.
URI	getURI()
InputStream	rawExecute()
org.apache.olingo.client.api.communication.request.ODataRequest	setAccept(String value)
org.apache.olingo.client.api.communication.request.ODataRequest	setContentType(String value)
org.apache.olingo.client.api.communication.request.ODataRequest	setIfMatch(String value)
org.apache.olingo.client.api.communication.request.ODataRequest	setIfNoneMatch(String value)
org.apache.olingo.client.api.communication.request.ODataRequest	setPrefer(String value)
void	setURI(URI uri)
org.apache.olingo.client.api.communication.request.ODataRequest	setXHTTPMethod(String value)
byte[]	toByteArray()

Methods inherited from class org.apache.olingo.client.core.communication.request.AbstractRequest

checkRequest, checkResponse

Methods inherited from class java.lang.Object

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

Field Detail

odataClient

protected final org.apache.olingo.client.api.ODataClient odataClient

method

protected final org.apache.olingo.commons.api.http.HttpMethod method

OData request method.

odataHeaders

protected final org.apache.olingo.client.api.communication.header.ODataHeaders odataHeaders

OData request header.

uri

protected URI uri

Target URI.

httpClient

protected org.apache.http.client.HttpClient httpClient

HTTP client.

request

protected org.apache.http.client.methods.HttpUriRequest request

HTTP request.

Constructor Detail

AbstractODataRequest

protected AbstractODataRequest(org.apache.olingo.client.api.ODataClient odataClient,
                               org.apache.olingo.commons.api.http.HttpMethod method,
                               URI uri)

Constructor.

Parameters:

odataClient - client instance getting this request

method - HTTP request method. If configured X-HTTP-METHOD header will be used.

uri - OData request URI.

Method Detail

getDefaultFormat

public abstract org.apache.olingo.commons.api.format.ContentType getDefaultFormat()

getURI

public URI getURI()

Specified by:

getURI in interface org.apache.olingo.client.api.communication.request.ODataRequest

setURI

public void setURI(URI uri)

Specified by:

setURI in interface org.apache.olingo.client.api.communication.request.ODataRequest

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface org.apache.olingo.client.api.communication.request.ODataRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface org.apache.olingo.client.api.communication.request.ODataRequest

setAccept

public org.apache.olingo.client.api.communication.request.ODataRequest setAccept(String value)

Specified by:

setAccept in interface org.apache.olingo.client.api.communication.request.ODataRequest

setIfMatch

public org.apache.olingo.client.api.communication.request.ODataRequest setIfMatch(String value)

Specified by:

setIfMatch in interface org.apache.olingo.client.api.communication.request.ODataRequest

setIfNoneMatch

public org.apache.olingo.client.api.communication.request.ODataRequest setIfNoneMatch(String value)

Specified by:

setIfNoneMatch in interface org.apache.olingo.client.api.communication.request.ODataRequest

setPrefer

public org.apache.olingo.client.api.communication.request.ODataRequest setPrefer(String value)

Specified by:

setPrefer in interface org.apache.olingo.client.api.communication.request.ODataRequest

setXHTTPMethod

public org.apache.olingo.client.api.communication.request.ODataRequest setXHTTPMethod(String value)

Specified by:

setXHTTPMethod in interface org.apache.olingo.client.api.communication.request.ODataRequest

setContentType

public org.apache.olingo.client.api.communication.request.ODataRequest setContentType(String value)

Specified by:

setContentType in interface org.apache.olingo.client.api.communication.request.ODataRequest

addCustomHeader

public org.apache.olingo.client.api.communication.request.ODataRequest addCustomHeader(String name,
                                                                                       String value)

Specified by:

addCustomHeader in interface org.apache.olingo.client.api.communication.request.ODataRequest

getAccept

public String getAccept()

Specified by:

getAccept in interface org.apache.olingo.client.api.communication.request.ODataRequest

getIfMatch

public String getIfMatch()

Specified by:

getIfMatch in interface org.apache.olingo.client.api.communication.request.ODataRequest

getIfNoneMatch

public String getIfNoneMatch()

Specified by:

getIfNoneMatch in interface org.apache.olingo.client.api.communication.request.ODataRequest

getPrefer

public String getPrefer()

Specified by:

getPrefer in interface org.apache.olingo.client.api.communication.request.ODataRequest

getContentType

public String getContentType()

Specified by:

getContentType in interface org.apache.olingo.client.api.communication.request.ODataRequest

getMethod

public org.apache.olingo.commons.api.http.HttpMethod getMethod()

Specified by:

getMethod in interface org.apache.olingo.client.api.communication.request.ODataRequest

getHeader

public org.apache.olingo.client.api.communication.header.ODataHeaders getHeader()

Gets request headers.

Returns:

request headers.

toByteArray

public byte[] toByteArray()

Specified by:

toByteArray in interface org.apache.olingo.client.api.communication.request.ODataRequest

rawExecute

public InputStream rawExecute()

Specified by:

rawExecute in interface org.apache.olingo.client.api.communication.request.ODataRequest

doExecute

protected org.apache.http.HttpResponse doExecute()

Builds the request and execute it.

Returns:

HttpReponse object.

getResponseTemplate

public <V extends org.apache.olingo.client.api.communication.response.ODataResponse> V getResponseTemplate()

Gets an empty response that can be initialized by a stream.
This method has to be used to build response items about a batch request.

Type Parameters:

V - ODataResponse type.

Returns:

empty OData response instance.