Interface CockpitCelumService


public interface CockpitCelumService
Service providing the Cockpit framework with Celum specific functionality.
  • Field Details

  • Method Details

    • getDirectCelumLink

      String getDirectCelumLink(ItemModel item, String celumAssetId, Map<String,String> params)
      Returns a link to be used for opening Celum Imagine from within a Cockpit application.
      Parameters:
      item - default search parameters for this item type will be included in returned link (leave null if no search parameters should be included)
      celumAssetId - celum asset id
      params - custom parameters, some of which are echoed back to the cockpit
      Returns:
      the link to be used for opening Celum Imagine
    • getDirectCelumLink

      String getDirectCelumLink(String celumAssetId, Map<String,String> params)
      Returns a link to be used for opening Celum Imagine from within a Cockpit application.
      Parameters:
      celumAssetId - celum asset id
      params - custom parameters, some of which are echoed back to the cockpit
      Returns:
      the link to be used for opening Celum Imagine
    • getCelumUrl

      String getCelumUrl(TypedObject celumAsset) throws IllegalArgumentException
      Returns the Celum URL of the specified Celum asset.
      Parameters:
      celumAsset - celum asset
      Returns:
      the URL for displaying the Celum asset
      Throws:
      IllegalArgumentException - if celumAsset is null
      See Also:
    • getLocalUrl

      String getLocalUrl(TypedObject celumAsset) throws IllegalArgumentException
      Returns the local URL of the specified Celum asset.
      Parameters:
      celumAsset - celum asset
      Returns:
      the URL for displaying the local version of the Celum asset
      Throws:
      IllegalArgumentException - if celumAsset is null
      See Also:
    • synchronize

      void synchronize(TypedObject celumAsset)
      Synchronize.
      Parameters:
      celumAsset - the celum asset
    • unSynchronize

      void unSynchronize(TypedObject celumAsset)
      Unsynchronize CelumAsset.
      Parameters:
      celumAsset - the celum asset
    • isSynchronized

      boolean isSynchronized(TypedObject celumAsset) throws IllegalArgumentException
      Checks if is CelumAsset is synchronized.
      Parameters:
      celumAsset - the celum asset
      Returns:
      true, if is synchronized
      Throws:
      IllegalArgumentException - the illegal argument exception
    • isAssetValid

      boolean isAssetValid(TypedObject celumAsset)
      Checks if is asset valid.
      Parameters:
      celumAsset - the celum asset
      Returns:
      true, if is asset valid
    • isCelumAlive

      Boolean isCelumAlive()
      Checks if celum server is alive and responding.
      Returns:
      true, if is celum alive
    • getOriginalMediaFormat

      String getOriginalMediaFormat()
      Gets the original media format.
      Returns:
      the original media format
    • getCelumAssetId

      Integer getCelumAssetId(ItemModel asset)
      Parameters:
      asset - item model which might be celum asset
      Returns:
      celum asset id if given item is existing celum asset or null.