Package org.codice.ddf.platform.services.common

Interface Describable

public interface Describable
Describable is used to capture a basic description of a service. This provides valuable runtime information to the user regarding the application bundles and OSGi.

It is expected that the children are services that perform specific tasks.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Returns a description of the describable item.
    String
    getId()
    Returns the name, aka ID, of the describable item.
    String
    getOrganization()
    Returns the organization associated with the describable item.
    String
    getTitle()
    Returns the title of the describable item.
    String
    getVersion()
    Returns the version.

  • Method Details

    • getVersion

      String getVersion()
      Returns the version.
      Returns:
      the version of the item being described (example: 1.0)

    • getId

      String getId()
      Returns the name, aka ID, of the describable item. The name should be unique for each instance within the scope of a service or a component. For example, this is unique for any Migratable in a set of Migratables. It is not necessarily unique between Migratables and Metacards.

      Format should be [product].[component] such as ddf.metacards, or ddf.platform; while the [component] within a [product] may simply be a module or bundle name, the [product] itself should be the unique name of the plug-in or integration that belongs to the organization listed in getOrganization(). Note that 'ddf' as a [product] is reserved for core features only.

      Returns:
      ID of the item

    • getTitle

      String getTitle()
      Returns the title of the describable item. It is generally more verbose than the name (aka ID).
      Returns:
      title of the item (example: File System Provider)

    • getDescription

      String getDescription()
      Returns a description of the describable item.
      Returns:
      description of the item (example: Provider that returns back static results)

    • getOrganization

      String getOrganization()
      Returns the organization associated with the describable item.
      Returns:
      organizational name or acronym (example: USAF)