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

Class AbstractODataInvokeRequest<T extends ClientInvokeResult>

java.lang.Object

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

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

org.apache.olingo.client.core.communication.request.AbstractODataBasicRequest<ODataInvokeResponse<T>>

org.apache.olingo.client.core.communication.request.invoke.AbstractODataInvokeRequest<T>

All Implemented Interfaces:

ODataInvokeRequest<T>, ODataBasicRequest<ODataInvokeResponse<T>>, ODataBatchableRequest, ODataRequest

Direct Known Subclasses:

ODataInvokeRequestImpl

public abstract class AbstractODataInvokeRequest<T extends ClientInvokeResult>
extends AbstractODataBasicRequest<ODataInvokeResponse<T>>
implements ODataInvokeRequest<T>, ODataBatchableRequest

This class implements an OData invoke operation request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractODataInvokeRequest.ODataInvokeResponseImpl	Response class about an ODataInvokeRequest.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,ClientValue>	parameters	Function parameters.
protected final Class<T>	reference

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

httpClient, method, odataClient, odataHeaders, request, uri

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

LOG

Constructor Summary

Constructors

Constructor	Description
AbstractODataInvokeRequest(ODataClient odataClient, Class<T> reference, HttpMethod method, URI uri)	Constructor.

Method Summary

Modifier and Type	Method	Description
ODataInvokeResponse<T>	execute()	Request execute.
ContentType	getDefaultFormat()
InputStream	getPayload()	Gets payload as an InputStream.
protected abstract ContentType	getPOSTParameterFormat()
void	setFormat(ContentType contentType)	Override configured request Content-Type.
void	setParameters(Map<String,ClientValue> parameters)	Sets operation parameters.

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

asyncExecute, batch, batch

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

addCustomHeader, doExecute, getAccept, getContentType, getHeader, getHeader, getHeaderNames, getHttpRequest, getIfMatch, getIfNoneMatch, getMethod, getPrefer, getResponseTemplate, getURI, rawExecute, setAccept, setContentType, setIfMatch, setIfNoneMatch, setPrefer, setURI, setXHTTPMethod, 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

Methods inherited from interface org.apache.olingo.client.api.communication.request.ODataBasicRequest

asyncExecute

Methods inherited from interface org.apache.olingo.client.api.communication.request.ODataBatchableRequest

batch, batch

Methods inherited from interface org.apache.olingo.client.api.communication.request.ODataRequest

addCustomHeader, getAccept, getContentType, getHeader, getHeaderNames, getHttpRequest, getIfMatch, getIfNoneMatch, getMethod, getPrefer, getURI, rawExecute, setAccept, setContentType, setIfMatch, setIfNoneMatch, setPrefer, setURI, setXHTTPMethod, toByteArray

Field Details

reference

protected final Class<T extends ClientInvokeResult> reference

parameters

protected Map<String,ClientValue> parameters

Function parameters.

Constructor Details

AbstractODataInvokeRequest

public AbstractODataInvokeRequest(ODataClient odataClient,
 Class<T> reference,
 HttpMethod method,
 URI uri)

Constructor.

Parameters:

odataClient - client instance getting this request

reference - reference class for invoke result

method - HTTP method of the request.

uri - URI that identifies the operation.

Method Details

setParameters

public void setParameters(Map<String,ClientValue> parameters)

Description copied from interface: ODataInvokeRequest

Sets operation parameters.

Specified by:

setParameters in interface ODataInvokeRequest<T extends ClientInvokeResult>

Parameters:

parameters - operation parameters.

getDefaultFormat

public ContentType getDefaultFormat()

Specified by:

getDefaultFormat in class AbstractODataRequest

setFormat

public void setFormat(ContentType contentType)

Description copied from interface: ODataBasicRequest

Override configured request Content-Type.

Specified by:

setFormat in interface ODataBasicRequest<T extends ClientInvokeResult>

Overrides:

setFormat in class AbstractODataBasicRequest<ODataInvokeResponse<T extends ClientInvokeResult>>

Parameters:

contentType - request Content-Type.

getPOSTParameterFormat

protected abstract ContentType getPOSTParameterFormat()

getPayload

public InputStream getPayload()

Description copied from class: AbstractODataBasicRequest

Gets payload as an InputStream.

Specified by:

getPayload in class AbstractODataBasicRequest<ODataInvokeResponse<T extends ClientInvokeResult>>

Returns:

InputStream for entire payload.

execute

public ODataInvokeResponse<T> execute()

Request execute.

Specified by:

execute in interface ODataBasicRequest<T extends ClientInvokeResult>

Returns:

return an OData response.