Package com.inductiveautomation.ignition.gateway.authentication.resources

Class DBAuthPropertiesResource.AuthType

java.lang.Object

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

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

com.inductiveautomation.ignition.gateway.authentication.resources.DBAuthPropertiesResource.AuthType

All Implemented Interfaces:

ExtensionPoint<DBAuthPropertiesResource>, Comparable<ExtensionPoint<DBAuthPropertiesResource>>

Enclosing class:

DBAuthPropertiesResource

public static class DBAuthPropertiesResource.AuthType
extends UserSourceExtensionPoint<DBAuthPropertiesResource>

Nested Class Summary

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

ExtensionPoint.ComponentType

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.user.UserSourceExtensionPoint

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

Constructor	Description
AuthType()

Method Summary

Modifier and Type	Method	Description
UserSourceProfile	createNewProfile(GatewayContext context, DecodedResource<ExtensionPointConfig<UserSourceProfileConfig,?>> resource)	Create a new AuthenticationProfile given the persistent record(s) that defines its properties
Optional<WebUiComponent>	getWebUiComponent(ExtensionPoint.ComponentType type)
protected void	validate(DBAuthPropertiesResource settings, ValidationErrors.Builder errors)	Provides an opportunity to validate the extension point type's settings config object.

Methods inherited from class com.inductiveautomation.ignition.gateway.user.UserSourceExtensionPoint

createKernel, resourceType, settingsType

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

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

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, settingsSchema

Constructor Details

AuthType

public AuthType()

Method Details

createNewProfile

public UserSourceProfile createNewProfile(GatewayContext context,
 DecodedResource<ExtensionPointConfig<UserSourceProfileConfig,?>> resource)

Description copied from class: UserSourceExtensionPoint

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

Specified by:

createNewProfile in class UserSourceExtensionPoint<DBAuthPropertiesResource>

Parameters:

context - The GatewayContext for the Gateway.

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

getWebUiComponent

public Optional<WebUiComponent> getWebUiComponent(ExtensionPoint.ComponentType type)

Returns:

the React component to use for adding or editing settings for this extension point.

validate

protected void validate(DBAuthPropertiesResource settings,
 ValidationErrors.Builder errors)

Description copied from class: AbstractExtensionPoint

Provides an opportunity to validate the extension point type's settings config object. If any errors are added to the ValidationErrors.Builder, the settings object will be considered invalid and will be rejected.

Overrides:

validate in class AbstractExtensionPoint<DBAuthPropertiesResource>