Record Class SystemIdentityProvider

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.model.resources.SystemIdentityProvider
Record Components:
name - the configured Identity Provider name.

public record SystemIdentityProvider(String name) extends Record
A single Identity Provider entry in the system-level (Gateway and Designer) IdP list, GatewaySystemProperties.SystemIdentityProviders.

Currently carries only the IdP name(); it is modeled as an object rather than a bare string so that future per-IdP settings can be added without a breaking change to the persisted security configuration. It is serialized to/from JSON as part of SecurityPropertiesResource; a record works here because that resource is persisted with Gson (unlike the project-scoped equivalent, which is persisted with the legacy XMLSerializer).

  • Constructor Details

    • SystemIdentityProvider

      public SystemIdentityProvider(String name)
      Creates an instance of a SystemIdentityProvider record class.
      Parameters:
      name - the value for the name 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.
    • name

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