Class EntityManagerService

java.lang.Object
com.priint.pubserver.plugin.PluginControlDefault
com.priint.pubserver.entitydata.service.AbstractService
com.priint.pubserver.entitydata.service.EntityManagerService
All Implemented Interfaces:
com.priint.pubserver.plugin.interfaces.PluginControl

@Consumes({"application/json","application/xml"}) @Produces({"application/json","application/xml"}) @Path("/entitymanager") public class EntityManagerService extends AbstractService
RESTful service interface for querying entity manager of publishing server.

Supports through its URIs all methods from EntityManagerRemote interface.

Data transfer format for most methods is Data.

You may use either XML or JSON as serialization method.

In case of errors a ServerResult object will be returned along with the HTTP status code (in most cases 500) containing exception details.

Context is specified as a list of query string arguments where field names are separated by ":". Use e.g. the following call to query root buckets for MyEntityModel for a catalog for Austria in German language only using a data well called "Premium".

 http://server/EntityDataService/entitymanager/MyEntityModel/Bucket?context=language:deu&context=country:AT&context=well:Premium
 
Since:
4.0.5
  • Field Details

  • Constructor Details

    • EntityManagerService

      public EntityManagerService()
  • Method Details

    • getEntityChildrenOfEntityBucket

      @GET @Path("/{entityModelIdentifier}/Bucket/{parentEntityId}/{parentDataId}/{resultType}") public com.priint.pubserver.plugin.entitydata.Data getEntityChildrenOfEntityBucket(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("parentType") String parentType, @PathParam("parentEntityId") String parentEntityId, @PathParam("parentDataId") String parentDataId, @PathParam("resultType") String resultType, @QueryParam("corded") boolean corded, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Query for children of any entity
      Parameters:
      entityModelIdentifier -
      parentType -
      parentEntityId -
      parentDataId -
      resultType -
      contextArgs -
      corded -
      searchStr -
      Returns:
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getEntityChildrenOfEntityBucket

      @GET @Path("/{entityModelIdentifier}/Bucket/{parentEntityId}/{parentDataId}/{resultType}/{resultEntityId}") public com.priint.pubserver.plugin.entitydata.Data getEntityChildrenOfEntityBucket(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("parentType") String parentType, @PathParam("parentEntityId") String parentEntityId, @PathParam("parentDataId") String parentDataId, @PathParam("resultType") String resultType, @PathParam("resultEntityId") String resultEntityId, @QueryParam("corded") boolean corded, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Query for children of a specific entity
      Parameters:
      entityModelIdentifier -
      parentType -
      parentEntityId -
      parentDataId -
      resultType -
      resultEntityId -
      contextArgs -
      corded -
      searchStr -
      Returns:
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getRootFromEntityManager

      @GET @Path("/{entityModelIdentifier}/Bucket") public com.priint.pubserver.plugin.entitydata.Data getRootFromEntityManager(@PathParam("entityModelIdentifier") String entityModelIdentifier, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Query for root buckets or search for any bucket of any entity
      Parameters:
      entityModelIdentifier -
      searchStr -
      Returns:
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getRootFromEntityManager

      @GET @Path("/{entityModelIdentifier}/Bucket/{resultEntityId}") public com.priint.pubserver.plugin.entitydata.Data getRootFromEntityManager(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("resultEntityId") String resultEntityId, @QueryParam("root") @DefaultValue("true") Boolean root, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Query for root buckets or search for any bucket of a specific entity
      Parameters:
      entityModelIdentifier -
      resultEntityId -
      root -
      searchStr -
      Returns:
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getBucketByIdentifier

      @GET @Path("/{entityModelIdentifier}/Bucket/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Data getBucketByIdentifier(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getContentMetaDataByIdentifier

      @GET @Path("/{entityModelIdentifier}/ContentMetaData/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Data getContentMetaDataByIdentifier(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getCordByIdentifier

      @GET @Path("/{entityModelIdentifier}/Cord/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Data getCordByIdentifier(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getKeyValueByIdentifier

      @GET @Path("/{entityModelIdentifier}/KeyValue/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Data getKeyValueByIdentifier(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getMediaAssetByIdentifier

      @GET @Path("/{entityModelIdentifier}/MediaAsset/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Data getMediaAssetByIdentifier(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getPriceByIdentifier

      @GET @Path("/{entityModelIdentifier}/Price/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Data getPriceByIdentifier(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTableDataByIdentifier

      @GET @Path("/{entityModelIdentifier}/TableData/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Data getTableDataByIdentifier(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTextByIdentifier

      @GET @Path("/{entityModelIdentifier}/Text/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Data getTextByIdentifier(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTextBySearch

      @GET @Path("/{entityModelIdentifier}/Text/{entityId}") public com.priint.pubserver.plugin.entitydata.Data getTextBySearch(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @QueryParam("search") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @POST @Path("/{entityModelIdentifier}/Data") public com.priint.pubserver.plugin.entitydata.Data setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      http://server/EntityDataService/entitymanager/MyEntityModel/Data
      Parameters:
      entityModelIdentifier -
      data -
      Returns:
      Throws:
      com.priint.pubserver.exception.PubServerException
    • commit

      @POST @Path("/{entityModelIdentifier}/commit") public com.priint.pubserver.plugin.interfaces.ConnectorPersistRemote.PushData commit(@PathParam("entityModelIdentifier") String entityModelIdentifier, com.priint.pubserver.plugin.interfaces.ConnectorPersistRemote.PushData push) throws com.priint.pubserver.exception.PubServerException
      Commit a dataset of entity items from a push object.

      http://server/EntityDataService/entitymanager/MyEntityModel/commit

      Parameters:
      entityModelIdentifier -
      input -
      Returns:
      PushData
      Throws:
      com.priint.pubserver.exception.PubServerException
    • bulkInsert

      @POST @Path("/{entityModelIdentifier}/bulk-insert") public com.priint.pubserver.plugin.interfaces.ConnectorPersistRemote.PushData bulkInsert(@PathParam("entityModelIdentifier") String entityModelIdentifier, com.priint.pubserver.plugin.interfaces.ConnectorPersistRemote.PushData push) throws com.priint.pubserver.exception.PubServerException
      Bulk insert a dataset of entity items from a push object.

      http://server/EntityDataService/entitymanager/MyEntityModel/commit

      Parameters:
      entityModelIdentifier -
      Returns:
      PushData
      Throws:
      com.priint.pubserver.exception.PubServerException
    • bulkUpsert

      @POST @Path("/{entityModelIdentifier}/bulk-upsert") public com.priint.pubserver.plugin.interfaces.ConnectorPersistRemote.PushData bulkUpsert(@PathParam("entityModelIdentifier") String entityModelIdentifier, com.priint.pubserver.plugin.interfaces.ConnectorPersistRemote.PushData push) throws com.priint.pubserver.exception.PubServerException
      Bulk upsert a dataset of entity items from a push object.

      http://server/EntityDataService/entitymanager/MyEntityModel/commit

      Parameters:
      entityModelIdentifier -
      Returns:
      PushData
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setBuckets

      @POST @Path("/{entityModelIdentifier}/Bucket") public com.priint.pubserver.plugin.entitydata.Data setBuckets(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("resultType") String resultType, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setContentMetaData

      @POST @Path("/{entityModelIdentifier}/ContentMetaData") public com.priint.pubserver.plugin.entitydata.Data setContentMetaData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setCords

      @POST @Path("/{entityModelIdentifier}/Cord") public com.priint.pubserver.plugin.entitydata.Data setCords(@PathParam("entityModelIdentifier") String entityModelIdentifier, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setKeyValues

      @POST @Path("/{entityModelIdentifier}/KeyValue") public com.priint.pubserver.plugin.entitydata.Data setKeyValues(@PathParam("entityModelIdentifier") String entityModelIdentifier, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setMediaAssets

      @POST @Path("/{entityModelIdentifier}/MediaAsset") public com.priint.pubserver.plugin.entitydata.Data setMediaAssets(@PathParam("entityModelIdentifier") String entityModelIdentifier, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setPrices

      @POST @Path("/{entityModelIdentifier}/Price") public com.priint.pubserver.plugin.entitydata.Data setPrices(@PathParam("entityModelIdentifier") String entityModelIdentifier, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setTableData

      @POST @Path("/{entityModelIdentifier}/TableData}") public com.priint.pubserver.plugin.entitydata.Data setTableData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setTexts

      @POST @Path("/{entityModelIdentifier}/Text") public com.priint.pubserver.plugin.entitydata.Data setTexts(@PathParam("entityModelIdentifier") String entityModelIdentifier, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteBucket

      @DELETE @Path("/{entityModelIdentifier}/Bucket/{entityId}/{recordId}") public jakarta.ws.rs.core.Response deleteBucket(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteContentMetaData

      @DELETE @Path("/{entityModelIdentifier}/ContentMetaData/{entityId}/{recordId}") public jakarta.ws.rs.core.Response deleteContentMetaData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteCord

      @DELETE @Path("/{entityModelIdentifier}/Cord/{entityId}/{recordId}") public jakarta.ws.rs.core.Response deleteCord(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteKeyValue

      @DELETE @Path("/{entityModelIdentifier}/KeyValue/{entityId}/{recordId}") public jakarta.ws.rs.core.Response deleteKeyValue(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteMediaAsset

      @DELETE @Path("/{entityModelIdentifier}/MediaAsset/{entityId}/{recordId}") public jakarta.ws.rs.core.Response deleteMediaAsset(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deletePrice

      @DELETE @Path("/{entityModelIdentifier}/Price/{entityId}/{recordId}") public jakarta.ws.rs.core.Response deletePrice(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteTableData

      @DELETE @Path("/{entityModelIdentifier}/TableData/{entityId}/{recordId}") public jakarta.ws.rs.core.Response deleteTableData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteText

      @DELETE @Path("/{entityModelIdentifier}/Text/{entityId}/{recordId}") public jakarta.ws.rs.core.Response deleteText(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @PUT @Path("/{entityModelIdentifier}/Bucket/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Bucket setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Bucket entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @PUT @Path("/{entityModelIdentifier}/ContentMetaData/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.ContentMetaData setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.ContentMetaData entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @PUT @Path("/{entityModelIdentifier}/Cord/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Cord setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Cord entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @PUT @Path("/{entityModelIdentifier}/KeyValue/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.KeyValue setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.KeyValue entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @PUT @Path("/{entityModelIdentifier}/MediaAsset/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.MediaAsset setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.MediaAsset entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @PUT @Path("/{entityModelIdentifier}/Price/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Price setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Price entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @PUT @Path("/{entityModelIdentifier}/TableData/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.TableData setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.TableData entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • setEntityData

      @PUT @Path("/{entityModelIdentifier}/Text/{entityId}/{recordId}") public com.priint.pubserver.plugin.entitydata.Text setEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("entityId") String entityId, @PathParam("recordId") String recordId, @QueryParam("search") String searchStr, com.priint.pubserver.plugin.entitydata.Text entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteEntityData

      @DELETE @Path("/{entityModelIdentifier}/{resultType}") public com.priint.pubserver.plugin.entitydata.Data deleteEntityData(@PathParam("entityModelIdentifier") String entityModelIdentifier, @PathParam("resultType") String resultType, com.priint.pubserver.plugin.entitydata.Data data) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException