Package com.inductiveautomation.ignition.gateway.secrets

Interface SecretProviderType<S>

All Superinterfaces:

Comparable<ExtensionPoint<S>>, ExtensionPoint<S>

public interface SecretProviderType<S>
extends ExtensionPoint<S>

An ExtensionPoint for defining new types of SecretProviders

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

ExtensionPoint.ComponentType

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

PROFILE_KEY, SETTINGS_KEY

Method Summary

Modifier and Type	Method	Description
SecretProvider	createProvider(SecretProviderContext context)	Factory method for creating new instances of SecretProviders of this type
default ResourceType	resourceType()	The resource type shared by all types of this extension point.

Methods inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

canCreate, compareTo, decode, defaultSettings, description, encode, getMenuActions, getReferenceProperties, getSettings, getSettingsValidator, getWebUiComponent, name, settingsSchema, settingsType, typeId

Method Details

resourceType

default ResourceType resourceType()

Description copied from interface: ExtensionPoint

The resource type shared by all types of this extension point. This is used to group extension points together. For example, all alarm journal types would share the same resource type, but have different typeIds.

Specified by:

resourceType in interface ExtensionPoint<S>

createProvider

SecretProvider createProvider(SecretProviderContext context)
                       throws SecretProviderTypeException

Factory method for creating new instances of SecretProviders of this type

Parameters:

context - the SecretProviderContext encapsulating the contextual information needed for creating new SecretProvider instances of this type. never null.

Returns:

a new instance of SecretProvider. if the returned SecretProvider is also an instance of Lifecycle, the SecretProviderManager will drive the lifecycle of this SecretProvider but will only expose the SecretProvider methods to the public. never null.

Throws:

SecretProviderTypeException - if there is a problem creating a new provider of this type