Package com.inductiveautomation.ignition.common.auth.messages

Record Class LoginResult

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.common.auth.messages.LoginResult

Record Components:

user - The validated user information.

sessionId - The internal ID used as a stable identifier.

secret - Any arbitrary piece of "secret" info to piggyback on the result, such as an auth token.

public record LoginResult(@Nullable AuthenticatedUser user, String sessionId, @Nullable String secret)
extends Record

Basic nominal tuple used as a return value for Designer and Client authentication.

Constructor Summary

Constructors

Constructor	Description
LoginResult(AuthenticatedUser user, String sessionId, String secret)	Creates an instance of a LoginResult 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.
String	secret()	Returns the value of the secret record component.
String	sessionId()	Returns the value of the sessionId record component.
final String	toString()	Returns a string representation of this record class.
AuthenticatedUser	user()	Returns the value of the user record component.

Methods inherited from class java.lang.Object

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

Constructor Details

LoginResult

public LoginResult(@Nullable
 AuthenticatedUser user,
 String sessionId,
 @Nullable
 String secret)

Creates an instance of a LoginResult record class.

Parameters:

user - the value for the user record component

sessionId - the value for the sessionId record component

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

user

@Nullable
public AuthenticatedUser user()

Returns the value of the user record component.

Returns:

the value of the user record component

sessionId

public String sessionId()

Returns the value of the sessionId record component.

Returns:

the value of the sessionId record component

secret

@Nullable
public String secret()

Returns the value of the secret record component.

Returns:

the value of the secret record component