public class ScriptPluginProviderLoader extends java.lang.Object implements ProviderLoader, FileCache.Expireable, PluginResourceLoader, PluginMetadata
ScriptPluginProviderLoadable
Modifier and Type | Field and Description |
---|---|
static java.util.List<java.lang.String> |
SUPPORTED_PLUGIN_VERSIONS |
static VersionCompare |
SUPPORTS_RESOURCES_PLUGIN_VERSION |
static java.lang.String |
VERSION_1_0 |
static java.lang.String |
VERSION_1_1 |
static java.lang.String |
VERSION_1_2 |
static java.lang.String |
VERSION_2_0 |
Constructor and Description |
---|
ScriptPluginProviderLoader(java.io.File file,
java.io.File cachedir) |
Modifier and Type | Method and Description |
---|---|
boolean |
canLoadForService(FrameworkSupportService service) |
boolean |
equals(java.lang.Object o) |
void |
expire()
Expire the loader cache item
|
java.util.Date |
getDateLoaded() |
static boolean |
getDefaultMergeEnvVars(PluginMeta pluginMeta)
Return default value for "mergeEnvironment" based on plugin type version
|
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.util.List<java.lang.String> |
getPluginResourcesList() |
java.lang.String |
getPluginSourceLink() |
java.lang.String |
getPluginThirdPartyDependencies() |
java.lang.String |
getPluginType() |
java.lang.String |
getPluginUrl() |
java.lang.String |
getPluginVersion() |
java.lang.String |
getResourcesBasePath() |
static java.lang.String |
getResourcesBasePath(PluginMeta metadata) |
java.lang.String |
getRundeckCompatibilityVersion() |
java.util.List<java.lang.String> |
getTags() |
java.lang.String |
getTargetHostCompatibility() |
int |
hashCode() |
boolean |
isLoaderFor(ProviderIdent ident)
Return true if the plugin file can loade a provider for the ident
|
java.util.List<ProviderIdent> |
listProviders()
List providers available
|
java.util.List<java.lang.String> |
listResources() |
<T> T |
load(PluggableService<T> service,
java.lang.String providerName)
Load a provider instance for the service by name
|
<T> CloseableProvider<T> |
loadCloseable(PluggableService<T> service,
java.lang.String providerName)
Return a closeable provider instance
|
java.io.InputStream |
openResourceStreamFor(java.lang.String name)
Open a stream to load a resource
|
static boolean |
supportsResources(PluginMeta pluginMeta)
Return true if the plugin version supports resources
|
public static final java.lang.String VERSION_1_0
public static final java.lang.String VERSION_1_1
public static final java.lang.String VERSION_1_2
public static final VersionCompare SUPPORTS_RESOURCES_PLUGIN_VERSION
public static final java.lang.String VERSION_2_0
public static final java.util.List<java.lang.String> SUPPORTED_PLUGIN_VERSIONS
public ScriptPluginProviderLoader(java.io.File file, java.io.File cachedir)
public boolean canLoadForService(FrameworkSupportService service)
canLoadForService
in interface ProviderLoader
service
- servicepublic java.util.List<java.lang.String> listResources() throws PluginException, java.io.IOException
listResources
in interface PluginResourceLoader
PluginException
java.io.IOException
public java.io.InputStream openResourceStreamFor(java.lang.String name) throws PluginException, java.io.IOException
PluginResourceLoader
openResourceStreamFor
in interface PluginResourceLoader
name
- resource path and namePluginException
- if a path is requested that was not in the pluginjava.io.IOException
- if an error occurspublic <T> T load(PluggableService<T> service, java.lang.String providerName) throws ProviderLoaderException
load
in interface ProviderLoader
ProviderLoaderException
public <T> CloseableProvider<T> loadCloseable(PluggableService<T> service, java.lang.String providerName) throws ProviderLoaderException
ProviderLoader
loadCloseable
in interface ProviderLoader
T
- typeservice
- serviceproviderName
- provider nameProviderLoaderException
public boolean isLoaderFor(ProviderIdent ident)
isLoaderFor
in interface ProviderLoader
public java.util.List<ProviderIdent> listProviders()
ProviderLoader
listProviders
in interface ProviderLoader
public void expire()
expire
in interface FileCache.Expireable
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static boolean getDefaultMergeEnvVars(PluginMeta pluginMeta)
pluginMeta
- public static boolean supportsResources(PluginMeta pluginMeta)
pluginMeta
- public java.util.List<java.lang.String> getPluginResourcesList() throws java.io.IOException
java.io.IOException
public java.lang.String getResourcesBasePath() throws java.io.IOException
java.io.IOException
public static java.lang.String getResourcesBasePath(PluginMeta metadata) throws java.io.IOException
java.io.IOException
public java.lang.String getFilename()
getFilename
in interface PluginMetadata
public java.io.File getFile()
getFile
in interface PluginMetadata
public java.lang.String getPluginArtifactName()
getPluginArtifactName
in interface PluginMetadata
public java.lang.String getPluginAuthor()
getPluginAuthor
in interface PluginMetadata
public java.lang.String getPluginFileVersion()
getPluginFileVersion
in interface PluginMetadata
public java.lang.String getPluginVersion()
getPluginVersion
in interface PluginMetadata
public java.lang.String getPluginUrl()
getPluginUrl
in interface PluginMetadata
public java.util.Date getPluginDate()
getPluginDate
in interface PluginMetadata
public java.util.Date getDateLoaded()
getDateLoaded
in interface PluginMetadata
public java.lang.String getPluginName()
getPluginName
in interface PluginMetadata
public java.lang.String getPluginDescription()
getPluginDescription
in interface PluginMetadata
public java.lang.String getPluginId()
PluginMetadata
getPluginId
in interface PluginMetadata
public java.lang.String getRundeckCompatibilityVersion()
getRundeckCompatibilityVersion
in interface PluginMetadata
public java.lang.String getTargetHostCompatibility()
getTargetHostCompatibility
in interface PluginMetadata
public java.util.List<java.lang.String> getTags()
getTags
in interface PluginMetadata
public java.lang.String getPluginLicense()
getPluginLicense
in interface PluginMetadata
public java.lang.String getPluginThirdPartyDependencies()
getPluginThirdPartyDependencies
in interface PluginMetadata
public java.lang.String getPluginSourceLink()
getPluginSourceLink
in interface PluginMetadata
public java.lang.String getPluginDocsLink()
getPluginDocsLink
in interface PluginMetadata
public java.lang.String getPluginType()
getPluginType
in interface PluginMetadata