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

Record Class ADAuthPropertiesResource

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.authentication.resources.ADAuthPropertiesResource
public record ADAuthPropertiesResource(String domain, String connectionUsername, SecretConfig connectionPassword, String host1, Integer port1, String host2, Integer port2, Boolean useSSL, Boolean ssoEnabled, String ssoDomain, String userPrefix, String userSuffix, Boolean automaticSuffix, Boolean usePrefixAndSuffixForGatewayUser, String userSearchBase, String userSearchFilter, String userListFilter, String userNameAttribute, LdapAttribute userIdAttribute, String userRoleAttribute, Boolean nestedGroups, String groupRoleAttribute, String roleNameAttribute, LdapAttribute roleIdAttribute, String fullNameAttribute, String phoneAttribute, String emailAttribute, String smsAttribute, String badgeAttribute, Long readTimeout, Integer pageSize, String roleSearchBase, String roleSearchFilter, String badgeSearchFilter, Boolean allowAnon, LDAPHelper.ProtocolType securityProtocol, LDAPHelper.AuthType authenticationType, String saslMechanism, String saslRealm, String saslQualityOfProtection, String saslProtectionStrength, Boolean saslMutualAuthentication, LDAPHelper.ReferralType referral, List<ExtraLdapAttribute> extraUserAttributes) extends Record
Configuration properties for an Active Directory user source.

  • Field Details

  • Constructor Details

    • ADAuthPropertiesResource

      public ADAuthPropertiesResource(String domain, String connectionUsername, SecretConfig connectionPassword, String host1, Integer port1, String host2, Integer port2, Boolean useSSL, Boolean ssoEnabled, String ssoDomain, String userPrefix, String userSuffix, Boolean automaticSuffix, Boolean usePrefixAndSuffixForGatewayUser, String userSearchBase, String userSearchFilter, String userListFilter, String userNameAttribute, LdapAttribute userIdAttribute, String userRoleAttribute, Boolean nestedGroups, String groupRoleAttribute, String roleNameAttribute, LdapAttribute roleIdAttribute, String fullNameAttribute, String phoneAttribute, String emailAttribute, String smsAttribute, String badgeAttribute, Long readTimeout, Integer pageSize, String roleSearchBase, String roleSearchFilter, String badgeSearchFilter, Boolean allowAnon, LDAPHelper.ProtocolType securityProtocol, LDAPHelper.AuthType authenticationType, String saslMechanism, String saslRealm, String saslQualityOfProtection, String saslProtectionStrength, Boolean saslMutualAuthentication, LDAPHelper.ReferralType referral, List<ExtraLdapAttribute> extraUserAttributes)
      Creates an instance of a ADAuthPropertiesResource record class.
      Parameters:
      domain - the value for the domain record component
      connectionUsername - the value for the connectionUsername record component
      connectionPassword - the value for the connectionPassword record component
      host1 - the value for the host1 record component
      port1 - the value for the port1 record component
      host2 - the value for the host2 record component
      port2 - the value for the port2 record component
      useSSL - the value for the useSSL record component
      ssoEnabled - the value for the ssoEnabled record component
      ssoDomain - the value for the ssoDomain record component
      userPrefix - the value for the userPrefix record component
      userSuffix - the value for the userSuffix record component
      automaticSuffix - the value for the automaticSuffix record component
      usePrefixAndSuffixForGatewayUser - the value for the usePrefixAndSuffixForGatewayUser record component
      userSearchBase - the value for the userSearchBase record component
      userSearchFilter - the value for the userSearchFilter record component
      userListFilter - the value for the userListFilter record component
      userNameAttribute - the value for the userNameAttribute record component
      userIdAttribute - the value for the userIdAttribute record component
      userRoleAttribute - the value for the userRoleAttribute record component
      nestedGroups - the value for the nestedGroups record component
      groupRoleAttribute - the value for the groupRoleAttribute record component
      roleNameAttribute - the value for the roleNameAttribute record component
      roleIdAttribute - the value for the roleIdAttribute record component
      fullNameAttribute - the value for the fullNameAttribute record component
      phoneAttribute - the value for the phoneAttribute record component
      emailAttribute - the value for the emailAttribute record component
      smsAttribute - the value for the smsAttribute record component
      badgeAttribute - the value for the badgeAttribute record component
      readTimeout - the value for the readTimeout record component
      pageSize - the value for the pageSize record component
      roleSearchBase - the value for the roleSearchBase record component
      roleSearchFilter - the value for the roleSearchFilter record component
      badgeSearchFilter - the value for the badgeSearchFilter record component
      allowAnon - the value for the allowAnon record component
      securityProtocol - the value for the securityProtocol record component
      authenticationType - the value for the authenticationType record component
      saslMechanism - the value for the saslMechanism record component
      saslRealm - the value for the saslRealm record component
      saslQualityOfProtection - the value for the saslQualityOfProtection record component
      saslProtectionStrength - the value for the saslProtectionStrength record component
      saslMutualAuthentication - the value for the saslMutualAuthentication record component
      referral - the value for the referral record component
      extraUserAttributes - the value for the extraUserAttributes record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • domain

      public String domain()
      Returns the value of the domain record component.
      Returns:
      the value of the domain record component

    • connectionUsername

      public String connectionUsername()
      Returns the value of the connectionUsername record component.
      Returns:
      the value of the connectionUsername record component

    • connectionPassword

      public SecretConfig connectionPassword()
      Returns the value of the connectionPassword record component.
      Returns:
      the value of the connectionPassword record component

    • host1

      public String host1()
      Returns the value of the host1 record component.
      Returns:
      the value of the host1 record component

    • port1

      public Integer port1()
      Returns the value of the port1 record component.
      Returns:
      the value of the port1 record component

    • host2

      public String host2()
      Returns the value of the host2 record component.
      Returns:
      the value of the host2 record component

    • port2

      public Integer port2()
      Returns the value of the port2 record component.
      Returns:
      the value of the port2 record component

    • useSSL

      public Boolean useSSL()
      Returns the value of the useSSL record component.
      Returns:
      the value of the useSSL record component

    • ssoEnabled

      public Boolean ssoEnabled()
      Returns the value of the ssoEnabled record component.
      Returns:
      the value of the ssoEnabled record component

    • ssoDomain

      public String ssoDomain()
      Returns the value of the ssoDomain record component.
      Returns:
      the value of the ssoDomain record component

    • userPrefix

      public String userPrefix()
      Returns the value of the userPrefix record component.
      Returns:
      the value of the userPrefix record component

    • userSuffix

      public String userSuffix()
      Returns the value of the userSuffix record component.
      Returns:
      the value of the userSuffix record component

    • automaticSuffix

      public Boolean automaticSuffix()
      Returns the value of the automaticSuffix record component.
      Returns:
      the value of the automaticSuffix record component

    • usePrefixAndSuffixForGatewayUser

      public Boolean usePrefixAndSuffixForGatewayUser()
      Returns the value of the usePrefixAndSuffixForGatewayUser record component.
      Returns:
      the value of the usePrefixAndSuffixForGatewayUser record component

    • userSearchBase

      public String userSearchBase()
      Returns the value of the userSearchBase record component.
      Returns:
      the value of the userSearchBase record component

    • userSearchFilter

      public String userSearchFilter()
      Returns the value of the userSearchFilter record component.
      Returns:
      the value of the userSearchFilter record component

    • userListFilter

      public String userListFilter()
      Returns the value of the userListFilter record component.
      Returns:
      the value of the userListFilter record component

    • userNameAttribute

      public String userNameAttribute()
      Returns the value of the userNameAttribute record component.
      Returns:
      the value of the userNameAttribute record component

    • userIdAttribute

      public LdapAttribute userIdAttribute()
      Returns the value of the userIdAttribute record component.
      Returns:
      the value of the userIdAttribute record component

    • userRoleAttribute

      public String userRoleAttribute()
      Returns the value of the userRoleAttribute record component.
      Returns:
      the value of the userRoleAttribute record component

    • nestedGroups

      public Boolean nestedGroups()
      Returns the value of the nestedGroups record component.
      Returns:
      the value of the nestedGroups record component

    • groupRoleAttribute

      public String groupRoleAttribute()
      Returns the value of the groupRoleAttribute record component.
      Returns:
      the value of the groupRoleAttribute record component

    • roleNameAttribute

      public String roleNameAttribute()
      Returns the value of the roleNameAttribute record component.
      Returns:
      the value of the roleNameAttribute record component

    • roleIdAttribute

      public LdapAttribute roleIdAttribute()
      Returns the value of the roleIdAttribute record component.
      Returns:
      the value of the roleIdAttribute record component

    • fullNameAttribute

      public String fullNameAttribute()
      Returns the value of the fullNameAttribute record component.
      Returns:
      the value of the fullNameAttribute record component

    • phoneAttribute

      public String phoneAttribute()
      Returns the value of the phoneAttribute record component.
      Returns:
      the value of the phoneAttribute record component

    • emailAttribute

      public String emailAttribute()
      Returns the value of the emailAttribute record component.
      Returns:
      the value of the emailAttribute record component

    • smsAttribute

      public String smsAttribute()
      Returns the value of the smsAttribute record component.
      Returns:
      the value of the smsAttribute record component

    • badgeAttribute

      public String badgeAttribute()
      Returns the value of the badgeAttribute record component.
      Returns:
      the value of the badgeAttribute record component

    • readTimeout

      public Long readTimeout()
      Returns the value of the readTimeout record component.
      Returns:
      the value of the readTimeout record component

    • pageSize

      public Integer pageSize()
      Returns the value of the pageSize record component.
      Returns:
      the value of the pageSize record component

    • roleSearchBase

      public String roleSearchBase()
      Returns the value of the roleSearchBase record component.
      Returns:
      the value of the roleSearchBase record component

    • roleSearchFilter

      public String roleSearchFilter()
      Returns the value of the roleSearchFilter record component.
      Returns:
      the value of the roleSearchFilter record component

    • badgeSearchFilter

      public String badgeSearchFilter()
      Returns the value of the badgeSearchFilter record component.
      Returns:
      the value of the badgeSearchFilter record component

    • allowAnon

      public Boolean allowAnon()
      Returns the value of the allowAnon record component.
      Returns:
      the value of the allowAnon record component

    • securityProtocol

      public LDAPHelper.ProtocolType securityProtocol()
      Returns the value of the securityProtocol record component.
      Returns:
      the value of the securityProtocol record component

    • authenticationType

      public LDAPHelper.AuthType authenticationType()
      Returns the value of the authenticationType record component.
      Returns:
      the value of the authenticationType record component

    • saslMechanism

      public String saslMechanism()
      Returns the value of the saslMechanism record component.
      Returns:
      the value of the saslMechanism record component

    • saslRealm

      public String saslRealm()
      Returns the value of the saslRealm record component.
      Returns:
      the value of the saslRealm record component

    • saslQualityOfProtection

      public String saslQualityOfProtection()
      Returns the value of the saslQualityOfProtection record component.
      Returns:
      the value of the saslQualityOfProtection record component

    • saslProtectionStrength

      public String saslProtectionStrength()
      Returns the value of the saslProtectionStrength record component.
      Returns:
      the value of the saslProtectionStrength record component

    • saslMutualAuthentication

      public Boolean saslMutualAuthentication()
      Returns the value of the saslMutualAuthentication record component.
      Returns:
      the value of the saslMutualAuthentication record component

    • referral

      public LDAPHelper.ReferralType referral()
      Returns the value of the referral record component.
      Returns:
      the value of the referral record component

    • extraUserAttributes

      public List<ExtraLdapAttribute> extraUserAttributes()
      Returns the value of the extraUserAttributes record component.
      Returns:
      the value of the extraUserAttributes record component