Package com.inductiveautomation.ignition.gateway.user

Interface UserSourceManager

All Superinterfaces:

ExtensionPointManager<UserSourceExtensionPoint<?>>

public interface UserSourceManager
extends ExtensionPointManager<UserSourceExtensionPoint<?>>

Method Summary

Modifier and Type	Method	Description
ContactType	findContactType(String contactTypeKey)	Find the contact type matching the given key, or null if none matches.
Property<?>	findUserProperty(String keyName)	Look up a registered property by key name
GatewayContext	getGatewayContext()
UserSourceProfile	getProfile(String name)	Find the user source with this name.
Set<ContactType>	getRegisteredContactTypes()	Return all of the contact types registered with the system
Set<ConfigurationProperty<?>>	getRegisteredUserProperties()	Retrieve all of the properties registered for user objects.
NamedResourceHandler<ExtensionPointConfig<UserSourceProfileConfig,?>>	getUserProfileHandler()	Get the NamedResourceHandler that is configured for all user source profiles.
void	registerContactType(ContactType contactType)	Add a new contact type to the system
void	registerUserProperties(ConfigurationProperty<?>... properties)	Register new properties that will be available to add to User objects.
void	unregisterContactType(ContactType contactType)	Removes a contact type from the system
void	unregisterUserProperties(ConfigurationProperty<?>... properties)	Unregister custom user properties previously registered using registerUserProperties(ConfigurationProperty[])

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

getExtensionPointCollection, getExtensionPointResourceType

Method Details

getGatewayContext

GatewayContext getGatewayContext()

getProfile

UserSourceProfile getProfile(String name)

Find the user source with this name.

Throws:

IllegalArgumentException - if no such user source was found

registerUserProperties

void registerUserProperties(ConfigurationProperty<?>... properties)

Register new properties that will be available to add to User objects.

unregisterUserProperties

void unregisterUserProperties(ConfigurationProperty<?>... properties)

Unregister custom user properties previously registered using registerUserProperties(ConfigurationProperty[])

getRegisteredUserProperties

Set<ConfigurationProperty<?>> getRegisteredUserProperties()

Retrieve all of the properties registered for user objects.

findUserProperty

Property<?> findUserProperty(String keyName)

Look up a registered property by key name

registerContactType

void registerContactType(ContactType contactType)

Add a new contact type to the system

unregisterContactType

void unregisterContactType(ContactType contactType)

Removes a contact type from the system

Throws:

IllegalArgumentException - if the contact type does not exist or is one of the built-in types

findContactType

ContactType findContactType(String contactTypeKey)

Find the contact type matching the given key, or null if none matches.

getRegisteredContactTypes

Set<ContactType> getRegisteredContactTypes()

Return all of the contact types registered with the system

getUserProfileHandler

NamedResourceHandler<ExtensionPointConfig<UserSourceProfileConfig,?>> getUserProfileHandler()

Get the NamedResourceHandler that is configured for all user source profiles.

Returns:

The NamedResourceHandler for user source profiles.