Package org.codice.ddf.admin.application.plugin

Interface ApplicationPlugin

All Known Implementing Classes:
AbstractApplicationPlugin
@Deprecated public interface ApplicationPlugin
Deprecated.
going away in a future release. Defines an application configuration plugin.

  • Field Details

    • ALL_ASSOCATION_KEY

      static final String ALL_ASSOCATION_KEY
      Deprecated.
      key to mark that a plugin should be used for ALL applications.
      See Also:

    • DISPLAY_NAME_KEY

      static final String DISPLAY_NAME_KEY
      Deprecated.
      key for the display name. Used for creating json.
      See Also:

    • APPLICATION_ASSOCIATION_KEY

      static final String APPLICATION_ASSOCIATION_KEY
      Deprecated.
      key for the application name. Used for creating json.
      See Also:

    • IFRAME_LOCATION_KEY

      static final String IFRAME_LOCATION_KEY
      Deprecated.
      key for the iframe location. Used for creating json.
      See Also:

    • ID_KEY

      static final String ID_KEY
      Deprecated.
      key for the id location. Used for creating json.
      See Also:

  • Method Details

    • getAssocations

      @Deprecated List<String> getAssocations()
      Deprecated.
      Returns a list of applications that this plugin should be associated with.
      Returns:
      a list of applications that this plugin should be associated with.

    • getDisplayName

      @Deprecated String getDisplayName()
      Deprecated.
      Returns the display name. This is the value that will be display to the user.
      Returns:
      the display name.

    • getID

      @Deprecated UUID getID()
      Deprecated.
      Returns the id of this plugin. This is an unique identifier for the front end javascript.
      Returns:
      a unique identifier for this plugin as a uuid.

    • getIframeLocation

      @Deprecated String getIframeLocation()
      Deprecated.
      Returns the iframe location. Can be null.
      Returns:
      the iframe location.

    • toJSON

      @Deprecated Map<String,Object> toJSON()
      Deprecated.
      Utility method that will handle the conversion of this object to something jolokia can convert to json.
      Returns:
      a constructed map that jolokia can convert to json.

    • matchesAssocationName

      @Deprecated boolean matchesAssocationName(String assocationName)
      Deprecated.
      Handles figuring out if this plugin is matching to the app name sent in. This will handle the case where a plugin should be used for all.
      Parameters:
      appName - - the name of the application we are going to test.
      Returns:
      yes if the application matches, or should be applied to all applications, false if it doesn't.

    • setAssociations

      @Deprecated void setAssociations(List<String> assocations)
      Deprecated.
      Sets the application assocations to the inputted values. This will overwrite all previous values.
      Parameters:
      appName - - the string name of an application.

    • addAssocations

      @Deprecated void addAssocations(List<String> assocations)
      Deprecated.
      Adds an application assocation list to the existing list. This does not overwrite the previous values, and if there is an existing value it wont add it.
      Parameters:
      applicationAssociations -

    • addAssociations

      @Deprecated void addAssociations(String assocations)
      Deprecated.
      Adds a single application association to this plugin. If the application is already there, then nothing will happen.
      Parameters:
      applicationAssocation - - the string name of the application.