Package de.iip_ecosphere.platform.services

Interface ArtifactDescriptor

All Known Implementing Classes:
AbstractArtifactDescriptor
public interface ArtifactDescriptor
Describes an artifact consisting of services.
Author:
Holger Eichelberger, SSE

  • Method Details

    • getId

      String getId()
      Returns the unique id of the artifact.
      Returns:
      the artifact id

    • getName

      String getName()
      Returns the name of the artifact.
      Returns:
      the name, may be the file name

    • getUsageCount

      int getUsageCount()
      Returns the usage count.
      Returns:
      the usage count

    • increaseUsageCount

      int increaseUsageCount()
      Increases the usage count and returns the new count. Without calling this method, the usage count of this instance is initially 0.
      Returns:
      the new value,

    • decreaseUsageCount

      int decreaseUsageCount()
      Decreases the usage count and returns the new count.
      Returns:
      the new value,

    • getServiceIds

      Set<String> getServiceIds()
      Returns the ids of all services provided by the artifact.
      Returns:
      the ids

    • getUri

      URI getUri()
      Returns the canonical URI the artifact was loaded from.
      Returns:
      the canonical URI

    • getServices

      Collection<? extends ServiceDescriptor> getServices()
      Returns the services provided by the artifact independent of their state.
      Returns:
      the service descriptors

    • getServers

      Collection<? extends ServiceDescriptor> getServers()
      Returns the server specifications as services provided by the artifact.
      Returns:
      the service descriptors

    • getService

      ServiceDescriptor getService(String id)
      Returns a service descriptor.
      Parameters:
      id - the id of the service
      Returns:
      the related service descriptor or null if the service is not provided by this artifact

    • getServer

      ServiceDescriptor getServer(String id)
      Returns a service descriptor for a server.
      Parameters:
      id - the id of the server
      Returns:
      the related service descriptor or null if the server is not provided by this artifact