Package com.priint.pubserver.plugin.interfaces

Interface ConnectorRemote

All Superinterfaces:
PluginControl
All Known Subinterfaces:
ConnectorLocal
All Known Implementing Classes:
AbstractConnector
public interface ConnectorRemote extends PluginControl
Interface for a connector class designed for connecting publishing hub with a content system.

If a connector does not want to give a specific implementation of a method, it is expected to throw a com.priint.pubserver.plugin.exceptions.NotImplementedException.

Since:
4.0.0, 4.1.6 added several overloadings for methods to get content for a bucket (added a parentEntityIdentifier parameter).
See Also:
  • com.priint.pubserver.plugin.exception#NotImplementedException(java.lang.Class, java.lang.String)

  • Method Details

    • getConnectorEntities

      List<ConnectorEntity> getConnectorEntities() throws NotImplementedException, DataSourceException, ConnectorException
      For every entity in the publishing server the correspondent entity from the connector is deposited.

      This method returns ALL connector entities served by the content system via the connector.

      Returns:
      List of ALL connector entities served by the content system via the connector or an empty list if no entities are served by the content system.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getRootBuckets

      List<Bucket> getRootBuckets(Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Returns the top level nodes from an hierarchy.
      Parameters:
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all matching root buckets or an empty list if no matching root buckets are found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getChildBuckets

      List<Bucket> getChildBuckets(String bucketId, Context context, ConnectorEntity connectorEntity, String parentBucketConnectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get the subordinated buckets for a given bucket.
      Parameters:
      bucketId - The ID of the source bucket of all subordinated buckets.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      parentBucketConnectorEntity - A content system specific hint used to find the parent bucket, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label (e.g. part of con_bucket.label) or value field of the content.
      Implementation may be connector specific.
      Returns:
      List of all subordinated buckets from one given bucket or
      an empty list if no matching buckets are found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getCordedBuckets

      List<Bucket> getCordedBuckets(String bucketId, Context context, ConnectorRemote.Direction directed, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get buckets which are connected via cords.

      The cords are directional connections. That means: A cord points from a source bucket to a destination bucket. Therefore you have to decide which buckets to return:

      • the buckets where the current bucket points to
      • the buckets which points to the current bucket
      • both of them
      Parameters:
      bucketId - Id of the source bucket in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      directed - Indication if only the buckets needed which point away from or point to the source bucket or both.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label (e.g. part of con_bucket.label) or value field of the content.
      Implementation may be connector specific.
      Returns:
      List of buckets which are connected with the source bucket via cords or an empty list if no matching buckets are found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getBucketsByGroupIdentifier

      List<Bucket> getBucketsByGroupIdentifier(String groupIdentifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Searching for buckets via group identifier and optional context, connectorEntity and label.
      Parameters:
      groupIdentifier - Group identifier of the bucket.
      The group identifier must NOT be unique. Associated with the context it will be unique.
      If no context is indicated, all context variations will be given back.
      context - Optional context needed to get the language and the country of the context..
      connectorEntity - The connectorEntity for which buckets have to give out.
      searchStr - Optional part of con_bucket.label, the internal name of the container.
      Returns:
      A List of matching buckets or
      an empty list if no matching buckets are found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getBucketsByIdentifier

      List<Bucket> getBucketsByIdentifier(String identifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Searching for buckets via identifier and optional context, connectorEntity and label.
      Parameters:
      identifier - Identifier of the buckets in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      A List of matching buckets or
      an empty list if no matching buckets are found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getBuckets

      List<Bucket> getBuckets(String searchStr, Context context, ConnectorEntity connectorEntity) throws NotImplementedException, DataSourceException, ConnectorException
      Searching for certain buckets via context and searchStr alone.
      Parameters:
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      Returns:
      List of all needed buckets or an empty list if no bucket has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getCordsOfBuckets

      List<Cord> getCordsOfBuckets(String bucketId, ConnectorEntity connectorEntity, Context context, ConnectorRemote.Direction directed, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get cords of a bucket.

      The cords are directional connections. That means: A cord points from a source bucket to a destination bucket. Therefore you have to decide which cords to return:

      • the cords where the current bucket points to
      • the cords which points to the current bucket
      • both of them
      Parameters:
      bucketId - Id of the source bucket in the content system.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      context - Optional context needed to restrict the query to certain language, country, etc..
      directed - Indication if only the buckets needed which point away from or point to the source bucket or both.
      searchStr - Search pattern typically used for filtering the label (e.g. part of con_cord.label) or value field of the content.
      Implementation may be connector specific.
      Returns:
      A List of matching cords or an empty list if no matching cords are found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getCords

      List<Cord> getCords(String searchStr, Context context, ConnectorEntity connectorEntity) throws NotImplementedException, DataSourceException, ConnectorException
      Searching for certain Cords via context and searchStr alone.
      Parameters:
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      Returns:
      List of all needed Cords or an empty list if no Cords has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getCordsByIdentifier

      default List<Cord> getCordsByIdentifier(String identifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get cord by its identifier.
      Parameters:
      identifier - Identifier of the searched cords in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all needed cords or an empty list if no cords has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getTextsOfBucket

      List<Text> getTextsOfBucket(String parentBucketId, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get texts for a given bucket.
      Parameters:
      parentBucketId - Id of the source bucket in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all texts from a given bucket or an empty list if the bucket has no texts matching context and searchStr.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getTexts

      List<Text> getTexts(String searchStr, Context context, ConnectorEntity connectorEntity) throws NotImplementedException, DataSourceException, ConnectorException
      Searching for certain texts via context and searchStr.
      Parameters:
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      Returns:
      List of all matching texts or an empty list if no texts has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getTextsByIdentifier

      List<Text> getTextsByIdentifier(String identifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get text by its identifier.
      Parameters:
      identifier - Identifier of the searched texts in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all needed texts or an empty list if no texts has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getTextsByGroupIdentifier

      List<Text> getTextsByGroupIdentifier(String groupIdentifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get texts via group identifier.
      Parameters:
      groupIdentifier - Group identifier of the texts. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all needed texts or an empty list if no texts has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getKeyValuesOfBucket

      List<KeyValue> getKeyValuesOfBucket(String parentBucketId, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get key value objects for a given bucket.
      Parameters:
      parentBucketId - Id of the source bucket in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all key value objects from a given bucket or an empty list if the bucket has no matching key value objects.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getKeyValuesByIdentifier

      List<KeyValue> getKeyValuesByIdentifier(String identifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get keyvalue objects via its identifier.
      Parameters:
      identifier - Identifier of the key values in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all keyvalue objects for a given identifier or an empty list if no matching keyvalue objects have been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getKeyValuesByGroupIdentifier

      List<KeyValue> getKeyValuesByGroupIdentifier(String groupIdentifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get key value objects via group identifier.
      Parameters:
      groupIdentifier - Group identifier of the key values. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all key value objects for a given group identifier or an empty list if no matching key value objects could be found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getKeyValues

      List<KeyValue> getKeyValues(String searchStr, Context context, ConnectorEntity connectorEntity) throws NotImplementedException, DataSourceException, ConnectorException
      Get certain keyValues by context and searchStr alone.
      Parameters:
      searchStr - Search pattern typically used for filtering the label (e.g. part of con_key_value.key_label) or value field of the content.
      Implementation may be connector specific.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      Returns:
      List of all matching keyValues or an empty list if no keyValues has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getMediaAssetsOfBucket

      List<MediaAsset> getMediaAssetsOfBucket(String parentBucketId, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get media assets for a given bucket.
      Parameters:
      parentBucketId - Id of the source bucket in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all matching media assets for a given bucket or an empty list if no media assets have been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getMediaAssetsByIdentifier

      List<MediaAsset> getMediaAssetsByIdentifier(String identifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get media assets for an identifier.
      Parameters:
      identifier - Identifier of the searched media assets
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all matching media assets for an identifier or an empty list if no media assets have been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getMediaAssetsByGroupIdentifier

      List<MediaAsset> getMediaAssetsByGroupIdentifier(String groupIdentifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get media assets for a group identifier.
      Parameters:
      groupIdentifier - Group identifier of the media assets. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all matching media assets or an empty list if no media assets has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getMediaAssets

      List<MediaAsset> getMediaAssets(String searchStr, Context context, ConnectorEntity connectorEntity) throws NotImplementedException, DataSourceException, ConnectorException
      Searching for certain MediaAssets via context and searchStr alone.
      Parameters:
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      Returns:
      List of all matching mediaAssets or an empty list if no mediaAssets has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getPricesOfBucket

      List<Price> getPricesOfBucket(String parentBucketId, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get prices for a given bucket.
      Parameters:
      parentBucketId - Id of the source bucket in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of prices for a given bucket or an empty list if no matching prices have been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getPricesByIdentifier

      List<Price> getPricesByIdentifier(String identifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get prices via identifier.
      Parameters:
      identifier - Identifier of the searched prices
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of matching prices or an empty list if no prices has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getPricesByGroupIdentifier

      List<Price> getPricesByGroupIdentifier(String groupIdentifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get prices for a group identifier.
      Parameters:
      groupIdentifier - Group identifier of the prices. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of matching prices or an empty list if no prices has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getPrices

      List<Price> getPrices(String searchStr, Context context, ConnectorEntity connectorEntity) throws NotImplementedException, DataSourceException, ConnectorException
      Get Prices matching a certain context and searchStr alone.
      Parameters:
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      Returns:
      List of all matching prices or an empty list if no prices has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getTableData

      List<TableData> getTableData(String searchStr, Context context, ConnectorEntity connectorEntity) throws NotImplementedException, DataSourceException, ConnectorException
      Get TableData matching a certain context and searchStr alone.
      Parameters:
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      Returns:
      List of all matching tables or an empty list if no table has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getTableDataByGroupIdentifier

      List<TableData> getTableDataByGroupIdentifier(String groupIdentifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get tables for a group identifier.
      Parameters:
      groupIdentifier - Group identifier of the tables. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of matching tables or an empty list if no table has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.5

    • getTableDataByIdentifier

      List<TableData> getTableDataByIdentifier(String identifier, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get table data by its identifier.
      Parameters:
      identifier - Identifier of the searched table data in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all needed table data or an empty list if no table data has been found.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getTableDataOfBucket

      List<TableData> getTableDataOfBucket(String parentBucketId, Context context, ConnectorEntity connectorEntity, String searchStr) throws NotImplementedException, DataSourceException, ConnectorException
      Get table data for a given bucket.
      Parameters:
      parentBucketId - Id of the source bucket in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
      Returns:
      List of all table data from a given bucket or an empty list if the bucket has no table data matching context and searchStr.
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.0.0

    • getContentMetadataOfBucket

      List<ContentMetaData> getContentMetadataOfBucket(String parentBucketId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given bucket.
      Parameters:
      parentBucketId - Id of the source bucket in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given bucket or an empty list if the bucket has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getContentMetadataOfKeyValue

      List<ContentMetaData> getContentMetadataOfKeyValue(String keyValueId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given key value.
      Parameters:
      keyValueId - Id of the source keyValue in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given keyValue or an empty list if the keyValue has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getContentMetadataOfPlanning

      List<ContentMetaData> getContentMetadataOfPlanning(String planningId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given planningId.
      Parameters:
      planningId - Id of the source planning in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given planning or an empty list if the planning has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getRootContentMetadataOfPlanning

      List<ContentMetaData> getRootContentMetadataOfPlanning(String parentId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Throws:
      DataSourceException
      ConnectorException

    • getContentMetadataOfTableData

      List<ContentMetaData> getContentMetadataOfTableData(String tableDataId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given tableDataId.
      Parameters:
      tableDataId - Id of the source tableData in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given tableData or an empty list if the tableData has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getContentMetadataOfMediaAsset

      List<ContentMetaData> getContentMetadataOfMediaAsset(String mediaAssetId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given mediaAssetId.
      Parameters:
      mediaAssetId - Id of the source mediaAsset in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given mediaAsset or an empty list if the mediaAsset has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getContentMetadataOfCord

      List<ContentMetaData> getContentMetadataOfCord(String cordId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given cordId.
      Parameters:
      cordId - Id of the source cord in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given cord or an empty list if the cord has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getContentMetadataOfText

      List<ContentMetaData> getContentMetadataOfText(String textId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given textId.
      Parameters:
      textId - Id of the source text in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given text or an empty list if the text has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getContentMetadataOfPrice

      List<ContentMetaData> getContentMetadataOfPrice(String priceId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given priceId.
      Parameters:
      priceId - Id of the source price in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given price or an empty list if the price has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getContentMetadataOfMetadata

      List<ContentMetaData> getContentMetadataOfMetadata(String metaDataId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given metaDataId.
      Parameters:
      metaDataId - Id of the source contentMetaData in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given contentMetaData or an empty list if the contentMetaData has no content meta data matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • getContentMetadataByIdentifier

      List<ContentMetaData> getContentMetadataByIdentifier(String metaDataId, Context context, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException
      Get content meta data for a given identifier.
      Parameters:
      metaDataId - Id of the source contentMetaData in the content system.
      context - Optional context needed to restrict the query to certain language, country, etc.
      connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
      searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
      Returns:
      List of content meta data for a given metaDataId or an empty list if the contentMetaData not exists or no matching context and searchStr.
      Throws:
      DataSourceException
      ConnectorException
      Since:
      4.1.5

    • clearCaches

      void clearCaches() throws NotImplementedException, DataSourceException, ConnectorException
      Clean JPA cache for connector
      Throws:
      NotImplementedException
      DataSourceException
      ConnectorException
      Since:
      4.3