Package com.inductiveautomation.ignition.gateway.user

Class UserSourceProfileType

java.lang.Object

com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

com.inductiveautomation.ignition.gateway.user.UserSourceProfileType

All Implemented Interfaces:

ExtensionPointType, Serializable, Comparable<ExtensionPointType>

Direct Known Subclasses:

ADAuthProperties.AuthType, ADHybridProperties.AuthType, ADtoDBHybridAuthProperties.AuthType, DBAuthProperties.AuthType, InternalAuthenticationType

public abstract class UserSourceProfileType
extends BaseExtensionPointType

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

description, name, typeId

Constructor Summary

Constructors

Constructor	Description
UserSourceProfileType(String typeId)	Convenience contructor assumes that the bundle keys are of the form: AuthenticatorTypes.TYPEID.[Display|Description]
UserSourceProfileType(String typeId, String name, String description)

Method Summary

Modifier and Type	Method	Description
protected UserSourceProfileKernel	createKernel(UserSourceProfileRecord profile, GatewayContext context)
abstract UserSourceProfile	createNewProfile(UserSourceProfileRecord profile, GatewayContext context)	Create a new AuthenticationProfile given the persistent record(s) that defines its properties

Methods inherited from class com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

addRecordInstanceActions, compareTo, findProfileSettingsRecord, getDescription, getName, getSettingsRecordForeignKey, getTypeId, isEnabled, newRecordConfigPanel, onRecordDestroyed

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.model.ExtensionPointType

getSettingsRecordType

Constructor Details

UserSourceProfileType

public UserSourceProfileType(String typeId)

Convenience contructor assumes that the bundle keys are of the form: AuthenticatorTypes.TYPEID.[Display|Description]

UserSourceProfileType

public UserSourceProfileType(String typeId,
 String name,
 String description)

Method Details

createNewProfile

public abstract UserSourceProfile createNewProfile(UserSourceProfileRecord profile,
 GatewayContext context)
                                            throws Exception

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

Parameters:

profile - The record that defines this authentication profile. Profile types should be able to use this record to look up their profile-specific settings object via the PersistenceInterface

Throws:

Exception

createKernel

protected UserSourceProfileKernel createKernel(UserSourceProfileRecord profile,
 GatewayContext context)