oracle.maf.api.cdm.persistence.manager

Class MCSPersistenceManager

Object

oracle.maf.impl.cdm.persistence.manager.AbstractPersistenceManager

oracle.maf.impl.cdm.persistence.manager.AbstractRemotePersistenceManager

oracle.maf.impl.cdm.persistence.manager.RestPersistenceManager

oracle.maf.api.cdm.persistence.manager.RestJSONPersistenceManager

oracle.maf.api.cdm.persistence.manager.MCSPersistenceManager

All Implemented Interfaces:

oracle.maf.impl.cdm.persistence.manager.PersistenceManager, oracle.maf.impl.cdm.persistence.manager.RemotePersistenceManager

public class MCSPersistenceManager
extends RestJSONPersistenceManager

This class provides easy access to most of the platform REST API's available in Oracle Mobile Cloud Service. For custom API calls, it uses the REST endpoints as defined in persistence-mapping.xml. It injects the oracle-mobile-backend-id and (anonymous) Authorization header based on configuration in mobile-persistence-config.properties. However, this injection will be overridden when MAF MCS login is configured, which is the recommended approach.

Field Summary

Fields inherited from class oracle.maf.impl.cdm.persistence.manager.AbstractRemotePersistenceManager

ACTION_INSERT, ACTION_MERGE, ACTION_REMOVE, ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
MCSPersistenceManager()

Method Summary

Modifier and Type	Method and Description
java.util.Map<String,String>	addMCSHeaderParamsIfNeeded(java.util.Map<String,String> headerParams) This method will add the following headers if they have not been included yet in header parameter map: Content-Type: application/json oracle-mobile-backend-id: value taken from mobile-persistence-config.properties Authorization: value taken from method getAuthHeader, if this method returns null, value taken from getAnonymousHeader Note that if you use standard MAF login against MCS, then MAF will override the oracle-mobile-backend-id and Authorization header parameters with its own values based on the login configuration.
String	deregisterDevice(String token, String appId) Method to deregister mobile device with MCS so it will no longer receive push notifications.
void	findStorageObject(StorageObject storageObject) Call MCS Storage API /platform/storage/collections/{collection}/objects/{object} with GET method.
void	findStorageObjectMetadata(StorageObject storageObject) Call MCS Storage API /platform/storage/collections/{collection}/objects/{object} with HEAD method to get object metadata.
String	findUser(String username) Get MCS User info
String	getAnonymousHeader() Return the anonymous authorization header parameter value.
String	getAnonymousKey() Returns by default the MCS anonymous access key defined in mobile-persistence-config.properties, unless this value have been overridden by calling setAnonymousKey on the same instance of MCSPersistenceManager.
String	getAuthHeader() Return the authorization header parameter value that is stored in applicationScope under key mcs_auth_header.
String	getConnectionName() Returns by default the MCS connection name defined in mobile-persistence-config.properties, unless this value have been overridden by calling setConnectionName on the same instance of MCSPersistenceManager.
String	getMobileBackendId()
byte[]	invokeByteArrayRestService(String connectionName, String requestType, String requestUri, String payload, java.util.Map<String,String> headerParamMap, int retryLimit)
String	invokeRestService(String connectionName, String requestType, String requestUri, String payload, java.util.Map<String,String> headerParamMap, int retryLimit, boolean secured)
String	login(String userName, String password) This method allows you to basic authenticatication against MCS using the username and password that you pass in.
String	logout() Calls MCS logout URL.
void	populateStorageObjectMetadata(StorageObject storageObject, java.util.Map headers, boolean saveToDB) Populate storage object metadata with header parameters returned by HEAD call to storage object.
String	registerDevice(String token, String appId, String appVersion) Method to register mobile device with MCS so it can receive push notifications.
void	removeStorageObject(StorageObject storageObject) Removes a storage object from an MCS collection.
void	sendAnalyticsEvents(String payload)
void	setAnonymousKey(String anonymousKey) Change the default anonymous accesss key as specified in mobile-persistence-config.properties
void	setAuthHeader(String authHeader) Store the authorization header parameter value that is created by calling the login method in applicationScope under key mcs_auth_header.
void	setConnectionName(String connectionName) Change the default connection name as specified in mobile-persistence-config.properties
void	setMobileBackendId(String mobileBackendId)
void	storeStorageObject(StorageObject storageObject) Creates or updates a storage object in an MCS collection.
String	updateUser(String username, String requestPayload) Update MCS User info

Methods inherited from class oracle.maf.api.cdm.persistence.manager.RestJSONPersistenceManager

getSerializedDataObject, getSerializedDataObject, handleReadResponse, handleResponse

Methods inherited from class oracle.maf.impl.cdm.persistence.manager.RestPersistenceManager

commmit, createParameterMap, find, find, findAll, findAllInParent, getAsParent, getCanonical, getLastResponseHeaders, getLastResponseStatus, getMaxValue, getPayloadKeyValuePairs, getRestNullValue, invokeCustomMethod, invokeRestService, rollback, sendRemoveRequest, sendWriteRequest, setLastResponseHeaders, setLastResponseStatus, setupRestServiceCall

Methods inherited from class oracle.maf.impl.cdm.persistence.manager.AbstractRemotePersistenceManager

findConnection, getLocalPersistenceManager, insertEntity, isCreateSupported, isFindAllInParentSupported, isFindAllSupported, isFindSupported, isGetAsParentSupported, isGetCanonicalSupported, isMergeSupported, isRemoveSupported, isUpdateSupported, mergeEntity, removeEntity, setLocalPersistenceManager, updateEntity

Methods inherited from class oracle.maf.impl.cdm.persistence.manager.AbstractPersistenceManager

addPropertyChangeListener, constructBindParamInfo, constructBindParamInfo, findByKey, findByKey, getBindParamInfos, getBindParamInfos, getBindParamInfos, getNewBindParamInfoInstance, removePropertyChangeListener

Methods inherited from class Object

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

Methods inherited from interface oracle.maf.impl.cdm.persistence.manager.PersistenceManager

findByKey

Constructor Detail

MCSPersistenceManager

public MCSPersistenceManager()

Method Detail

login

public String login(String userName,
                    String password)

This method allows you to basic authenticatication against MCS using the username and password that you pass in. The oracle mobile backend id used to authenticate against is by taken from mobile-persistence-config.properties. The authorization header constructed out of the username and password is stored on applicationScope, and is injected in any further MCS REST call through method addMCSHeaderParamsIfNeeded. Note that it is preferred to use the standard MAF login functionality, rather than this custom login method. When using the MAF login functionality, MAF itself will inject the Oracle mobile backend id and Authorization header on every MCS REST call. This will override the mobile backend-id and anonymous access key defined in mobile-persistence-config.properties. The standard MAF login functionality also allows you to use OAuth insteaf of basic authentication, amd allows you to remember username and/or password, saving them encrypted in the keychain.

Parameters:

userName -

password -

Returns:

logout

public String logout()

Calls MCS logout URL. This method does NOT logout from MAF application. You can do this yourself by calling AdfmfJavaUtilities.logout();

Returns:

sendAnalyticsEvents

public void sendAnalyticsEvents(String payload)

findStorageObjectMetadata

public void findStorageObjectMetadata(StorageObject storageObject)

Call MCS Storage API /platform/storage/collections/{collection}/objects/{object} with HEAD method to get object metadata. If the object already exists in local DB, we pass in the If-None-Match header with the local Etag value so we can find out whether the local object is stil current. If the REST call returns status code 304 - Not Modified, we know there is no need to fetch the object content from MCS.

Parameters:

storageObject -

populateStorageObjectMetadata

public void populateStorageObjectMetadata(StorageObject storageObject,
                                          java.util.Map headers,
                                          boolean saveToDB)

Populate storage object metadata with header parameters returned by HEAD call to storage object. The storage object is not saved to local DB here.

Parameters:

storageObject -

headers -

saveToDB -

findStorageObject

public void findStorageObject(StorageObject storageObject)

Call MCS Storage API /platform/storage/collections/{collection}/objects/{object} with GET method. The object metadata return in header params is saved into the storage object passed into this method, the actual content of the storage object is streamed to the file system.

Parameters:

storageObject -

invokeByteArrayRestService

public byte[] invokeByteArrayRestService(String connectionName,
                                         String requestType,
                                         String requestUri,
                                         String payload,
                                         java.util.Map<String,String> headerParamMap,
                                         int retryLimit)

Overrides:

invokeByteArrayRestService in class oracle.maf.impl.cdm.persistence.manager.RestPersistenceManager

addMCSHeaderParamsIfNeeded

public java.util.Map<String,String> addMCSHeaderParamsIfNeeded(java.util.Map<String,String> headerParams)

This method will add the following headers if they have not been included yet in header parameter map:

• Content-Type: application/json
• oracle-mobile-backend-id: value taken from mobile-persistence-config.properties
• Authorization: value taken from method getAuthHeader, if this method returns null, value taken from getAnonymousHeader

Note that if you use standard MAF login against MCS, then MAF will override the oracle-mobile-backend-id and Authorization header parameters with its own values based on the login configuration. This is convenient, because this means that as long as you are not logged in, this class will inject the anonymous auth header from mobile-persistence-config.properies, and once you are logged in, the MAF login header injection will win. When you specify (one of) the above headers as part of a method in persistence-mapping.xml, then these values are already included in the header parameter map and this methiod will NOT override them.

Parameters:

headerParams -

Returns:

setMobileBackendId

public void setMobileBackendId(String mobileBackendId)

getMobileBackendId

public String getMobileBackendId()

setAuthHeader

public void setAuthHeader(String authHeader)

Store the authorization header parameter value that is created by calling the login method in applicationScope under key mcs_auth_header.

Parameters:

authHeader -

getAuthHeader

public String getAuthHeader()

Return the authorization header parameter value that is stored in applicationScope under key mcs_auth_header.

Parameters:

authHeader -

getAnonymousHeader

public String getAnonymousHeader()

Return the anonymous authorization header parameter value. By default, this value is constructed from the anonymous access key defined in mobile-persistence-config.properties, prefixed with "Basic " if needed. When using an EL expression in mobile-persistence-config.properties, the value typically already starts with "Basic". Note that the anonymous access key can be changed by calling setAnonymousKey. If the anonymous access key is not set, this method returns null.

Returns:

setConnectionName

public void setConnectionName(String connectionName)

Change the default connection name as specified in mobile-persistence-config.properties

Parameters:

connectionName -

getConnectionName

public String getConnectionName()

Returns by default the MCS connection name defined in mobile-persistence-config.properties, unless this value have been overridden by calling setConnectionName on the same instance of MCSPersistenceManager.

Returns:

setAnonymousKey

public void setAnonymousKey(String anonymousKey)

Change the default anonymous accesss key as specified in mobile-persistence-config.properties

Parameters:

connectionName -

getAnonymousKey

public String getAnonymousKey()

Returns by default the MCS anonymous access key defined in mobile-persistence-config.properties, unless this value have been overridden by calling setAnonymousKey on the same instance of MCSPersistenceManager.

Returns:

invokeRestService

public String invokeRestService(String connectionName,
                                String requestType,
                                String requestUri,
                                String payload,
                                java.util.Map<String,String> headerParamMap,
                                int retryLimit,
                                boolean secured)

Overrides:

invokeRestService in class oracle.maf.impl.cdm.persistence.manager.RestPersistenceManager

storeStorageObject

public void storeStorageObject(StorageObject storageObject)

Creates or updates a storage object in an MCS collection. The ID of the storage object is used as the object identifier, so, when an object with the same ID already exists in this collection, it will be updated and the ETag value of the object will be incremented with 1, the new ETag value returned by MCS is stored in the SQLIte DB together with the other metadata returned by MCS. If the filePath is not set on the storageObject, this method will do nothing.

Parameters:

storageObject -

removeStorageObject

public void removeStorageObject(StorageObject storageObject)

Removes a storage object from an MCS collection.

Parameters:

storageObject -

registerDevice

public String registerDevice(String token,
                             String appId,
                             String appVersion)

Method to register mobile device with MCS so it can receive push notifications. The token is the value you get passed in through the EventListener.onOpen method that you need to implement to enable push notifiations. See MAF Develoepr's guide for more info.

Parameters:

token -

appId -

Returns:

MCS response payload

deregisterDevice

public String deregisterDevice(String token,
                               String appId)

Method to deregister mobile device with MCS so it will no longer receive push notifications.

Parameters:

token -

appId -

Returns:

MCS response payload

findUser

public String findUser(String username)

Get MCS User info

Parameters:

username -

Returns:

response payload

updateUser

public String updateUser(String username,
                         String requestPayload)

Update MCS User info

Parameters:

username -

Returns:

response payload