com.sap.cloud.server.odata

Class OnlineODataProvider

java.lang.Object

com.sap.cloud.server.odata.OnlineODataProvider

All Implemented Interfaces:

DataServiceProvider

public class OnlineODataProvider
extends java.lang.Object
implements DataServiceProvider

A data service provider for online OData.

Constructor Summary

Constructors

Constructor and Description
OnlineODataProvider(java.lang.String serviceName, java.lang.String serviceRoot) See OnlineODataProvider(String, String, HttpHandler).
OnlineODataProvider(java.lang.String serviceName, java.lang.String serviceRoot, HttpHandler httpHandler) Constructs an online OData provider.

Method Summary

Modifier and Type	Method and Description
void	acquireToken() If this data service requires a security token, then acquire it now.
void	beginTransaction() Begin a server transaction.
void	commit() Commit the current server transaction.
void	createEntity(EntityValue entity, HttpHeaders headers, RequestOptions options) Create an entity in the target system.
void	createLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options) Create a link from a source entity to a target entity.
void	createMedia(EntityValue entity, StreamBase content, HttpHeaders headers, RequestOptions options) Create a media entity with the specified content in the target system.
void	deleteByQuery(DataQuery query, HttpHeaders headers, RequestOptions options) Execute query to delete data from the target system.
void	deleteEntity(EntityValue entity, HttpHeaders headers, RequestOptions options) Delete an entity from the target system.
void	deleteLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options) Delete a link from a source entity to a target entity.
void	deleteRepeatableRequest(GuidValue requestID) Ask the server to forget (delete) the repeatable request with the specified requestID.
void	deleteRepeatableRequests(GuidValue clientID) Ask the server to forget (delete) the repeatable requests with the specified clientID.
void	deleteStream(EntityValue entity, StreamLink link, HttpHeaders headers, RequestOptions options) Delete the content of a stream property from the target system.
DeltaStream	deltaStream(DataQuery query) Execute a query and obtain the result as a stream of delta items.
ByteStream	downloadMedia(EntityValue entity, HttpHeaders headers, RequestOptions options) Obtain a stream for downloading the content of a media entity from the target system.
ByteStream	downloadStream(EntityValue entity, StreamLink link, HttpHeaders headers, RequestOptions options) Obtain a stream for downloading the content of a stream property from the target system.
DataContext	entityContext(EntitySet entitySet) See entityContext(EntitySet, StructureType, int, int).
DataContext	entityContext(EntitySet entitySet, StructureType derivedType) See entityContext(EntitySet, StructureType, int, int).
DataContext	entityContext(EntitySet entitySet, StructureType derivedType, int format) See entityContext(EntitySet, StructureType, int, int).
DataContext	entityContext(EntitySet entitySet, StructureType derivedType, int format, int version) See Also:
EntityStream	entityStream(DataQuery query) Execute a query and obtain the result as a stream of entity values.
DataValue	executeMethod(DataMethod method, ParameterList parameters, HttpHeaders headers, RequestOptions options) Execute a data method (action or function) in the target system.
QueryResult	executeQuery(DataQuery query, HttpHeaders headers, RequestOptions options) Execute a data query to get data from the target system.
CsdlDocument	fetchMetadata(HttpHeaders headers, RequestOptions options) Fetch latest service metadata and return it, but don't change the OnlineODataProvider.metadata property.
DataTransaction	getDataTransaction() Return obtain a thread-local transaction manager for this data service.
HttpCookies	getHttpCookies() Return obsolete.
HttpHeaders	getHttpHeaders() Return obsolete.
CsdlDocument	getMetadata() Return the OData CSDL document (service metadata).
NetworkOptions	getNetworkOptions() Return options for network communication, which for OData uses HTTP or HTTPS.
boolean	getPrettyTracing() Return should OnlineODataProvider.traceWithData show pretty-printed JSON/XML content? Defaults to false.
java.lang.String	getServiceName() Return the service name.
ServiceOptions	getServiceOptions() Return options for this data service, both client-side and server-side.
java.lang.String	getServiceRoot() Return the service root URL.
HttpCookies	getSessionCookies() Return HTTP cookies which should be sent in future online requests (by the current session / thread).
HttpHeaders	getSessionHeaders() Return HTTP headers which should be sent in future online requests (by the current session / thread).
HttpCookies	getSharedCookies() Return HTTP cookies which should be sent in future online requests (shared by all sessions / threads).
HttpHeaders	getSharedHeaders() Return HTTP headers which should be sent in future online requests (shared by all sessions / threads).
boolean	getTraceRequests() Return should all requests for this data service be traced? Defaults to false.
boolean	getTraceWithData() Return if OnlineODataProvider.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false.
boolean	hasMetadata() Return true if the service metadata has been loaded by OnlineODataProvider.loadMetadata, or is automatically available in a generated DataService proxy class.
void	loadMetadata(HttpHeaders headers, RequestOptions options) Load service metadata (if not already loaded).
void	login(java.lang.String username, java.lang.String password) Set the shared Authorization header to be used for HTTP/HTTPS with pre-emptive BASIC authentication.
java.lang.String	metadataText(int format) Return an OData metadata document for the current service.
void	pingServer(HttpHeaders headers, RequestOptions options) Ping the server, by sending a non-changing request that the server can respond to quickly.
void	processBatch(RequestBatch batch, HttpHeaders headers, RequestOptions options) Execute a request batch in the target system.
DataContext	queryContext() See queryContext(int).
DataContext	queryContext(int version) See Also:
void	rollback() Rollback the current server transaction.
java.lang.String	serviceDocument(int format) Return the service document, in XML or JSON format.
void	setMetadata(CsdlDocument value) Set the OData CSDL document (service metadata).
void	setPrettyTracing(boolean value) Set should OnlineODataProvider.traceWithData show pretty-printed JSON/XML content? Defaults to false.
void	setServiceRoot(java.lang.String value) Set the service root URL.
void	setTraceRequests(boolean value) Set should all requests for this data service be traced? Defaults to false.
void	setTraceWithData(boolean value) Set if OnlineODataProvider.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false.
void	transaction(com.sap.cloud.server.odata.core.Action0 work) Perform some work within a service-managed transaction.
void	unloadMetadata() Unload service metadata (if previously loaded).
void	updateEntity(EntityValue entity, HttpHeaders headers, RequestOptions options) Update an entity in the target system.
void	updateLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options) Update a link from a source entity to a target entity.
void	uploadMedia(EntityValue entity, StreamBase content, HttpHeaders headers, RequestOptions options) Upload content for a media entity to the target system Caution: Having too many threads simultaneously uploading streams may result in out-of-memory conditions on memory-constrained devices.
void	uploadStream(EntityValue entity, StreamLink link, StreamBase content, HttpHeaders headers, RequestOptions options) Upload content for a stream property to the target system.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnlineODataProvider

public OnlineODataProvider(java.lang.String serviceName,
                           java.lang.String serviceRoot)

See OnlineODataProvider(String, String, HttpHandler).

Parameters:

serviceName - ServiceName parameter.

serviceRoot - ServiceRoot parameter.

OnlineODataProvider

public OnlineODataProvider(java.lang.String serviceName,
                           java.lang.String serviceRoot,
                           HttpHandler httpHandler)

Constructs an online OData provider.

Parameters:

serviceName - Service name.

serviceRoot - Service root URL.

httpHandler - (nullable) HTTP handler (optional).

Method Detail

acquireToken

public void acquireToken()

If this data service requires a security token, then acquire it now.

See Also:

ServiceOptions.requiresToken.

beginTransaction

public void beginTransaction()

Begin a server transaction.

Specified by:

beginTransaction in interface DataServiceProvider

commit

public void commit()

Commit the current server transaction.

Specified by:

commit in interface DataServiceProvider

createEntity

public void createEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)

Create an entity in the target system. Automatically calls CsdlDocument.resolveEntity to ensure that EntityValue.entitySet is available.

Throws:

DataServiceException if the entity set hasn't been explicitly provided before calling createEntity and there isn't a unique entity set for the entity type.

See Also:

EntityValue.ofType, EntityValue.inSet.

Specified by:

createEntity in interface DataServiceProvider

Parameters:

entity - Entity to be created.

headers - Request-specific headers.

options - Request-specific options.

createLink

public void createLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)

Create a link from a source entity to a target entity.

Specified by:

createLink in interface DataServiceProvider

Parameters:

from - Source entity for the link to be created.

property - Source navigation property for the link to be created.

to - Target entity for the link to be created.

headers - Request-specific headers.

options - Request-specific options.

createMedia

public void createMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers,
                        RequestOptions options)

Create a media entity with the specified content in the target system. If the entity has non-stream structural properties in addition to the key properties and media content, such as label in the examples below, then this function will send two requests to the server: a first request to upload (POST) the media stream, and a second request (PATCH/PUT) to update the non-stream properties. It is not currently supported to make these two calls atomic. Caution: Having too many threads simultaneously creating streams may result in out-of-memory conditions on memory-constrained devices.

Specified by:

createMedia in interface DataServiceProvider

Parameters:

entity - Entity to be created.

content - Initial content. Must be a ByteStream or CharStream. Will be closed before this function returns.

headers - Request-specific headers.

options - Request-specific options.

deleteByQuery

public void deleteByQuery(DataQuery query,
                          HttpHeaders headers,
                          RequestOptions options)

Execute query to delete data from the target system.

Specified by:

deleteByQuery in interface DataServiceProvider

Parameters:

query - Data query specifying the information to be deleted.

headers - Request-specific headers.

options - Request-specific options.

deleteEntity

public void deleteEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)

Delete an entity from the target system.

Specified by:

deleteEntity in interface DataServiceProvider

Parameters:

entity - Entity to be deleted.

headers - Request-specific headers.

options - Request-specific options.

deleteLink

public void deleteLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)

Delete a link from a source entity to a target entity.

Specified by:

deleteLink in interface DataServiceProvider

Parameters:

from - Source entity for the link to be deleted.

property - Source navigation property for the link to be deleted.

to - Target entity for the link to be deleted.

headers - Request-specific headers.

options - Request-specific options.

deleteRepeatableRequest

public void deleteRepeatableRequest(GuidValue requestID)

Ask the server to forget (delete) the repeatable request with the specified requestID.

Parameters:

requestID - Repeatability-Request-ID header value used in previous repeatable request.

deleteRepeatableRequests

public void deleteRepeatableRequests(GuidValue clientID)

Ask the server to forget (delete) the repeatable requests with the specified clientID.

Parameters:

clientID - Repeatability-Client-ID header value used in previous repeatable requests.

deleteStream

public void deleteStream(EntityValue entity,
                         StreamLink link,
                         HttpHeaders headers,
                         RequestOptions options)

Delete the content of a stream property from the target system.

Specified by:

deleteStream in interface DataServiceProvider

Parameters:

entity - Entity containing the stream property whose content is to be deleted.

headers - Request-specific headers.

options - Request-specific options.

link - Stream link for the stream to be deleted.

deltaStream

public DeltaStream deltaStream(DataQuery query)

Execute a query and obtain the result as a stream of delta items.

Parameters:

query - Data query.

Returns:

Delta stream.

downloadMedia

public ByteStream downloadMedia(EntityValue entity,
                                HttpHeaders headers,
                                RequestOptions options)

Obtain a stream for downloading the content of a media entity from the target system. Caution: streams are often used for large content that may not fit (all at once) in available application memory. Having too many threads simultaneously downloading streams, or using ByteStream.readAndClose, may result in out-of-memory conditions on memory-constrained devices.

Specified by:

downloadMedia in interface DataServiceProvider

Parameters:

entity - Entity whose content is to be downloaded.

headers - Request-specific headers.

options - Request-specific options.

Returns:

A stream for downloading the content of a media entity. This must be closed by the caller, or else a resource leak may occur.

downloadStream

public ByteStream downloadStream(EntityValue entity,
                                 StreamLink link,
                                 HttpHeaders headers,
                                 RequestOptions options)

Obtain a stream for downloading the content of a stream property from the target system. Caution: streams are often used for large content that may not fit (all at once) in available application memory. Having too many threads simultaneously downloading streams, or using ByteStream.readAndClose, may result in out-of-memory conditions on memory-constrained devices.

See Also:

Property.getStreamLink.

Specified by:

downloadStream in interface DataServiceProvider

Parameters:

entity - Entity containing the stream property whose content is to be downloaded.

link - Stream link for the stream to be downloaded.

headers - Request-specific headers.

options - Request-specific options.

Returns:

A stream for downloading the content of a stream property. This must be closed by the caller, or else a resource leak may occur.

entityContext

public DataContext entityContext(EntitySet entitySet)

See entityContext(EntitySet, StructureType, int, int).

Parameters:

entitySet - EntitySet parameter.

Returns:

(see linked method).

entityContext

public DataContext entityContext(EntitySet entitySet,
                                 StructureType derivedType)

See entityContext(EntitySet, StructureType, int, int).

Parameters:

entitySet - EntitySet parameter.

derivedType - DerivedType parameter.

Returns:

(see linked method).

entityContext

public DataContext entityContext(EntitySet entitySet,
                                 StructureType derivedType,
                                 int format)

See entityContext(EntitySet, StructureType, int, int).

Parameters:

entitySet - EntitySet parameter.

derivedType - DerivedType parameter.

format - Format parameter.

Returns:

(see linked method).

entityContext

public DataContext entityContext(EntitySet entitySet,
                                 StructureType derivedType,
                                 int format,
                                 int version)

See Also:

DataFormat, DataVersion, ServiceOptions.

Specified by:

entityContext in interface DataServiceProvider

Parameters:

entitySet - Entity set for the context.

derivedType - (nullable) Derived type for query results.

format - Data format for the context. If zero or not specified, then the ServiceOptions.dataFormat for this data service is used.

version - Data version for the context. If zero or not specified, then the ServiceOptions.dataVersion for this data service is used.

Returns:

A data context object for the specified entity set, data format and data version.

entityStream

public EntityStream entityStream(DataQuery query)

Execute a query and obtain the result as a stream of entity values.

Parameters:

query - Data query.

Returns:

Entity stream.

executeMethod

public DataValue executeMethod(DataMethod method,
                               ParameterList parameters,
                               HttpHeaders headers,
                               RequestOptions options)

Execute a data method (action or function) in the target system. Actions may have backend side-effects. Functions should not have backend side-effects.

Throws:

DataServiceException or DataNetworkException if an error occurs during action invocation.

Specified by:

executeMethod in interface DataServiceProvider

Parameters:

method - Data method.

parameters - Method parameters.

headers - Request-specific headers.

options - Request-specific options.

Returns:

(nullable) The method result, or `null` if the method has no result.

executeQuery

public QueryResult executeQuery(DataQuery query,
                                HttpHeaders headers,
                                RequestOptions options)

Execute a data query to get data from the target system.

Specified by:

executeQuery in interface DataServiceProvider

Parameters:

query - Data query specifying the information to be returned.

headers - Request-specific headers.

options - Request-specific options.

Returns:

The query result.

fetchMetadata

public CsdlDocument fetchMetadata(HttpHeaders headers,
                                  RequestOptions options)

Fetch latest service metadata and return it, but don't change the OnlineODataProvider.metadata property.

See Also:

OnlineODataProvider.loadMetadata.

Specified by:

fetchMetadata in interface DataServiceProvider

Parameters:

headers - Optional request-specific headers.

options - Optional request-specific options.

Returns:

Latest service metadata.

getDataTransaction

public DataTransaction getDataTransaction()

Return obtain a thread-local transaction manager for this data service.

Specified by:

getDataTransaction in interface DataServiceProvider

Returns:

Obtain a thread-local transaction manager for this data service.

getHttpCookies

public HttpCookies getHttpCookies()

Return obsolete. Use OnlineODataProvider.sessionCookies or OnlineODataProvider.sharedCookies.

Returns:

Obsolete. Use OnlineODataProvider.sessionCookies or OnlineODataProvider.sharedCookies.

getHttpHeaders

public HttpHeaders getHttpHeaders()

Return obsolete. Use OnlineODataProvider.sessionHeaders or OnlineODataProvider.sharedHeaders.

Returns:

Obsolete. Use OnlineODataProvider.sessionHeaders or OnlineODataProvider.sharedHeaders.

getMetadata

public CsdlDocument getMetadata()

Return the OData CSDL document (service metadata).

Specified by:

getMetadata in interface DataServiceProvider

Returns:

The OData CSDL document (service metadata).

getNetworkOptions

public final NetworkOptions getNetworkOptions()

Return options for network communication, which for OData uses HTTP or HTTPS.

Returns:

Options for network communication, which for OData uses HTTP or HTTPS.

getPrettyTracing

public boolean getPrettyTracing()

Return should OnlineODataProvider.traceWithData show pretty-printed JSON/XML content? Defaults to false.

Returns:

Should OnlineODataProvider.traceWithData show pretty-printed JSON/XML content? Defaults to false.

getServiceName

public java.lang.String getServiceName()

Return the service name.

Specified by:

getServiceName in interface DataServiceProvider

Returns:

The service name.

getServiceOptions

public final ServiceOptions getServiceOptions()

Return options for this data service, both client-side and server-side.

Returns:

Options for this data service, both client-side and server-side.

getServiceRoot

public java.lang.String getServiceRoot()

Return the service root URL. The service root URL always terminates with a forward slash.

Returns:

The service root URL.

getSessionCookies

public HttpCookies getSessionCookies()

Return HTTP cookies which should be sent in future online requests (by the current session / thread).

Returns:

HTTP cookies which should be sent in future online requests (by the current session / thread).

getSessionHeaders

public HttpHeaders getSessionHeaders()

Return HTTP headers which should be sent in future online requests (by the current session / thread).

Returns:

HTTP headers which should be sent in future online requests (by the current session / thread).

getSharedCookies

public HttpCookies getSharedCookies()

Return HTTP cookies which should be sent in future online requests (shared by all sessions / threads).

Returns:

HTTP cookies which should be sent in future online requests (shared by all sessions / threads).

getSharedHeaders

public HttpHeaders getSharedHeaders()

Return HTTP headers which should be sent in future online requests (shared by all sessions / threads).

Returns:

HTTP headers which should be sent in future online requests (shared by all sessions / threads).

getTraceRequests

public boolean getTraceRequests()

Return should all requests for this data service be traced? Defaults to false.

Returns:

Should all requests for this data service be traced? Defaults to false.

getTraceWithData

public boolean getTraceWithData()

Return if OnlineODataProvider.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false. Note that care must be taken when enabling tracing with data, as the resulting log files may contain sensitive information. On the other hand, tracing with data may sometimes be invaluable for troubleshooting purposes.

Returns:

If OnlineODataProvider.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false.

hasMetadata

public boolean hasMetadata()

Return true if the service metadata has been loaded by OnlineODataProvider.loadMetadata, or is automatically available in a generated DataService proxy class.

Specified by:

hasMetadata in interface DataServiceProvider

Returns:

true if the service metadata has been loaded by OnlineODataProvider.loadMetadata, or is automatically available in a generated DataService proxy class.

loadMetadata

public void loadMetadata(HttpHeaders headers,
                         RequestOptions options)

Load service metadata (if not already loaded).

See Also:

OnlineODataProvider.metadata, OnlineODataProvider.hasMetadata.

Specified by:

loadMetadata in interface DataServiceProvider

Parameters:

headers - Optional request-specific headers.

options - Optional request-specific options.

login

public void login(java.lang.String username,
                  java.lang.String password)

Set the shared Authorization header to be used for HTTP/HTTPS with pre-emptive BASIC authentication. If credentials are required by the remote data service, they must be set before any function calls (such as OnlineODataProvider.loadMetadata) which may make a network request. For services which require challenge-based authentication, a request interceptor/observer should be used.

See Also:

OnlineODataProvider.sharedHeaders.

Parameters:

username - Client's username.

password - Client's password.

metadataText

public java.lang.String metadataText(int format)

Return an OData metadata document for the current service.

See Also:

DataFormat.

Specified by:

metadataText in interface DataServiceProvider

Parameters:

format - Metadata format. Only XML is presently supported.

Returns:

An OData metadata document for the current service.

pingServer

public void pingServer(HttpHeaders headers,
                       RequestOptions options)

Ping the server, by sending a non-changing request that the server can respond to quickly. The default ping behaviour is to send a HEAD request for the service document.

See Also:

ServiceOptions.pingMethod, ServiceOptions.pingResource, ServiceOptions.pingAccept.

Specified by:

pingServer in interface DataServiceProvider

Parameters:

headers - Optional request-specific headers.

options - Optional request-specific options.

processBatch

public void processBatch(RequestBatch batch,
                         HttpHeaders headers,
                         RequestOptions options)

Execute a request batch in the target system.

Specified by:

processBatch in interface DataServiceProvider

Parameters:

batch - The request batch.

headers - Request-specific headers.

options - Request-specific options.

queryContext

public DataContext queryContext()

See queryContext(int).

Returns:

(see linked method).

queryContext

public DataContext queryContext(int version)

See Also:

DataVersion, QueryParser.

Specified by:

queryContext in interface DataServiceProvider

Parameters:

version - Data version for the context. If zero or not specified, then the ServiceOptions.dataVersion for this data service is used.

Returns:

A data context object for use in query parsing.

rollback

public void rollback()

Rollback the current server transaction.

Specified by:

rollback in interface DataServiceProvider

serviceDocument

public java.lang.String serviceDocument(int format)

Return the service document, in XML or JSON format.

See Also:

DataFormat.

Specified by:

serviceDocument in interface DataServiceProvider

Parameters:

format - Data format (XML or JSON).

Returns:

The service document, in XML or JSON format.

setMetadata

public void setMetadata(CsdlDocument value)

Set the OData CSDL document (service metadata).

Specified by:

setMetadata in interface DataServiceProvider

Parameters:

value - The OData CSDL document (service metadata).

setPrettyTracing

public void setPrettyTracing(boolean value)

Set should OnlineODataProvider.traceWithData show pretty-printed JSON/XML content? Defaults to false.

Parameters:

value - Should OnlineODataProvider.traceWithData show pretty-printed JSON/XML content? Defaults to false.

setServiceRoot

public void setServiceRoot(java.lang.String value)

Set the service root URL. The service root URL always terminates with a forward slash.

Parameters:

value - The service root URL.

setTraceRequests

public void setTraceRequests(boolean value)

Set should all requests for this data service be traced? Defaults to false.

Parameters:

value - Should all requests for this data service be traced? Defaults to false.

setTraceWithData

public void setTraceWithData(boolean value)

Set if OnlineODataProvider.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false. Note that care must be taken when enabling tracing with data, as the resulting log files may contain sensitive information. On the other hand, tracing with data may sometimes be invaluable for troubleshooting purposes.

Parameters:

value - If OnlineODataProvider.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false.

transaction

public void transaction(com.sap.cloud.server.odata.core.Action0 work)

Perform some work within a service-managed transaction.

Parameters:

work - Work to be executed within a transaction.

unloadMetadata

public void unloadMetadata()

Unload service metadata (if previously loaded).

See Also:

OnlineODataProvider.metadata, OnlineODataProvider.hasMetadata.

Specified by:

unloadMetadata in interface DataServiceProvider

updateEntity

public void updateEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)

Update an entity in the target system.

Specified by:

updateEntity in interface DataServiceProvider

Parameters:

entity - Entity to be updated.

headers - Request-specific headers.

options - Request-specific options.

updateLink

public void updateLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)

Update a link from a source entity to a target entity.

Specified by:

updateLink in interface DataServiceProvider

Parameters:

from - Source entity for the link to be updated.

property - Source navigation property for the link to be updated. This must be a one-to-one navigation property.

to - Target entity for the link to be updated.

headers - Request-specific headers.

options - Request-specific options.

uploadMedia

public void uploadMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers,
                        RequestOptions options)

Upload content for a media entity to the target system Caution: Having too many threads simultaneously uploading streams may result in out-of-memory conditions on memory-constrained devices. Note: this function cannot be used to create a media entity. See DataService.createMedia.

Specified by:

uploadMedia in interface DataServiceProvider

Parameters:

entity - Entity whose content is to be uploaded.

content - Upload stream content. Will be closed before this function returns.

headers - Request-specific headers.

options - Request-specific options.

uploadStream

public void uploadStream(EntityValue entity,
                         StreamLink link,
                         StreamBase content,
                         HttpHeaders headers,
                         RequestOptions options)

Upload content for a stream property to the target system. Caution: Having too many threads simultaneously uploading streams may result in out-of-memory conditions on memory-constrained devices.

See Also:

Property.getStreamLink.

Specified by:

uploadStream in interface DataServiceProvider

Parameters:

entity - Entity containing the stream property whose content is to be uploaded.

link - Stream link for the stream to be uploaded.

content - Upload stream content. Will be closed before this function returns.

headers - Request-specific headers.

options - Request-specific options.