Package com.priint.pubserver.entitydata.service

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 and 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.

  • Field Details

    • MAPPED_NAME

      public static final String MAPPED_NAME
      The mapped name for the `ConnectorService` class.

      This constant is used to identify the service in the application server's JNDI registry. It provides a unique identifier for the `ConnectorService` to be referenced in the application.

      See Also:

  • 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
      Retrieves buckets for a given connector instance, either as root buckets or regular buckets based on the root parameter.

      This method is an overloaded version of getBuckets(String, String, String, String, Boolean) where the connectorentity is set to a wildcard ("*"). It allows querying for buckets without specifying a particular connector entity.

      If root is set to true, it will return root-level buckets. If root is false, it returns non-root buckets. You can also provide a search string to filter the results.

      Example usage (root buckets): 

       GET /EntityDataService/connector/myConnector/instance1/Bucket?searchStr=product
      Example usage (non-root buckets): 
       GET /EntityDataService/connector/myConnector/instance1/Bucket?root=false&searchStr=product
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      searchStr - optional search string to filter the results
      root - true to retrieve root buckets, false to retrieve non-root buckets
      Returns:
      a Data object containing the matching Bucket entries
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves buckets for a given connector entity, either as root buckets or regular buckets based on the root parameter.

      If root is set to true, this method will return root-level buckets for the specified connector entity. If root is false, it will return regular buckets that are not necessarily root-level. You can also provide a search string to filter the results.

      Example usage (root buckets): 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product
      Example usage (non-root buckets): 
       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product?root=false
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      connectorEntity - the name of the connector entity (e.g., "Product")
      searchStr - optional search string to filter the results
      root - true to retrieve root buckets, false to retrieve non-root buckets
      Returns:
      a Data object containing the matching Bucket entries
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves buckets by their identifier or group identifier for a given connector entity.

      This method allows querying buckets either directly by their ID or by a group ID if the groupid flag is set to true. You can also filter the results using an optional search string.

      Example usage (by identifier): 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000
      Example usage (by group ID): 
       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000?groupid=true
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      bucketId - the bucket ID or group ID to search for
      connectorEntity - the name of the connector entity (e.g., "Product")
      searchStr - optional search string to filter the results
      groupid - true to search by group identifier, false to search by exact identifier
      Returns:
      a Data object containing the matching Bucket entries
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves either child buckets or corded buckets for a given bucket ID, depending on the corded parameter.

      When corded is set to true, the method returns buckets connected via edges (corded buckets). When corded is false, it returns the direct child buckets for the given bucket.

      You can also specify the direction of the relation (for corded buckets) and an optional search string to filter results.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/Bucket?corded=true&direction=INCOMING&searchStr=logo
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      connectorEntity - the name of the parent connector entity (e.g., "Product")
      bucketId - the ID of the parent bucket
      corded - whether to retrieve corded (related) buckets instead of direct child buckets (default is false)
      directed - the direction of the edge relation (only relevant when corded is true); defaults to OUTGOING
      searchStr - optional search string to filter results
      Returns:
      a Data object containing the list of Bucket elements
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves the child buckets for a given parent bucket from a specified connector and sub-entity.

      This method is part of the connector interface and allows querying nested bucket structures within a connector-based entity model.

      The connector, instance, entity name, sub-entity, and bucket ID must be provided in the path. An optional search string can be supplied as a query parameter to filter the child buckets.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/Bucket/Asset?searchStr=logo
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      connectorEntity - the name of the parent connector entity (e.g., "Product")
      subConnectorEntity - the sub-entity from which child buckets will be retrieved (e.g., "Asset")
      bucketId - the ID of the parent bucket
      searchStr - optional search string to filter results
      Returns:
      a Data object containing the list of child Bucket elements
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves content metadata for a given identifier from a specified connector entity.

      This method queries content metadata associated with the provided ID and connector entity. You can also filter the results using an optional search string.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/ContentMetaData/Product/1000
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/ContentMetaData/Product/1000?searchStr=video
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      connectorEntity - the name of the connector entity (e.g., "Product")
      id - the ID of the content metadata to retrieve
      searchStr - optional search string to filter the results
      Returns:
      a Data object containing the retrieved ContentMetaData entries
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves content metadata associated with a specific bucket in a given connector entity.

      This method queries the content metadata related to the provided bucket ID and connector entity. You can also filter the results using an optional search string.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/ContentMetaData
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/ContentMetaData?searchStr=video
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      connectorEntity - the name of the connector entity (e.g., "Product")
      bucketId - the ID of the bucket for which content metadata is to be retrieved
      searchStr - optional search string to filter the results
      Returns:
      a Data object containing the content metadata associated with the bucket
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves content metadata associated with a specific bucket in a given connector entity, with support for a parent connector entity.

      This method queries content metadata related to the provided bucket ID, connector entity, and parent connector entity. You can also filter the results using an optional search string.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/ContentMetaData/Media
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/ContentMetaData/Media?searchStr=video
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      parentconnectorentity - the parent connector entity (used for more specific queries)
      connectorEntity - the name of the connector entity (e.g., "Product")
      bucketId - the ID of the bucket for which content metadata is to be retrieved
      searchStr - optional search string to filter the results
      Returns:
      a Data object containing the content metadata associated with the bucket
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves the list of connector entities for a given connector and instance.

      This method queries the available connector entities for the specified connector and instance. It returns a list of all connector entities associated with that particular connector.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/ConnectorEntity
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      Returns:
      a Data object containing a list of ConnectorEntity objects
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves a list of cords associated with a specific connector entity.

      This method queries the cords for the specified connector and instance. You can also filter the results using an optional search string.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Cord/Product
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/Cord/Product?searchStr=video
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      searchStr - optional search string to filter the results
      connectorEntity - the name of the connector entity (e.g., "Product")
      Returns:
      a Data object containing the cords associated with the specified connector entity
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves a list of cords associated with a specific identifier for a given connector entity.

      This method queries cords for the specified connector and instance by identifier. You can also filter the results using an optional search string. If the `groupid` parameter is set to true, the method will throw a NotImplementedException since querying by `groupid` is currently not supported.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Cord/Product/1000
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/Cord/Product/1000?searchStr=video
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      connectorEntity - the name of the connector entity (e.g., "Product")
      bucketId - the ID of the bucket for which cords are to be retrieved
      searchStr - optional search string to filter the results
      groupid - optional flag to query by group identifier (currently not supported)
      Returns:
      a Data object containing the cords associated with the specified identifier
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data
      com.priint.pubserver.plugin.exception.NotImplementedException - if querying by `groupid` is requested but not supported

    • 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
      Retrieves a list of cords associated with a specific bucket and connector entity.

      This method queries the cords related to a specific bucket identified by its ID, for a given connector entity. You can optionally filter the results using a search string and specify the direction of the cords (e.g., "OUTGOING" or "INCOMING").

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/Cord
      Example usage with a search string and direction: 
       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/Cord?searchStr=video&direction=INCOMING
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      bucketId - the ID of the bucket for which cords are to be retrieved
      connectorEntity - the name of the connector entity (e.g., "Product")
      directed - the direction of the cords (e.g., "OUTGOING" or "INCOMING")
      searchStr - optional search string to filter the results
      Returns:
      a Data object containing the cords associated with the specified bucket and connector entity
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves a list of cords associated with a specific bucket, parent connector entity, and connector entity.

      This method queries the cords related to a specific bucket identified by its ID and the parent connector entity, along with the specified connector entity. You can optionally filter the results using a search string and specify the direction of the cords (e.g., "OUTGOING" or "INCOMING").

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/Cord/Product
      Example usage with search string and direction: 
       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1000/Cord/Product?searchStr=video&direction=INCOMING
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      bucketId - the ID of the bucket for which cords are to be retrieved
      parentConnectorEntityId - the ID of the parent connector entity (e.g., "Product")
      connectorEntity - the name of the connector entity (e.g., "Video")
      directed - the direction of the cords (e.g., "OUTGOING" or "INCOMING")
      searchStr - optional search string to filter the results
      Returns:
      a Data object containing the cords associated with the specified bucket, parent connector entity, and connector entity
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves a list of key-value pairs associated with a specific connector entity.

      This method queries key-value pairs for a specific connector entity and allows filtering by a search string. The results are returned in a Data object, which includes a list of key-value pairs.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/KeyValue/Product
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/KeyValue/Product?searchStr=video
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      searchStr - optional search string to filter the results by key or value
      connectorEntity - the name of the connector entity (e.g., "Product")
      Returns:
      a Data object containing the key-value pairs associated with the specified connector entity
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves a list of key-value pairs associated with a specific connector entity and identifier.

      This method queries key-value pairs for a specific connector entity and identifier, and allows filtering by a search string. It also supports grouping by identifier if the `groupid` query parameter is set to true. The results are returned in a Data object, which includes a list of key-value pairs.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/KeyValue/Product/1001
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/KeyValue/Product/1001?searchStr=price
      Example usage with grouping enabled: 
       GET /EntityDataService/connector/myConnector/instance1/KeyValue/Product/1001?groupid=true
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      bucketId - the identifier for the bucket (e.g., "1001")
      connectorEntity - the name of the connector entity (e.g., "Product")
      searchStr - optional search string to filter the results by key or value
      groupid - optional flag to enable grouping by identifier (default is false)
      Returns:
      a Data object containing the key-value pairs associated with the specified connector entity and identifier
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves a list of key-value pairs associated with a specific bucket and connector entity.

      This method queries key-value pairs for a specific bucket identified by its ID and a specific connector entity, and allows filtering by a search string. The results are returned in a Data object, which includes a list of key-value pairs.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1001/KeyValue
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1001/KeyValue?searchStr=price
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      connectorEntity - the name of the connector entity (e.g., "Product")
      bucketId - the identifier for the bucket (e.g., "1001")
      searchStr - optional search string to filter the results by key or value
      Returns:
      a Data object containing the key-value pairs associated with the specified bucket and connector entity
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves a list of key-value pairs associated with a specific bucket, connector entity, and parent connector entity.

      This method queries key-value pairs for a specific bucket, identified by its ID, and allows filtering by a search string. The key-value pairs are fetched for a specific connector entity and its parent connector entity. The results are returned in a Data object, which includes a list of key-value pairs.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1001/KeyValue/Category
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/Bucket/Product/1001/KeyValue/Category?searchStr=price
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      parentConnectorEntityId - the identifier of the parent connector entity
      connectorEntity - the name of the connector entity (e.g., "Category")
      bucketId - the identifier for the bucket (e.g., "1001")
      searchStr - optional search string to filter the results by key or value
      Returns:
      a Data object containing the key-value pairs associated with the specified bucket, connector entity, and parent connector entity
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the data

    • 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
      Retrieves a list of media assets associated with a specific connector entity.

      This method queries the media assets for a specific connector and connector entity. Optionally, you can filter the results using a search string to find specific media assets. The results are returned in a Data object, which includes a list of media assets.

      Example usage: 

       GET /EntityDataService/connector/myConnector/instance1/MediaAsset/Video
      Example usage with a search string: 
       GET /EntityDataService/connector/myConnector/instance1/MediaAsset/Video?searchStr=summer
      Parameters:
      connector - the connector identifier (e.g., "PublishingHubDB")
      instance - the connector instance name
      searchStr - optional search string to filter the media assets (e.g., "summer")
      connectorEntity - the name of the connector entity (e.g., "Video")
      Returns:
      a Data object containing the media assets associated with the specified connector and connector entity
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error accessing the connector or retrieving the media assets

    • 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
      Retrieves media assets by a given identifier.

      This method fetches a list of media assets for the provided connector, instance, and connector entity, filtered by the specified identifier. Optionally, the assets can be grouped based on the identifier if the `groupid` query parameter is set to `true`.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      id - The identifier of the media asset to be fetched.
      connectorEntity - The name of the connector entity.
      searchStr - The search string used to filter media assets. This can be a partial string that is matched against metadata or other fields of the media asset.
      groupid - A boolean flag indicating whether the media assets should be grouped by the identifier. The default value is `false`, meaning assets are fetched by their identifier. Set to `true` if assets should be grouped.
      Returns:
      A Data object containing a list of MediaAsset objects that match the provided criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the media assets, such as connection issues or invalid parameters.

    • 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
      Retrieves media assets of a specific bucket.

      This method fetches a list of media assets for the given connector, instance, and connector entity, related to a specified bucket identifier. Optionally, the assets can be filtered using the provided search string.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      connectorEntity - The name of the connector entity.
      bucketId - The identifier of the bucket for which media assets are being fetched.
      searchStr - The search string used to filter media assets. This can be a partial string that is matched against metadata or other fields of the media asset.
      Returns:
      A Data object containing a list of MediaAsset objects related to the specified bucket.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the media assets, such as connection issues or invalid parameters.

    • 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
      Retrieves media assets of a specific bucket, considering a parent connector entity.

      This method fetches a list of media assets for the given connector, instance, and connector entity, associated with a specific parent connector entity, and related to a specified bucket identifier. Optionally, the assets can be filtered using the provided search string.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      parentconnectorentity - The parent connector entity used for context.
      connectorEntity - The name of the connector entity.
      bucketId - The identifier of the bucket for which media assets are being fetched.
      searchStr - The search string used to filter media assets. This can be a partial string that is matched against metadata or other fields of the media asset.
      Returns:
      A Data object containing a list of MediaAsset objects related to the specified bucket.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the media assets, such as connection issues or invalid parameters.

    • 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
      Retrieves a list of prices for the given connector and instance, filtered by an optional search string.

      This method fetches the prices for a specified connector and instance, associated with a particular connector entity. Optionally, the prices can be filtered using the provided search string.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      searchStr - The search string used to filter the prices. This can be a partial string that is matched against price metadata or other fields.
      connectorEntity - The name of the connector entity for which the prices are being retrieved.
      Returns:
      A Data object containing a list of Price objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the prices, such as connection issues or invalid parameters.

    • 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
      Retrieves a list of prices for the given connector, instance, and identifier, filtered by an optional search string.

      This method fetches prices for a specified connector and instance, associated with a particular connector entity. The prices can be retrieved using an identifier, and optionally filtered using the provided search string. Additionally, it supports filtering by group identifier.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      connectorEntity - The name of the connector entity for which the prices are being retrieved.
      id - The identifier used to fetch the prices.
      searchStr - The search string used to filter the prices. This can be a partial string matched against price metadata or other fields.
      groupid - A flag indicating whether to filter by group identifier. Default is false.
      Returns:
      A Data object containing a list of Price objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the prices, such as connection issues or invalid parameters.

    • 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
      Retrieves a list of prices associated with a specific bucket for the given connector, instance, and connector entity.

      This method fetches prices for a specified bucket, connector, and instance, filtered by an optional search string. The prices are retrieved for the given connector entity within the specified bucket ID.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      connectorEntity - The name of the connector entity for which the prices are being retrieved.
      bucketId - The identifier of the bucket for which prices are to be fetched.
      searchStr - The search string used to filter the prices. This can be a partial string matched against price metadata or other fields.
      Returns:
      A Data object containing a list of Price objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the prices, such as connection issues or invalid parameters.

    • 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
      Retrieves a list of prices associated with a specific bucket, for a given connector, instance, parent connector entity, and connector entity.

      This method fetches prices for a specified bucket, connector, and instance, filtered by an optional search string. The prices are retrieved for the given connector entity and parent connector entity within the specified bucket ID.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      parentconnectorentity - The parent connector entity, which is used to resolve the effective connector entity.
      bucketId - The identifier of the bucket for which prices are to be fetched.
      connectorEntity - The name of the connector entity for which the prices are being retrieved.
      searchStr - The search string used to filter the prices. This can be a partial string matched against price metadata or other fields.
      Returns:
      A Data object containing a list of Price objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the prices, such as connection issues or invalid parameters.

    • 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
      Retrieves table data associated with a specific connector, instance, and connector entity.

      This method fetches table data for a given connector, instance, and connector entity, filtered by an optional search string. The data is retrieved for the specified connector entity.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      connectorEntity - The name of the connector entity for which the table data is being retrieved.
      searchStr - The search string used to filter the table data. This can be a partial string matched against table metadata or other fields.
      Returns:
      A Data object containing a list of TableData objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the table data, such as connection issues or invalid parameters.

    • 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
      Retrieves table data associated with a specific connector, instance, connector entity, and identifier.

      This method fetches table data for a given connector, instance, connector entity, and identifier, filtered by an optional search string. It can group the results based on a group identifier if the groupid parameter is true.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      connectorEntity - The name of the connector entity for which the table data is being retrieved.
      bucketId - The unique identifier of the bucket whose table data is being retrieved.
      searchStr - The search string used to filter the table data. This can be a partial string matched against table metadata or other fields.
      groupid - If true, the results will be grouped by identifier. Defaults to false.
      Returns:
      A Data object containing a list of TableData objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the table data, such as connection issues or invalid parameters.

    • 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
      Retrieves table data associated with a specific connector, instance, connector entity, and bucket identifier.

      This method fetches table data for a given connector, instance, connector entity, and bucket identifier, filtered by an optional search string.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      connectorEntity - The name of the connector entity for which the table data is being retrieved.
      bucketId - The unique identifier of the bucket whose table data is being retrieved.
      searchStr - The search string used to filter the table data. This can be a partial string matched against table metadata or other fields.
      Returns:
      A Data object containing a list of TableData objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the table data, such as connection issues or invalid parameters.

    • 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
      Retrieves table data associated with a specific connector, instance, parent connector entity, connector entity, and bucket identifier.

      This method fetches table data for a given connector, instance, parent connector entity, connector entity, and bucket identifier, filtered by an optional search string.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      parentconnectorentity - The parent connector entity associated with the table data.
      connectorEntity - The name of the connector entity for which the table data is being retrieved.
      bucketId - The unique identifier of the bucket whose table data is being retrieved.
      searchStr - The search string used to filter the table data. This can be a partial string matched against table metadata or other fields.
      Returns:
      A Data object containing a list of TableData objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the table data, such as connection issues or invalid parameters.

    • 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
      Retrieves text data associated with a specific connector, instance, and connector entity, filtered by an optional search string.

      This method fetches text data for a given connector, instance, and connector entity, and applies an optional search string filter to narrow down the results.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      searchStr - The search string used to filter the text data. This can be a partial string matched against the text content or metadata.
      connectorEntity - The name of the connector entity for which the text data is being retrieved.
      Returns:
      A Data object containing a list of Text objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the text data, such as connection issues or invalid parameters.

    • 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
      Retrieves text data associated with a specific connector, instance, connector entity, and identifier, filtered by an optional search string and grouped by identifier if specified.

      This method fetches text data for a given connector, instance, and connector entity using an identifier (such as a bucket ID). It supports an optional search string filter and an optional grouping by identifier.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      bucketId - The identifier used to fetch specific text data.
      connectorEntity - The name of the connector entity for which the text data is being retrieved.
      searchStr - The search string used to filter the text data. This can be a partial string matched against the text content or metadata.
      groupid - A flag that determines whether the texts should be grouped by identifier. Default is false.
      Returns:
      A Data object containing a list of Text objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the text data, such as connection issues or invalid parameters.

    • 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
      Retrieves text data associated with a specific connector, instance, connector entity, and bucket ID, filtered by an optional search string.

      This method fetches text data for a given connector, instance, and connector entity, using a specific bucket identifier. It supports an optional search string filter.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      connectorEntity - The name of the connector entity for which the text data is being retrieved.
      bucketId - The identifier of the bucket for which the text data is being fetched.
      searchStr - The search string used to filter the text data. This can be a partial string matched against the text content or metadata.
      Returns:
      A Data object containing a list of Text objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the text data, such as connection issues or invalid parameters.

    • 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
      Retrieves text data associated with a specific connector, instance, parent connector entity, connector entity, and bucket ID, filtered by an optional search string.

      This method fetches text data for a given connector, instance, and connector entity, using a specific bucket identifier. The parent connector entity is used to resolve the effective connector entity. An optional search string can be used to filter the text data.

      Parameters:
      connector - The name of the connector.
      instance - The name of the instance within the connector.
      parentconnectorentity - The parent connector entity that helps resolve the effective connector entity.
      connectorEntity - The name of the connector entity for which the text data is being retrieved.
      bucketId - The identifier of the bucket for which the text data is being fetched.
      searchStr - The search string used to filter the text data. This can be a partial string matched against the text content or metadata.
      Returns:
      A Data object containing a list of Text objects that match the specified criteria.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while retrieving the text data, such as connection issues or invalid parameters.

    • 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
      Deletes an entity's data by its identifier within a specified connector, instance, and entity type.

      This method removes an entity's data based on the provided identifier. It checks if the provided entity data matches the expected entity type and proceeds to delete it from the data store. A successful deletion returns the entity's identifier, while an error returns an error message.

      Parameters:
      connector - The name of the connector where the entity data exists.
      instance - The name of the instance within the connector.
      connectorEntity - The name of the connector entity from which data is being deleted.
      bucketId - The identifier of the bucket where the entity data resides.
      entityType - The type of entity being deleted.
      entityData - The entity data object that is to be deleted. The data will be removed if the entity's class name matches the provided entity type.
      Returns:
      A ServiceResult instance indicating the success or failure of the delete operation. If successful, it contains the identifier of the deleted entity, otherwise an error instance.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while processing the request, such as database issues or invalid parameters.

    • 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
      Updates the data of an entity by its identifier within a specified connector, instance, and entity type.

      This method allows updating an entity's data by its identifier. It first verifies if the provided entity data matches the expected entity type. Then, depending on the entity type, it fetches the current data associated with that identifier, performs the update operation, and returns the result. If the entity type does not match the provided entity data, an error is returned. A successful update returns the entity's identifier, while an error returns an error message.

      Parameters:
      connector - The name of the connector where the entity data exists.
      instance - The name of the instance within the connector.
      bucketId - The identifier of the bucket where the entity data resides.
      connectorEntity - The name of the connector entity for which data is being updated.
      entityType - The type of entity being updated (e.g., "Bucket", "ContentMetaData", "Cord", etc.).
      entityData - The entity data object to be updated. The data will be updated if the entity's class name matches the provided entity type.
      Returns:
      A ServiceResult instance indicating the success or failure of the update operation. If successful, it contains the identifier of the updated entity; otherwise, it contains an error instance.
      Throws:
      com.priint.pubserver.exception.PubServerException - If there is an error while processing the request, such as database issues or invalid parameters.

    • 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
      Persists an `EntityData` object by its identifier within a specified connector, instance, and entity type.

      This method checks if the provided `EntityData` object is not null and its class name matches the specified entity type. If the validation passes, the method persists the `EntityData` object using the appropriate connector and returns a success result containing the identifier of the persisted entity. Otherwise, it returns an error result.

      Parameters:
      connector - the name of the connector where the entity data exists.
      instance - the name of the instance within the connector.
      bucketId - the identifier of the bucket where the entity data resides.
      connectorEntity - the name of the connector entity for which data is being persisted.
      entityType - the type of entity being persisted (e.g., "Bucket", "ContentMetaData", etc.).
      entityData - the `EntityData` object to be persisted. Must not be null and must match the specified entity type.
      Returns:
      a ServiceResult instance indicating the success or failure of the persist operation. If successful, it contains the identifier of the persisted entity; otherwise, it contains an error instance.
      Throws:
      com.priint.pubserver.exception.PubServerException - if there is an error while processing the request, such as database issues or invalid parameters.