Package com.dtolabs.rundeck.core.plugins
Interface PluginMetadata
-
- All Known Implementing Classes:
JarPluginProviderLoader
,ScriptPluginProviderLoader
public interface PluginMetadata
Provides metadata about plugin files
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Date
getDateLoaded()
java.io.File
getFile()
java.lang.String
getFilename()
java.lang.String
getPluginArtifactName()
java.lang.String
getPluginAuthor()
java.util.Date
getPluginDate()
java.lang.String
getPluginDescription()
java.lang.String
getPluginDocsLink()
java.lang.String
getPluginFileVersion()
java.lang.String
getPluginId()
This id is generated off of the plugin name.java.lang.String
getPluginLicense()
java.lang.String
getPluginName()
java.lang.String
getPluginSourceLink()
java.lang.String
getPluginThirdPartyDependencies()
java.lang.String
getPluginType()
java.lang.String
getPluginUrl()
java.lang.String
getPluginVersion()
java.lang.String
getRundeckCompatibilityVersion()
java.util.List<java.lang.String>
getTags()
java.lang.String
getTargetHostCompatibility()
-
-
-
Method Detail
-
getFilename
java.lang.String getFilename()
- Returns:
- Name of file on disk
-
getFile
java.io.File getFile()
- Returns:
- Source file on disk
-
getPluginArtifactName
java.lang.String getPluginArtifactName()
- Returns:
- The name in plugin.yaml or the Rundeck-Plugin-Name attribute in the jar manifest
-
getPluginAuthor
java.lang.String getPluginAuthor()
- Returns:
- author metadata
-
getPluginFileVersion
java.lang.String getPluginFileVersion()
- Returns:
- plugin file version
-
getPluginVersion
java.lang.String getPluginVersion()
- Returns:
- rundeck plugin format version
-
getPluginUrl
java.lang.String getPluginUrl()
- Returns:
- plugin URL
-
getPluginDate
java.util.Date getPluginDate()
- Returns:
- build date of plugin
-
getDateLoaded
java.util.Date getDateLoaded()
- Returns:
- date loaded
-
getPluginName
java.lang.String getPluginName()
- Returns:
- plugin name
-
getPluginDescription
java.lang.String getPluginDescription()
- Returns:
- plugin description
-
getPluginId
java.lang.String getPluginId()
This id is generated off of the plugin name. It is the first 12 characters of the sha256 of the plugin name. This is set automatically by the system. No need to add it manually.- Returns:
- plugin id
-
getRundeckCompatibilityVersion
java.lang.String getRundeckCompatibilityVersion()
- Returns:
- version of Rundeck with which this plugin is compatible
-
getTargetHostCompatibility
java.lang.String getTargetHostCompatibility()
- Returns:
- os family with which this plugin is compatible
-
getTags
java.util.List<java.lang.String> getTags()
- Returns:
- tags
-
getPluginLicense
java.lang.String getPluginLicense()
- Returns:
- plugin license
-
getPluginThirdPartyDependencies
java.lang.String getPluginThirdPartyDependencies()
- Returns:
- plugin third party dependencies
-
getPluginSourceLink
java.lang.String getPluginSourceLink()
- Returns:
- link to plugin source
-
getPluginDocsLink
java.lang.String getPluginDocsLink()
- Returns:
- link to plugin docs
-
getPluginType
java.lang.String getPluginType()
- Returns:
- plugin type
-
-