com.sap.smp.client.odata.store

Interface ODataStoreSync

All Superinterfaces:

ODataStore

public interface ODataStoreSync
extends ODataStore

Interface representing an ODataStore whose operations are all synchronous.
Code example how to create an entity using the synchronous API:

 
 
                ODataEntity newTravelagency = new ODataEntityDefaultImpl("RMTSAMPLEFLIGHT.Travelagency");
                store.allocateProperties(newTravelagency, PropMode.All);
 
                ODataPropMap propMap = newTravelagency.getProperties();
                ODataProperty agencynum = new ODataPropertyDefaultImpl("agencynum", String.valueOf("id"));
                propMap.put("agencynum", agencynum);
 
                ODataResponseSingle singleResponse = store.executeCreateEntity(newTravelagency, "TravelagencyCollection", null);
 
 
 

If an error occured during the synchronous request execution an exception is thrown. The root cause of the errors can be a network error, parsing error, OData Error Response, etc. (see com.sap.smp.client.odata.exception)
If the root cause is an invalid HTTP response from the server, the response itself is accessible via ODataNetworkException.AdditionalNetworkExceptionInfo :

  
                try {
                        ODataResponseSingle validResponse = store.executeCreateEntity(newEntity, "TravelagencyCollection", null);
                } catch (ODataNetworkException e) {
                        AdditionalNetworkExceptionInfo networkInfo = e.getAdditionalInfo();
                        String errorStatusCode = networkInfo.getStatusCode();
                        ODataResponse errorResponse = networkInfo.getResponse();
                        } catch (ODataException e) {
                                // handle other exceptions
                }
  
  
 

For synchronous batch requests executeRequest method MUST be used (other methods handle only single request/response). This case the request parameter is ODataRequestParamBatch and the response is ODataResponseBatch.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.smp.client.odata.store.ODataStore

ODataStore.PropMode

Method Summary

Modifier and Type	Method and Description
ODataResponseSingle	executeCreateEntity(ODataEntity entity, java.lang.String collectionPath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for creating an Entity.
ODataResponseSingle	executeDeleteEntity(ODataEntity entity, java.util.Map<java.lang.String,java.lang.String> options) Executor method for deleting an Entity.
ODataResponseSingle	executeDeleteEntity(java.lang.String resourcePath, java.lang.String etag, java.util.Map<java.lang.String,java.lang.String> options) Executor method for deleting an Entity.
ODataResponseSingle	executeFunction(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for calling a function.
void	executeMediaDownload(java.net.URL url, ODataDownloadMediaSyncListener listener) Executor method for download media content from an URL.
ODataResponseSingle	executePatchEntity(ODataEntity entity, java.util.Map<java.lang.String,java.lang.String> options) Executor method for patching an Entity.
ODataResponseSingle	executeReadEntity(ODataEntity entity, java.util.Map<java.lang.String,java.lang.String> options) Executor method for reading an Entity.
ODataResponseSingle	executeReadEntity(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for reading an Entity.
ODataResponseSingle	executeReadEntitySet(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for reading an Entity set.
ODataResponseSingle	executeReadLink(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for reading a link.
ODataResponseSingle	executeReadLinkSet(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for reading a link set.
ODataResponseSingle	executeReadPropertyComplex(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for reading a complex property.
ODataResponseSingle	executeReadPropertyPrimitive(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for reading a primitive property.
ODataResponseSingle	executeReadPropertyRaw(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> options) Executor method for reading the raw value of a property.
ODataResponse	executeRequest(ODataRequestParam request) General-purpose executor method using which arbitrary requests can be fired.
ODataResponseSingle	executeUpdateEntity(ODataEntity entity, java.util.Map<java.lang.String,java.lang.String> options) Executor method for updating an Entity.

Methods inherited from interface com.sap.smp.client.odata.store.ODataStore

allocateNavigationProperties, allocateProperties, determineEntitySet, determineEntityType, determineODataType, getMetadata

Method Detail

executeRequest

ODataResponse executeRequest(ODataRequestParam request)
                      throws ODataException

General-purpose executor method using which arbitrary requests can be fired.
If the request is a ODataRequestParamBatch the return object is a ODataResponseBatch. If the request is a ODataRequestParamSingle then the response is ODataResponseSingle.

Parameters:

request - the actual request to fire. It MUST be non-null, otherwise NullPointerException is thrown

Returns:

the odata response, always non-null. It can be a single response (ODataResponseSingle) or a batch response ( ODataResponseBatch.

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path, missing batch items. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if request parameter is null

executeReadEntitySet

ODataResponseSingle executeReadEntitySet(java.lang.String resourcePath,
                                         java.util.Map<java.lang.String,java.lang.String> options)
                                  throws ODataException

Executor method for reading an Entity set.

Parameters:

resourcePath - resource path of the Entity set. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeReadEntity

ODataResponseSingle executeReadEntity(java.lang.String resourcePath,
                                      java.util.Map<java.lang.String,java.lang.String> options)
                               throws ODataException

Executor method for reading an Entity.

Parameters:

resourcePath - resource path of the Entity to be read. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeReadEntity

ODataResponseSingle executeReadEntity(ODataEntity entity,
                                      java.util.Map<java.lang.String,java.lang.String> options)
                               throws ODataException

Executor method for reading an Entity.

Parameters:

entity - the Entity to be read. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if entity parameter is null

executeCreateEntity

ODataResponseSingle executeCreateEntity(ODataEntity entity,
                                        java.lang.String collectionPath,
                                        java.util.Map<java.lang.String,java.lang.String> options)
                                 throws ODataException

Executor method for creating an Entity.

Parameters:

entity - the Entity to be created. It MUST be non-null, otherwise NullPointerException is thrown

collectionPath - path of the collection the Entity to be added to. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if entity or collectionPath parameter is null

executeUpdateEntity

ODataResponseSingle executeUpdateEntity(ODataEntity entity,
                                        java.util.Map<java.lang.String,java.lang.String> options)
                                 throws ODataException

Executor method for updating an Entity.

Parameters:

entity - the Entity to be updated. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if entity parameter is null

executePatchEntity

ODataResponseSingle executePatchEntity(ODataEntity entity,
                                       java.util.Map<java.lang.String,java.lang.String> options)
                                throws ODataException

Executor method for patching an Entity.

Parameters:

entity - the Entity to be patched. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if entity parameter is null

executeDeleteEntity

ODataResponseSingle executeDeleteEntity(ODataEntity entity,
                                        java.util.Map<java.lang.String,java.lang.String> options)
                                 throws ODataException

Executor method for deleting an Entity.

Parameters:

entity - the Entity to be deleted. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if entity parameter is null

executeDeleteEntity

ODataResponseSingle executeDeleteEntity(java.lang.String resourcePath,
                                        java.lang.String etag,
                                        java.util.Map<java.lang.String,java.lang.String> options)
                                 throws ODataException

Executor method for deleting an Entity.

Parameters:

resourcePath - resource path of the Entity to be deleted. It MUST be non-null, otherwise NullPointerException is thrown

etag - ETag can be set for a request for concurrency handling in the server. It sets the "If-Match" header in the HTTP request. Can be null

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeReadPropertyPrimitive

ODataResponseSingle executeReadPropertyPrimitive(java.lang.String resourcePath,
                                                 java.util.Map<java.lang.String,java.lang.String> options)
                                          throws ODataException

Executor method for reading a primitive property.

Parameters:

resourcePath - resource path of the property to be read. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeReadPropertyRaw

ODataResponseSingle executeReadPropertyRaw(java.lang.String resourcePath,
                                           java.util.Map<java.lang.String,java.lang.String> options)
                                    throws ODataException

Executor method for reading the raw value of a property.

Parameters:

resourcePath - resource path of the raw value of a property to be read. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeReadPropertyComplex

ODataResponseSingle executeReadPropertyComplex(java.lang.String resourcePath,
                                               java.util.Map<java.lang.String,java.lang.String> options)
                                        throws ODataException

Executor method for reading a complex property.

Parameters:

resourcePath - resource path of the property to be read. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeReadLink

ODataResponseSingle executeReadLink(java.lang.String resourcePath,
                                    java.util.Map<java.lang.String,java.lang.String> options)
                             throws ODataException

Executor method for reading a link.

Parameters:

resourcePath - resource path of the link to be read. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeReadLinkSet

ODataResponseSingle executeReadLinkSet(java.lang.String resourcePath,
                                       java.util.Map<java.lang.String,java.lang.String> options)
                                throws ODataException

Executor method for reading a link set.

Parameters:

resourcePath - resource path of the link set to be read. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeFunction

ODataResponseSingle executeFunction(java.lang.String resourcePath,
                                    java.util.Map<java.lang.String,java.lang.String> options)
                             throws ODataException

Executor method for calling a function.

Parameters:

resourcePath - resource path of the function to be called. It MUST be non-null, otherwise NullPointerException is thrown

options - the options set for this request. It can be null, in this case default values are used. See ODataRequestParamSingle.Options.

Returns:

OData single response, always non-null

Throws:

ODataException - in case of error. E.g. the store is closed, missing resource path. If there is a odata error server response, the exception is ODataNetworkException. The response can be retrieved by ODataNetworkException.getAdditionalInfo.

java.lang.NullPointerException - if resourcePath parameter is null

executeMediaDownload

void executeMediaDownload(java.net.URL url,
                          ODataDownloadMediaSyncListener listener)
                   throws ODataException

Executor method for download media content from an URL. This method do not return while the download is not complete but the result can be acquired by ODataDownloadMediaSyncListener

Parameters:

url - URL of media content. It MUST be non-null, otherwise NullPointerException is thrown. See ODataEntity.getMediaLink()

listener - the listener to invoke with the result. ODataDownloadMediaResult It MUST be non-null, otherwise NullPointerException is thrown. See ODataDownloadMediaSyncListener

Throws:

ODataException