com.dtolabs.rundeck.core.plugins
Class AbstractDescribableScriptPlugin
java.lang.Object
com.dtolabs.rundeck.core.plugins.AbstractDescribableScriptPlugin
- All Implemented Interfaces:
- Describable
- Direct Known Subclasses:
- BaseScriptPlugin
public abstract class AbstractDescribableScriptPlugin
- extends java.lang.Object
- implements Describable
AbstractDescribableScriptPlugin is a base ScriptPlugin provider implementation that can be used to provide a
describable interface for a script plugin. The description provided by the base implementation is configured by the
ScriptPluginProvider
's metadata:
title = Title of the Plugin
description = Description of the plugin
config.X.PROPERTY_TYPE = Type name of the property, from Property.Type
config.X.name = Name of the property (key string)
config.X.title = Title of the property
config.X.description = description of the property
config.X.required = true/false, if the property is required.
config.X.default = default string of the property
config.X.values = comma-separated values list for Select or FreeSelect properties
config.X.scope = scope of the property, from PropertyScope
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TITLE_PROP
public static final java.lang.String TITLE_PROP
- See Also:
- Constant Field Values
DESCRIPTION_PROP
public static final java.lang.String DESCRIPTION_PROP
- See Also:
- Constant Field Values
CONFIG_PROP_PREFIX
public static final java.lang.String CONFIG_PROP_PREFIX
- See Also:
- Constant Field Values
CONFIG_TITLE
public static final java.lang.String CONFIG_TITLE
- See Also:
- Constant Field Values
CONFIG_DESCRIPTION
public static final java.lang.String CONFIG_DESCRIPTION
- See Also:
- Constant Field Values
CONFIG_NAME
public static final java.lang.String CONFIG_NAME
- See Also:
- Constant Field Values
CONFIG_TYPE
public static final java.lang.String CONFIG_TYPE
- See Also:
- Constant Field Values
CONFIG_REQUIRED
public static final java.lang.String CONFIG_REQUIRED
- See Also:
- Constant Field Values
CONFIG_DEFAULT
public static final java.lang.String CONFIG_DEFAULT
- See Also:
- Constant Field Values
CONFIG_VALUES
public static final java.lang.String CONFIG_VALUES
- See Also:
- Constant Field Values
CONFIG_SCOPE
public static final java.lang.String CONFIG_SCOPE
- See Also:
- Constant Field Values
AbstractDescribableScriptPlugin
public AbstractDescribableScriptPlugin(ScriptPluginProvider provider,
Framework framework)
createPluginDataContext
public java.util.Map<java.lang.String,java.lang.String> createPluginDataContext()
- Return data with exported plugin details
createDescription
protected static void createDescription(ScriptPluginProvider provider,
boolean allowCustomProperties,
DescriptionBuilder builder)
throws ConfigurationException
- Throws:
ConfigurationException
getDescription
public Description getDescription()
- Description copied from interface:
Describable
- Return the configuration description
- Specified by:
getDescription
in interface Describable
isAllowCustomProperties
public abstract boolean isAllowCustomProperties()
- Subclasses return true if the script-plugin allows custom configuration properties defined in plugin metadata.
getProvider
public ScriptPluginProvider getProvider()
getFramework
public Framework getFramework()