Package com.dtolabs.rundeck.core.plugins.configuration

Interface Description

  • All Known Implementing Classes:
    AbstractBaseDescription
    public interface Description
    Description defines configuration properties of a plugin provider

    • Method Detail

      • getName

        java.lang.String getName()
        Returns:
        the provider name

      • getTitle

        java.lang.String getTitle()
        Returns:
        the textual title of the provider

      • getDescription

        java.lang.String getDescription()
        Returns:
        the textual description of this provider.

      • getProperties

        java.util.List<Property> getProperties()
        Returns:
        the properties

      • getMetadata

        default java.util.Map<java.lang.String,​java.lang.String> getMetadata()
        Returns:
        additional metadata about the provider, may include style or icon information such as 'glyphicon' for glyphicon icon name, 'faicon' for font-awesome icon name

      • getPropertiesMapping

        java.util.Map<java.lang.String,​java.lang.String> getPropertiesMapping()
        Returns:
        a map of config prop keys to external project property names, allowing input values to be in properties files

      • getFwkPropertiesMapping

        java.util.Map<java.lang.String,​java.lang.String> getFwkPropertiesMapping()
        Returns:
        a map of config prop keys to external framework property names, allowing input values to be in properties files

      • getPluginGroupType

        default <T extends PluginGroup> java.lang.Class<T> getPluginGroupType()
        plugin group type if set, otherwise null
        Type Parameters:
        T -
        Returns:

      • isHighlighted

        default boolean isHighlighted()

      • getOrder

        default int getOrder()