Package com.inductiveautomation.ignition.gateway.user

Interface UserSourceManager

All Superinterfaces:
ExtensionPointManager
public interface UserSourceManager extends ExtensionPointManager

  • Method Details

    • getGatewayContext

      GatewayContext getGatewayContext()

    • getProfile

      UserSourceProfile getProfile(long id)

    • getProfile

      UserSourceProfile getProfile(String name)
      Find the user source with this name.
      Throws:
      IllegalArgumentException - if no such user source was found

    • addUserSourceProfileType

      void addUserSourceProfileType(UserSourceProfileType type) throws Exception
      Adds a new type of user source into the system. Also ensures that the persistent settings record indicated by the type is known to the schema system.
      Throws:
      Exception - if automatic schema updating fails.

    • removeUserSourceProfileType

      void removeUserSourceProfileType(String typeId)
      Remove a UserSourceProfileType with the given type ID.
      Parameters:
      typeId - The typeId associated with the UserSourceProfileType to remove.
      Throws:
      IllegalArgumentException - if the typeId to remove is associated with a built-in UserSourceProfileType or a type which does not exist

    • 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

    • notifyUserAltered

      Future<?> notifyUserAltered(long profileId)
      Notify the manager that a user or group in this profile has been changed. The manager maintains a cache of the users in a profile because the act of fetching users/groups for many profiles is very expensive (slow).

    • getAllRoles

      Set<String> getAllRoles()
      Returns all roles across the various user profiles. Will return an empty set if no roles are defined.