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

Record Class UsersJsonResource

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.authentication.resources.UsersJsonResource

Record Components:

users - A list of users available for this profile.

roles - A list of roles available for this profile.

public record UsersJsonResource(List<InternalUserResource> users, List<InternalRoleResource> roles)
extends Record

Represents the data that gets stored in the users.json file for each internal user source profile.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USERS_JSON	The name of the users.json file.

Constructor Summary

Constructors

Constructor	Description
UsersJsonResource(List<InternalUserResource> users, List<InternalRoleResource> roles)	Creates an instance of a UsersJsonResource record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<InternalRoleResource>	roles()	Returns the value of the roles record component.
final String	toString()	Returns a string representation of this record class.
List<InternalUserResource>	users()	Returns the value of the users record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

USERS_JSON

public static final String USERS_JSON

The name of the users.json file.

See Also:

• Constant Field Values

Constructor Details

UsersJsonResource

public UsersJsonResource(List<InternalUserResource> users,
 List<InternalRoleResource> roles)

Creates an instance of a UsersJsonResource record class.

Parameters:

users - the value for the users record component

roles - the value for the roles 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.

users

public List<InternalUserResource> users()

Returns the value of the users record component.

Returns:

the value of the users record component

roles

public List<InternalRoleResource> roles()

Returns the value of the roles record component.

Returns:

the value of the roles record component