Class ConnectorService

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

@Consumes({"application/json","application/xml"}) @Produces({"application/json","application/xml"}) @Path("/connector") public class ConnectorService extends AbstractService
RESTful service interface for arbitrary connectors to publishing server.

Supports all methods from ConnectorRemote interface as well as ConnectorPersistRemote interface.

Data transfer format is Data for ConnectorRemote methods and DataMap for ConnectorPersistRemote.

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.

Since:
4.0.5
  • Field Details

  • Constructor Details

    • ConnectorService

      public ConnectorService()
  • Method Details

    • getBuckets

      @GET @Path("/{connector}/{instance}/Bucket") public com.priint.pubserver.plugin.entitydata.Data getBuckets(@PathParam("connector") String connector, @PathParam("instance") String instance, @QueryParam("searchStr") String searchStr, @QueryParam("root") @DefaultValue("true") Boolean root) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getBuckets

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getBuckets(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @QueryParam("searchStr") String searchStr, @QueryParam("root") @DefaultValue("true") Boolean root) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getBucketsByIdentifier

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}") public com.priint.pubserver.plugin.entitydata.Data getBucketsByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("ID") String bucketId, @PathParam("connectorentity") String connectorEntity, @QueryParam("searchStr") String searchStr, @QueryParam("groupid") @DefaultValue("false") Boolean groupid) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getChildBucketsOrCordedBuckets

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/Bucket") public com.priint.pubserver.plugin.entitydata.Data getChildBucketsOrCordedBuckets(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("corded") @DefaultValue("false") Boolean corded, @QueryParam("direction") @DefaultValue("OUTGOING") com.priint.pubserver.plugin.interfaces.ConnectorRemote.Direction directed, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getChildBuckets

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/Bucket/{subconnectorentity}") public com.priint.pubserver.plugin.entitydata.Data getChildBuckets(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("subconnectorentity") com.priint.pubserver.plugin.entitydata.ConnectorEntity subConnectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getContentMetaDataByIdentifier

      @GET @Path("/{connector}/{instance}/ContentMetaData/{connectorentity}/{ID}") public com.priint.pubserver.plugin.entitydata.Data getContentMetaDataByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String id, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getContentMetaDataOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/ContentMetaData") public com.priint.pubserver.plugin.entitydata.Data getContentMetaDataOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getContentMetaDataOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{parentconnectorentity}/{ID}/ContentMetaData/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getContentMetaDataOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("parentconnectorentity") com.priint.pubserver.plugin.entitydata.ConnectorEntity parentconnectorentity, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getConnectorEntities

      @GET @Path("/{connector}/{instance}/ConnectorEntity") public com.priint.pubserver.plugin.entitydata.Data getConnectorEntities(@PathParam("connector") String connector, @PathParam("instance") String instance) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getCords

      @GET @Path("/{connector}/{instance}/Cord/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getCords(@PathParam("connector") String connector, @PathParam("instance") String instance, @QueryParam("searchStr") String searchStr, @PathParam("connectorentity") String connectorEntity) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getCordsByIdentifier

      @GET @Path("/{connector}/{instance}/Cord/{connectorentity}/{ID}") public com.priint.pubserver.plugin.entitydata.Data getCordsByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr, @QueryParam("groupid") @DefaultValue("false") Boolean groupid) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getCordsOfBuckets

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/Cord") public com.priint.pubserver.plugin.entitydata.Data getCordsOfBuckets(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("ID") String bucketId, @PathParam("connectorentity") String connectorEntity, @QueryParam("direction") @DefaultValue("OUTGOING") com.priint.pubserver.plugin.interfaces.ConnectorRemote.Direction directed, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getCordsOfBuckets

      @GET @Path("/{connector}/{instance}/Bucket/{parentconnectorentity}/{ID}/Cord/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getCordsOfBuckets(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("ID") String bucketId, @PathParam("parentconnectorentity") String parentConnectorEntityId, @PathParam("connectorentity") String connectorEntity, @QueryParam("direction") @DefaultValue("OUTGOING") com.priint.pubserver.plugin.interfaces.ConnectorRemote.Direction directed, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getKeyValues

      @GET @Path("/{connector}/{instance}/KeyValue/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getKeyValues(@PathParam("connector") String connector, @PathParam("instance") String instance, @QueryParam("searchStr") String searchStr, @PathParam("connectorentity") String connectorEntity) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getKeyValuesByIdentifier

      @GET @Path("/{connector}/{instance}/KeyValue/{connectorentity}/{ID}") public com.priint.pubserver.plugin.entitydata.Data getKeyValuesByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("ID") String bucketId, @PathParam("connectorentity") String connectorEntity, @QueryParam("searchStr") String searchStr, @QueryParam("groupid") @DefaultValue("false") Boolean groupid) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getKeyValuesOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/KeyValue") public com.priint.pubserver.plugin.entitydata.Data getKeyValuesOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getKeyValuesOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{parentconnectorentity}/{ID}/KeyValue/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getKeyValuesOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("parentconnectorentity") String parentConnectorEntityId, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getMediaAssets

      @GET @Path("/{connector}/{instance}/MediaAsset/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getMediaAssets(@PathParam("connector") String connector, @PathParam("instance") String instance, @QueryParam("searchStr") String searchStr, @PathParam("connectorentity") String connectorEntity) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getMediaAssetsByIdentifier

      @GET @Path("/{connector}/{instance}/MediaAsset/{connectorentity}/{ID}") public com.priint.pubserver.plugin.entitydata.Data getMediaAssetsByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("ID") String id, @PathParam("connectorentity") String connectorEntity, @QueryParam("searchStr") String searchStr, @QueryParam("groupid") @DefaultValue("false") Boolean groupid) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getMediaAssetsOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/MediaAsset") public com.priint.pubserver.plugin.entitydata.Data getMediaAssetsOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getMediaAssetsOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{parentconnectorentity}/{ID}/MediaAsset/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getMediaAssetsOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("parentconnectorentity") com.priint.pubserver.plugin.entitydata.ConnectorEntity parentconnectorentity, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getPrices

      @GET @Path("/{connector}/{instance}/Price/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getPrices(@PathParam("connector") String connector, @PathParam("instance") String instance, @QueryParam("searchStr") String searchStr, @PathParam("connectorentity") String connectorEntity) throws com.priint.pubserver.exception.PubServerException
      Nicht im HTTPConnector
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getPricesByIdentifier

      @GET @Path("/{connector}/{instance}/Price/{connectorentity}/{ID}") public com.priint.pubserver.plugin.entitydata.Data getPricesByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String id, @QueryParam("searchStr") String searchStr, @QueryParam("groupid") @DefaultValue("false") Boolean groupid) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getPricesOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/Price") public com.priint.pubserver.plugin.entitydata.Data getPricesOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getPricesOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{parentconnectorentity}/{ID}/Price/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getPricesOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("parentconnectorentity") com.priint.pubserver.plugin.entitydata.ConnectorEntity parentconnectorentity, @PathParam("ID") String bucketId, @PathParam("connectorentity") String connectorEntity, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTableData

      @GET @Path("/{connector}/{instance}/TableData/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getTableData(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTableDataByIdentifier

      @GET @Path("/{connector}/{instance}/TableData/{connectorentity}/{ID}") public com.priint.pubserver.plugin.entitydata.Data getTableDataByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr, @QueryParam("groupid") @DefaultValue("false") Boolean groupid) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTableDataOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/TableData") public com.priint.pubserver.plugin.entitydata.Data getTableDataOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTableDataOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{parentconnectorentity}/{ID}/TableData/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getTableDataOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("parentconnectorentity") com.priint.pubserver.plugin.entitydata.ConnectorEntity parentconnectorentity, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTexts

      @GET @Path("/{connector}/{instance}/Text/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getTexts(@PathParam("connector") String connector, @PathParam("instance") String instance, @QueryParam("searchStr") String searchStr, @PathParam("connectorentity") String connectorEntity) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTextsByIdentifier

      @GET @Path("/{connector}/{instance}/Text/{connectorentity}/{ID}") public com.priint.pubserver.plugin.entitydata.Data getTextsByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("ID") String bucketId, @PathParam("connectorentity") String connectorEntity, @QueryParam("searchStr") String searchStr, @QueryParam("groupid") @DefaultValue("false") Boolean groupid) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTextsOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{connectorentity}/{ID}/Text") public com.priint.pubserver.plugin.entitydata.Data getTextsOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • getTextsOfBucket

      @GET @Path("/{connector}/{instance}/Bucket/{parentconnectorentity}/{ID}/Text/{connectorentity}") public com.priint.pubserver.plugin.entitydata.Data getTextsOfBucket(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("parentconnectorentity") com.priint.pubserver.plugin.entitydata.ConnectorEntity parentconnectorentity, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("searchStr") String searchStr) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • deleteEntityDataByIdentifier

      @DELETE @Path("/{connector}/{instance}/{entityType}/{connectorentity}/{ID}") public com.priint.pubserver.webservice.ServiceResult deleteEntityDataByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("connectorentity") String connectorEntity, @PathParam("ID") String bucketId, @QueryParam("entitytype") String entityType, com.priint.pubserver.plugin.entitydata.EntityData entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • putEntityDataByIdentifier

      @PUT @Path("/{connector}/{instance}/{entityType}/{connectorentity}/{ID}") public com.priint.pubserver.webservice.ServiceResult putEntityDataByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("ID") String bucketId, @PathParam("connectorentity") String connectorEntity, @QueryParam("entitytype") String entityType, com.priint.pubserver.plugin.entitydata.EntityData entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException
    • postEntityDataByIdentifier

      @POST @Path("/{connector}/{instance}/{entityType}/{connectorentity}/{ID}") public com.priint.pubserver.webservice.ServiceResult postEntityDataByIdentifier(@PathParam("connector") String connector, @PathParam("instance") String instance, @PathParam("ID") String bucketId, @PathParam("connectorentity") String connectorEntity, @QueryParam("entitytype") String entityType, com.priint.pubserver.plugin.entitydata.EntityData entityData) throws com.priint.pubserver.exception.PubServerException
      Throws:
      com.priint.pubserver.exception.PubServerException