com.sap.cloud.server.odata

Class OfflineODataProvider

java.lang.Object

com.sap.cloud.server.odata.OfflineODataProvider

All Implemented Interfaces:

DataServiceProvider

public class OfflineODataProvider
extends java.lang.Object
implements DataServiceProvider

For internal use only.

Constructor Summary

Constructors

Constructor and Description
OfflineODataProvider(OnlineODataProvider onlineProvider) See OfflineODataProvider(OnlineODataProvider, SQLDatabaseProvider).
OfflineODataProvider(OnlineODataProvider onlineProvider, SQLDatabaseProvider offlineStore)

Method Summary

Modifier and Type	Method and Description
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	deleteStream(EntityValue entity, StreamLink link, HttpHeaders headers, RequestOptions options) Delete the content of a stream property from the target system.
void	download() See download(StringList).
void	download(StringList groups) Download backend data changes into the local offline store.
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, StructureType derivedType, int format, int version) Return a data context for a specified entity set, data format and data version.
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 OfflineODataProvider.metadata property.
DataTransaction	getDataTransaction() Return the current server transaction.
PendingRequestList	getFailedRequests() See getFailedRequests(DataQuery).
PendingRequestList	getFailedRequests(DataQuery query)
CsdlDocument	getMetadata() Return service metadata.
SQLDatabaseProvider	getOfflineStore()
OnlineODataProvider	getOnlineProvider()
boolean	getPrettyTracing() Return should OfflineODataProvider.traceWithData show pretty-printed JSON/XML content? Defaults to false.
PendingRequestList	getQueuedRequests() See getQueuedRequests(DataQuery).
PendingRequestList	getQueuedRequests(DataQuery query)
java.lang.String	getServiceName() Return service name.
ServiceOptions	getServiceOptions()
StorageOptions	getStorageOptions()
boolean	getTraceRequests()
boolean	getTraceWithData()
boolean	hasMetadata() Return has service metadata been loaded.
void	loadMetadata(HttpHeaders headers, RequestOptions options) Load service metadata (if not already loaded).
java.lang.String	metadataText(int format) Return metadata document text of the service.
void	open()
void	pingServer(HttpHeaders headers, RequestOptions options) Ping the server.
void	processBatch(RequestBatch batch, HttpHeaders headers, RequestOptions options) Execute a request batch in the target system.
DataContext	queryContext(int version) Return a data context for parsing a data query.
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 service metadata.
void	setPrettyTracing(boolean value) Set should OfflineODataProvider.traceWithData show pretty-printed JSON/XML content? Defaults to false.
void	setTraceRequests(boolean value)
void	setTraceWithData(boolean value)
void	synchronize() Call OfflineODataProvider.upload followed by OfflineODataProvider.download.
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	upload() Upload data changes for all uploadable entity sets.
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

OfflineODataProvider

public OfflineODataProvider(OnlineODataProvider onlineProvider)

See OfflineODataProvider(OnlineODataProvider, SQLDatabaseProvider).

Parameters:

onlineProvider - OnlineProvider parameter.

OfflineODataProvider

public OfflineODataProvider(OnlineODataProvider onlineProvider,
                            SQLDatabaseProvider offlineStore)

Method Detail

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.

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.

download

public void download()

See download(StringList).

download

public void download(StringList groups)

Download backend data changes into the local offline store.

See Also:

EntitySet.isDownloadable.

Parameters:

groups - If empty, then download from all entity sets. If non-empty, then it specifies groups to be included.

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,
                                 StructureType derivedType,
                                 int format,
                                 int version)

Return a data context for a specified entity set, data format and data version.

See Also:

DataFormat, DataVersion.

Specified by:

entityContext in interface DataServiceProvider

Parameters:

entitySet - Entity set for entity value to be parsed or formatted.

derivedType - (nullable) Derived type for query results.

format - Data format.

version - Data version.

Returns:

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

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 OfflineODataProvider.metadata property.

See Also:

OfflineODataProvider.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 the current server transaction.

Specified by:

getDataTransaction in interface DataServiceProvider

Returns:

The current server transaction.

getFailedRequests

public PendingRequestList getFailedRequests()

See getFailedRequests(DataQuery).

Returns:

(see linked method).

getFailedRequests

public PendingRequestList getFailedRequests(DataQuery query)

getMetadata

public CsdlDocument getMetadata()

Return service metadata.

See Also:

OfflineODataProvider.loadMetadata.

Specified by:

getMetadata in interface DataServiceProvider

Returns:

Service metadata.

getOfflineStore

public SQLDatabaseProvider getOfflineStore()

getOnlineProvider

public OnlineODataProvider getOnlineProvider()

getPrettyTracing

public boolean getPrettyTracing()

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

Returns:

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

getQueuedRequests

public PendingRequestList getQueuedRequests()

See getQueuedRequests(DataQuery).

Returns:

(see linked method).

getQueuedRequests

public PendingRequestList getQueuedRequests(DataQuery query)

getServiceName

public java.lang.String getServiceName()

Return service name.

Specified by:

getServiceName in interface DataServiceProvider

Returns:

Service name.

getServiceOptions

public ServiceOptions getServiceOptions()

getStorageOptions

public StorageOptions getStorageOptions()

getTraceRequests

public boolean getTraceRequests()

getTraceWithData

public boolean getTraceWithData()

hasMetadata

public boolean hasMetadata()

Return has service metadata been loaded.

See Also:

OfflineODataProvider.loadMetadata.

Specified by:

hasMetadata in interface DataServiceProvider

Returns:

Has service metadata been loaded.

loadMetadata

public void loadMetadata(HttpHeaders headers,
                         RequestOptions options)

Load service metadata (if not already loaded).

See Also:

OfflineODataProvider.metadata, OfflineODataProvider.hasMetadata.

Specified by:

loadMetadata in interface DataServiceProvider

Parameters:

headers - Optional request-specific headers.

options - Optional request-specific options.

metadataText

public java.lang.String metadataText(int format)

Return metadata document text of the service.

See Also:

DataFormat.

Specified by:

metadataText in interface DataServiceProvider

Parameters:

format - Metadata format. Only XML is presently supported.

Returns:

Metadata document text of the service.

open

public void open()

pingServer

public void pingServer(HttpHeaders headers,
                       RequestOptions options)

Ping the server.

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(int version)

Return a data context for parsing a data query.

See Also:

DataVersion.

Specified by:

queryContext in interface DataServiceProvider

Parameters:

version - Data version.

Returns:

A data context for parsing a data query.

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 service metadata.

See Also:

OfflineODataProvider.loadMetadata.

Specified by:

setMetadata in interface DataServiceProvider

Parameters:

value - Service metadata.

setPrettyTracing

public void setPrettyTracing(boolean value)

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

Parameters:

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

setTraceRequests

public void setTraceRequests(boolean value)

setTraceWithData

public void setTraceWithData(boolean value)

synchronize

public void synchronize()

Call OfflineODataProvider.upload followed by OfflineODataProvider.download.

unloadMetadata

public void unloadMetadata()

Unload service metadata (if previously loaded).

See Also:

OfflineODataProvider.metadata, OfflineODataProvider.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.

upload

public void upload()

Upload data changes for all uploadable entity sets.

See Also:

EntitySet.isUploadable.

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.