Package com.inductiveautomation.ignition.gateway.user

Class UserSourceExtensionPoint<S>

java.lang.Object

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

com.inductiveautomation.ignition.gateway.user.UserSourceExtensionPoint<S>

Type Parameters:

S - the type of settings used by the user source profile provided by this extension point.

All Implemented Interfaces:

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

Direct Known Subclasses:

ADAuthPropertiesResource.AuthType, ADHybridPropertiesResource.AuthType, ADtoDBHybridAuthPropertiesResource.AuthType, DBAuthPropertiesResource.AuthType, InternalAuthenticationType

public abstract class UserSourceExtensionPoint<S>
extends AbstractExtensionPoint<S>

Base class for ExtensionPoints that provide a UserSourceProfile implementation.

Nested Class Summary

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

ExtensionPoint.ComponentType

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceType	RESOURCE_TYPE

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	UserSourceExtensionPoint(String typeId, Class<S> settingsType)	Create a new UserSourceExtensionPoint for the specified type.
protected	UserSourceExtensionPoint(String typeId, String name, String description, Class<S> settingsType)	Create a new UserSourceExtensionPoint for the specified type using the specified name and description bundle keys.

Method Summary

Modifier and Type	Method	Description
protected UserSourceProfileKernel	createKernel(String profileName, UserSourceProfileConfig profile, GatewayContext context)	Create a new UserSourceProfileKernel for the specified profile.
abstract UserSourceProfile	createNewProfile(GatewayContext context, DecodedResource<ExtensionPointConfig<UserSourceProfileConfig,?>> profileResource)	Create a new AuthenticationProfile given the persistent record(s) that defines its properties
ResourceType	resourceType()	The resource type shared by all types of this extension point.
Optional<Class<S>>	settingsType()

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

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, defaultSettings, getMenuActions, getSettings, getWebUiComponent, settingsSchema

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

Constructor Details

UserSourceExtensionPoint

protected UserSourceExtensionPoint(String typeId,
 Class<S> settingsType)

Create a new UserSourceExtensionPoint for the specified type. This is a convenience constructor that assumes the bundle keys are of the form: AuthenticatorTypes.TYPEID.[Display|Description]

Parameters:

typeId - The type ID for the profile type.

UserSourceExtensionPoint

protected UserSourceExtensionPoint(String typeId,
 String name,
 String description,
 Class<S> settingsType)

Create a new UserSourceExtensionPoint for the specified type using the specified name and description bundle keys.

Parameters:

typeId - They type ID for the profile type.

name - The bundle key for the display name of the profile type.

description - The bundle key for the description of the profile type.

Method Details

createNewProfile

public abstract UserSourceProfile createNewProfile(GatewayContext context,
 DecodedResource<ExtensionPointConfig<UserSourceProfileConfig,?>> profileResource)
                                            throws Exception

Create a new AuthenticationProfile given the persistent record(s) that defines its properties

Parameters:

context - The GatewayContext for the Gateway.

profileResource - The record that defines this authentication profile. Profile types should be able to use this resource to look up their profile-specific settings.

Throws:

Exception - If there is an error creating the profile.

createKernel

protected UserSourceProfileKernel createKernel(String profileName,
 UserSourceProfileConfig profile,
 GatewayContext context)

Create a new UserSourceProfileKernel for the specified profile.

Parameters:

profileName - The name of the profile.

profile - The profile configuration.

context - The GatewayContext for the Gateway.

Returns:

The new UserSourceProfileKernel.

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.

settingsType

public Optional<Class<S>> settingsType()

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.