Package com.aquima.interactions.process

Class AutomaticUser

java.lang.Object
com.aquima.interactions.process.AutomaticUser
All Implemented Interfaces:
IUserData, Serializable
public class AutomaticUser extends Object implements IUserData
This class defines the automatic user.
Since:
7.1
Author:
J. van Leuven
See Also:

  • Constructor Details

    • AutomaticUser

      public AutomaticUser()

    • AutomaticUser

      public AutomaticUser(String tenant)

    • AutomaticUser

      public AutomaticUser(IUserData other)

  • Method Details

    • getRoles

      public String[] getRoles()
      Description copied from interface: IUserData
      This method returns an array containing the names of the roles of the user.
      Specified by:
      getRoles in interface IUserData
      Returns:
      An array containing the names of the roles of the user, can be empty array, but may not be null.

    • getTeams

      public String[] getTeams()
      Description copied from interface: IUserData
      This method returns an array containing the names of the teams of the user.
      Specified by:
      getTeams in interface IUserData
      Returns:
      An array containing the names of the teams of the user, can be empty array, but may not be null.

    • getTenant

      public String getTenant()
      Description copied from interface: IUserData
      This method returns the name of the tenant.
      Specified by:
      getTenant in interface IUserData
      Returns:
      the name of the tenant.

    • addCustomProperty

      public void addCustomProperty(String key, String value)
      Description copied from interface: IUserData
      This method puts a key with its value in the custom properties map If the key-value combination already exists an exception will be thrown
      Specified by:
      addCustomProperty in interface IUserData
      Parameters:
      key - The name of the custom property
      value - The value of the custom property

    • getCustomProperty

      public String getCustomProperty(String name)
      Description copied from interface: IUserData
      This methods returns the value of a key, if available, otherwise returns null
      Specified by:
      getCustomProperty in interface IUserData
      Parameters:
      name - The name of the custom property
      Returns:
      the value of a key

    • hasCustomProperty

      public boolean hasCustomProperty(String name)
      Description copied from interface: IUserData
      This method returns true if the key is available
      Specified by:
      hasCustomProperty in interface IUserData
      Parameters:
      name - The name of the custom property
      Returns:
      true if present, otherwise false

    • getCustomPropertyNames

      public String[] getCustomPropertyNames()
      Description copied from interface: IUserData
      This method returns a string array containing custom properties names
      Specified by:
      getCustomPropertyNames in interface IUserData
      Returns:
      the map containing custom properties

    • setHeader

      public void setHeader(String name, List<String> values)
      Description copied from interface: IUserData
      Stores the values for a header
      Specified by:
      setHeader in interface IUserData
      Parameters:
      name - The name of the header
      values - The values for the header

    • getHeader

      public List<String> getHeader(String name)
      Description copied from interface: IUserData
      Returns the values of a header
      Specified by:
      getHeader in interface IUserData
      Parameters:
      name - The name of the header
      Returns:
      the values of the header

    • getHeaderNames

      public Set<String> getHeaderNames()
      Description copied from interface: IUserData
      Returns the names of all stored headers
      Specified by:
      getHeaderNames in interface IUserData
      Returns:
      list of header names

    • setAuthenticationClaim

      public void setAuthenticationClaim(String name, List<String> values)
      Description copied from interface: IUserData
      Stores the values for an authentication claim
      Specified by:
      setAuthenticationClaim in interface IUserData
      Parameters:
      name - The name of the authentication claim
      values - The values for the authentication claim

    • getAuthenticationClaim

      public List<String> getAuthenticationClaim(String name)
      Description copied from interface: IUserData
      Returns the values of an authentication claim
      Specified by:
      getAuthenticationClaim in interface IUserData
      Parameters:
      name - The name of the authentication claim
      Returns:
      the values of the authentication claim

    • getAuthenticationClaimNames

      public Set<String> getAuthenticationClaimNames()
      Description copied from interface: IUserData
      Returns the names of all stored authentication claims
      Specified by:
      getAuthenticationClaimNames in interface IUserData
      Returns:
      set of authentication claim names

    • getUserId

      public String getUserId()
      Description copied from interface: IUserData
      This method returns an ID that uniquely identifies the user. This ID will for instance be used when locking a case to indicate which user performed the lock.
      Specified by:
      getUserId in interface IUserData
      Returns:
      The unique ID of the user, may not be null.

    • getUserName

      public String getUserName()
      Description copied from interface: IUserData
      This method returns the name of the user this object represents. The name of the user is mainly used for display purposes. Use the user-ID to uniquely identify the user.
      Specified by:
      getUserName in interface IUserData
      Returns:
      the name of the user this object represents.

    • isAnonymous

      public boolean isAnonymous()
      Specified by:
      isAnonymous in interface IUserData
      Returns:
      true if this user represents the anonymous user

    • isAutomatic

      public boolean isAutomatic()
      Specified by:
      isAutomatic in interface IUserData
      Returns:
      true if this user represents the automatic user (Runtime Service Account)