Plugin (morpheus-plugin-api API)

java.lang.Object
- com.morpheusdata.core.Plugin

All Implemented Interfaces:

PluginInterface
```
public abstract class Plugin
extends java.lang.Object
implements PluginInterface
```
This is the base class for all Plugins that are instantiated within the Morpheus Environment. It contains both metadata related to the plugin itself as well as any providers that may need to be instanced for use within Morpheus.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`author`
`protected java.util.List<PluginController>`	`controllers`
`protected java.lang.String`	`description`
`protected java.lang.String`	`fileName`
`protected java.lang.String`	`issueTrackerUrl`
`protected MorpheusContext`	`morpheusContext`
`protected java.lang.String`	`name`
`protected java.util.List<Permission>`	`permissions`
`protected java.util.Map<java.lang.String,PluginProvider>`	`pluginProviders`
`protected Renderer<?>`	`renderer`
`protected java.lang.String`	`sourceCodeLocationUrl`
`protected java.lang.String`	`version`
`protected java.lang.String`	`websiteUrl`

Constructor Summary

Constructors
Constructor and Description

Plugin()

Constructors
Constructor and Description
`Plugin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthor()`
`java.lang.ClassLoader`	`getClassLoader()`
`java.util.List<PluginController>`	`getControllers()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getFileName()`
`java.lang.String`	`getIssueTrackerUrl()`
`java.lang.String`	`getName()`
`java.util.List<Permission>`	`getPermissions()`
`PluginManager`	`getPluginManager()` All plugins reside in a Plugin Manager responsible for loading all plugins.
`PluginProvider`	`getProviderByCode(java.lang.String code)` Grabs an instance of a plugin provider loaded by a unique code as defined by the implementation of the provider
`java.util.Collection<PluginProvider>`	`getProviders()` Provides a collection of all `PluginProvider` classes that this plugin provides in Singleton Form.
`java.util.Collection<PluginProvider>`	`getProvidersByType(java.lang.Class clazz)` Returns a Collection of all Providers provided by this Plugin based on Type class.
`protected Renderer<?>`	`getRenderer()` Get the template renderer for ths plugin.
`java.lang.String`	`getSourceCodeLocationUrl()`
`java.lang.String`	`getVersion()`
`java.lang.String`	`getWebsiteUrl()`
`boolean`	`hasCustomRender()`
`void`	`setAuthor(java.lang.String author)`
`void`	`setClassLoader(java.lang.ClassLoader classLoader)`
`void`	`setControllers(java.util.List<PluginController> controllers)`
`void`	`setDescription(java.lang.String description)`
`void`	`setFileName(java.lang.String fileName)`
`void`	`setIssueTrackerUrl(java.lang.String issueTrackerUrl)`
`void`	`setName(java.lang.String name)`
`void`	`setPermissions(java.util.List<Permission> permissions)`
`void`	`setRenderer(Renderer<?> renderer)` Set the template renderer for ths plugin.
`void`	`setSourceCodeLocationUrl(java.lang.String sourceCodeLocationUrl)`
`void`	`setVersion(java.lang.String version)`
`void`	`setWebsiteUrl(java.lang.String websiteUrl)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.morpheusdata.core.PluginInterface
initialize, onDestroy

- Field Detail
  - pluginProviders
```
protected java.util.Map<java.lang.String,PluginProvider> pluginProviders
```
  - morpheusContext
```
protected MorpheusContext morpheusContext
```
  - renderer
```
protected Renderer<?> renderer
```
  - controllers
```
protected java.util.List<PluginController> controllers
```
  - permissions
```
protected java.util.List<Permission> permissions
```
  - name
```
protected java.lang.String name
```
  - fileName
```
protected java.lang.String fileName
```
  - version
```
protected java.lang.String version
```
  - author
```
protected java.lang.String author
```
  - description
```
protected java.lang.String description
```
  - websiteUrl
```
protected java.lang.String websiteUrl
```
  - sourceCodeLocationUrl
```
protected java.lang.String sourceCodeLocationUrl
```
  - issueTrackerUrl
```
protected java.lang.String issueTrackerUrl
```
- Constructor Detail
  - Plugin
```
public Plugin()
```
- Method Detail
  - setControllers
```
public void setControllers(java.util.List<PluginController> controllers)
```
  - getControllers
```
public java.util.List<PluginController> getControllers()
```
  - setRenderer
```
public void setRenderer(Renderer<?> renderer)
```
    Set the template renderer for ths plugin.
    
    Parameters:
    
    renderer - sets the renderer for the plugin
  - hasCustomRender
```
public boolean hasCustomRender()
```
  - getRenderer
```
protected Renderer<?> getRenderer()
```
    Get the template renderer for ths plugin.
    
    Returns:
    
    the renderer for the plugin
  - getPluginManager
```
public PluginManager getPluginManager()
```
    All plugins reside in a Plugin Manager responsible for loading all plugins. This allows the PluginManager to be accessed from its children in the event another plugin needs to be referenced.
    
    Returns:
    
    The Singleton instance of a PluginManager for the Morpheus App.
  - getProviders
```
public java.util.Collection<PluginProvider> getProviders()
```
    Provides a collection of all PluginProvider classes that this plugin provides in Singleton Form. These Providers can range in type from DNS,IPAM or even Cloud Integrations.
    
    Returns:
    
    a Collection of cloud providers that have been loaded by this plugin.
  - getProviderByCode
```
public PluginProvider getProviderByCode(java.lang.String code)
```
    Grabs an instance of a plugin provider loaded by a unique code as defined by the implementation of the provider
    
    Parameters:
    
    code - The unique code given to the @{link PluginProvider} implementation.
    
    Returns:
    
    A single Plugin Provider matched by code. If the Plugin Provider is not found a null result will be returned.
  - getProvidersByType
```
public java.util.Collection<PluginProvider> getProvidersByType(java.lang.Class clazz)
```
    Returns a Collection of all Providers provided by this Plugin based on Type class. For example, if one wanted to grab all cloud provider classes, this method would be the most efficient way to do that.
    
    Parameters:
    
    clazz - The interface class that all PluginProvider classes implement.
    
    Returns:
    
    A collection of matched providers by type. If no results are found an empty ArrayList is returned.
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface PluginInterface
  - setName
```
public void setName(java.lang.String name)
```
    Specified by:
    
    setName in interface PluginInterface
  - getFileName
```
public java.lang.String getFileName()
```
    Specified by:
    
    getFileName in interface PluginInterface
  - setFileName
```
public void setFileName(java.lang.String fileName)
```
    Specified by:
    
    setFileName in interface PluginInterface
  - getVersion
```
public java.lang.String getVersion()
```
    Specified by:
    
    getVersion in interface PluginInterface
  - setVersion
```
public void setVersion(java.lang.String version)
```
    Specified by:
    
    setVersion in interface PluginInterface
  - getDescription
```
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface PluginInterface
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Specified by:
    
    setDescription in interface PluginInterface
  - getAuthor
```
public java.lang.String getAuthor()
```
    Specified by:
    
    getAuthor in interface PluginInterface
  - setAuthor
```
public void setAuthor(java.lang.String author)
```
    Specified by:
    
    setAuthor in interface PluginInterface
  - getWebsiteUrl
```
public java.lang.String getWebsiteUrl()
```
    Specified by:
    
    getWebsiteUrl in interface PluginInterface
  - setWebsiteUrl
```
public void setWebsiteUrl(java.lang.String websiteUrl)
```
    Specified by:
    
    setWebsiteUrl in interface PluginInterface
  - getSourceCodeLocationUrl
```
public java.lang.String getSourceCodeLocationUrl()
```
    Specified by:
    
    getSourceCodeLocationUrl in interface PluginInterface
  - setSourceCodeLocationUrl
```
public void setSourceCodeLocationUrl(java.lang.String sourceCodeLocationUrl)
```
    Specified by:
    
    setSourceCodeLocationUrl in interface PluginInterface
  - getIssueTrackerUrl
```
public java.lang.String getIssueTrackerUrl()
```
    Specified by:
    
    getIssueTrackerUrl in interface PluginInterface
  - setIssueTrackerUrl
```
public void setIssueTrackerUrl(java.lang.String issueTrackerUrl)
```
    Specified by:
    
    setIssueTrackerUrl in interface PluginInterface
  - setClassLoader
```
public void setClassLoader(java.lang.ClassLoader classLoader)
```
  - getClassLoader
```
public java.lang.ClassLoader getClassLoader()
```
  - getPermissions
```
public java.util.List<Permission> getPermissions()
```
  - setPermissions
```
public void setPermissions(java.util.List<Permission> permissions)
```

Class Plugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.morpheusdata.core.PluginInterface

Field Detail

pluginProviders

morpheusContext

renderer

controllers

permissions

name

fileName

version

author

description

websiteUrl

sourceCodeLocationUrl

issueTrackerUrl

Constructor Detail

Plugin

Method Detail

setControllers

getControllers

setRenderer

hasCustomRender

getRenderer

getPluginManager

getProviders

getProviderByCode

getProvidersByType

getName

setName

getFileName

setFileName

getVersion

setVersion

getDescription

setDescription

getAuthor

setAuthor

getWebsiteUrl

setWebsiteUrl

getSourceCodeLocationUrl

setSourceCodeLocationUrl

getIssueTrackerUrl

setIssueTrackerUrl

setClassLoader

getClassLoader

getPermissions

setPermissions