com.morpheusdata.core

Interface PluginProvider

All Known Subinterfaces:

ApprovalProvider, BackupProvider, CloudProvider, CypherModuleProvider, DNSProvider, InstanceTabProvider, IPAMProvider, ProvisioningProvider, TaskProvider

All Known Implementing Classes:

AbstractInstanceTabProvider

public interface PluginProvider

All Providers implement the Plugin Extension. Different Plugins for Morpheus provide different integration endpoints. These could range from DNS, IPAM, and all the way up to Cloud Integrations. Each integration type extends this as a base interface for providing core methods.

Method Summary

Modifier and Type	Method and Description
MorpheusContext	getMorpheusContext() Returns the Morpheus Context for interacting with data stored in the Main Morpheus Application
Plugin	getPlugin() Returns the instance of the Plugin class that this provider is loaded from
java.lang.String	getProviderCode() A unique shortcode used for referencing the provided provider.
java.lang.String	getProviderName() Provides the provider name for reference when adding to the Morpheus Orchestrator NOTE: This may be useful to set as an i18n key for UI reference and localization support.
default boolean	isPlugin() Returns true if the Provider is a plugin.

Method Detail

getMorpheusContext

MorpheusContext getMorpheusContext()

Returns the Morpheus Context for interacting with data stored in the Main Morpheus Application

Returns:

an implementation of the MorpheusContext for running Future based rxJava queries

getPlugin

Plugin getPlugin()

Returns the instance of the Plugin class that this provider is loaded from

Returns:

Plugin class contains references to other providers

getProviderCode

java.lang.String getProviderCode()

A unique shortcode used for referencing the provided provider. Make sure this is going to be unique as any data that is seeded or generated related to this provider will reference it by this code.

Returns:

short code string that should be unique across all other plugin implementations.

getProviderName

java.lang.String getProviderName()

Provides the provider name for reference when adding to the Morpheus Orchestrator NOTE: This may be useful to set as an i18n key for UI reference and localization support.

Returns:

either an English name of a Provider or an i18n based key that can be scanned for in a properties file.

isPlugin

default boolean isPlugin()

Returns true if the Provider is a plugin. Always true for plugin but null or false for Morpheus internal providers.

Returns:

provider is plugin