Package com.inductiveautomation.ignition.gateway.mail.smtp

Class AbstractEmailProfileExtensionPoint<SettingsT>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint<SettingsT>

com.inductiveautomation.ignition.gateway.mail.smtp.AbstractEmailProfileExtensionPoint<SettingsT>

All Implemented Interfaces:

ExtensionPoint<SettingsT>, EmailProfileType<SettingsT>, Comparable<ExtensionPoint<SettingsT>>

public abstract class AbstractEmailProfileExtensionPoint<SettingsT>
extends AbstractExtensionPoint<SettingsT>
implements EmailProfileType<SettingsT>

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.mail.EmailProfileType

EmailProfileType.FactoryContext

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

ExtensionPoint.ComponentType

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

descriptionKey, gson, nameKey, typeId, validator

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

PROFILE_KEY, SETTINGS_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEmailProfileExtensionPoint(String typeId, String nameKey, String descriptionKey, @Nullable Class<SettingsT> settingsType)

Method Summary

Modifier and Type	Method	Description
EmailProfile.Lifecycle	createNewProfile(EmailProfileType.FactoryContext context)	Factory method for creating new EmailProfile instances of this type.
protected abstract EmailProfile.Lifecycle	createNewProfile(EmailProfileType.FactoryContext context, SettingsT settings)
ResourceType	resourceType()	The resource type shared by all types of this extension point.
Optional<Class<SettingsT>>	settingsType()

Methods inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

addReferenceProperty, addReferenceProperty, buildGson, buildValidator, customizeGson, decode, description, encode, getReferenceProperties, getSettingsValidator, name, typeId, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Details

AbstractEmailProfileExtensionPoint

protected AbstractEmailProfileExtensionPoint(String typeId,
 String nameKey,
 String descriptionKey,
 @Nullable
 @Nullable Class<SettingsT> settingsType)

Method Details

resourceType

public 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<SettingsT>

settingsType

public Optional<Class<SettingsT>> settingsType()

Specified by:

settingsType in interface ExtensionPoint<SettingsT>

Returns:

the Class of the settings object for this ExtensionPoint, if it has one. If this ExtensionPoint does not have settings, return Optional.empty(). By default, this method returns the class of the object returned from ExtensionPoint.defaultSettings(), if one is provided.

createNewProfile

public EmailProfile.Lifecycle createNewProfile(EmailProfileType.FactoryContext context)
                                        throws Exception

Description copied from interface: EmailProfileType

Factory method for creating new EmailProfile instances of this type.

Specified by:

createNewProfile in interface EmailProfileType<SettingsT>

Parameters:

context - a EmailProfileType.FactoryContext instance which exposes the contextual information necessary for any email profile type to be instantiated

Returns:

a new EmailProfile.Lifecycle instance that has not yet been started

Throws:

Exception - if there was an unexpected problem creating a new email profile instance of this type

createNewProfile

protected abstract EmailProfile.Lifecycle createNewProfile(EmailProfileType.FactoryContext context,
 SettingsT settings)
                                                    throws Exception

Throws:

Exception