oracle.maf.api.cdm.persistence.manager

Class RestJSONPersistenceManager

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MCSPersistenceManager

public class RestJSONPersistenceManager
extends oracle.maf.impl.cdm.persistence.manager.RestPersistenceManager

Implementation of Persistence manager interface that provides basic CRUD operations using the REST web services protocol against a remote server. The payload of the REST web service should be in JSON format.

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
RestJSONPersistenceManager()

Method Summary

Modifier and Type	Method and Description
String	getSerializedDataObject(Entity entity, String elementName, String rowElementName, boolean deleteRow) See getSerializedDataObject method with attributesToExclude parameter.
String	getSerializedDataObject(Entity entity, String elementName, String rowElementName, java.util.List<String> attributesToExclude, boolean deleteRow) Returns the entity instance as JSON-formatted string.
<E extends Entity> java.util.List<E>	handleReadResponse(String jsonResponse, Class entityClass, String collectionElementName, String rowElementName, java.util.List<BindParamInfo> parentBindParamInfos, boolean deleteAllRows) Handle JSON response payload from read methods.
<E extends Entity> java.util.List<E>	handleResponse(String json, Class entityClass, String collectionElementName, String rowElementName, java.util.List<BindParamInfo> parentBindParamInfos, E currentEntity, boolean deleteAllRows) Process JSON response payload for all REST resources called through a CRUD or custom method as configured in persistence-mapping.xml

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

commmit, createParameterMap, find, find, findAll, findAllInParent, getAsParent, getCanonical, getLastResponseHeaders, getLastResponseStatus, getMaxValue, getPayloadKeyValuePairs, getRestNullValue, invokeByteArrayRestService, invokeCustomMethod, invokeRestService, 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

RestJSONPersistenceManager

public RestJSONPersistenceManager()

Method Detail

getSerializedDataObject

public String getSerializedDataObject(Entity entity,
                                      String elementName,
                                      String rowElementName,
                                      boolean deleteRow)

See getSerializedDataObject method with attributesToExclude parameter.

Specified by:

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

Parameters:

entity -

elementName -

rowElementName -

deleteRow -

Returns:

getSerializedDataObject

public String getSerializedDataObject(Entity entity,
                                      String elementName,
                                      String rowElementName,
                                      java.util.List<String> attributesToExclude,
                                      boolean deleteRow)

Returns the entity instance as JSON-formatted string. If the elementName argument has a value, a JSON Object with one attribute -the element name- is returned, and the value of this attribute is a JSON array which contains one entry: the serialized entity instance. Exception to this rule is when the elementName is set to "root", then the JSON array with the serailized entity instance is returned directly. If the elementName is null, then the serialized data object is returned directy, and not enclosed with JSONArray brackets. If the rowElementName is specified the serialized entity instance is contained by a JSON object with one attribute: the value of rowElementName. You can use dots in the rowElementName to get a nested structure of JSON objects with the leaf object holding the entity instance. Attributes included in the attributesToExclude list will not be serialized.

Specified by:

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

Parameters:

entity -

elementName -

rowElementName -

attributesToExclude -

deleteRow -

Returns:

JSON-formatted string containing the serialized entity instance

handleReadResponse

public <E extends Entity> java.util.List<E> handleReadResponse(String jsonResponse,
                                                               Class entityClass,
                                                               String collectionElementName,
                                                               String rowElementName,
                                                               java.util.List<BindParamInfo> parentBindParamInfos,
                                                               boolean deleteAllRows)

Handle JSON response payload from read methods.

Specified by:

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

Type Parameters:

E -

Parameters:

jsonResponse -

entityClass -

collectionElementName -

rowElementName -

parentBindParamInfos -

deleteAllRows - no longer used (delete performed in calling method)

Returns:

handleResponse

public <E extends Entity> java.util.List<E> handleResponse(String json,
                                                           Class entityClass,
                                                           String collectionElementName,
                                                           String rowElementName,
                                                           java.util.List<BindParamInfo> parentBindParamInfos,
                                                           E currentEntity,
                                                           boolean deleteAllRows)

Process JSON response payload for all REST resources called through a CRUD or custom method as configured in persistence-mapping.xml

Specified by:

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

Type Parameters:

E -

Parameters:

json -

entityClass -

collectionElementName -

rowElementName -

parentBindParamInfos -

currentEntity -

deleteAllRows - no longer used (delete performed in calling method)

Returns: