Package markets.alpaca.client.ws

Record Class AlpacaStreamAuthResult

java.lang.Object

java.lang.Record

markets.alpaca.client.ws.AlpacaStreamAuthResult

public record AlpacaStreamAuthResult(AlpacaStreamAuthResult.Status status, Integer code, String message)
extends Record

Result of a stream's first authentication attempt.

Use isAuthenticated() for simple success checks, or inspect status(), code(), and message() when operational diagnostics need the server response or close reason.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AlpacaStreamAuthResult.Status	Outcome categories for stream authentication.

Constructor Summary

Constructors

Constructor	Description
AlpacaStreamAuthResult(AlpacaStreamAuthResult.Status status, Integer code, String message)	Creates an instance of a AlpacaStreamAuthResult record class.

Method Summary

Modifier and Type	Method	Description
static AlpacaStreamAuthResult	authenticated()	Creates a successful authentication result.
static AlpacaStreamAuthResult	closed(String reason)	Creates a result for streams closed before authentication completed.
Integer	code()	Returns the value of the code record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static AlpacaStreamAuthResult	failed(String message, Throwable cause)	Creates a result for non-server-rejection failures before authentication completed.
final int	hashCode()	Returns a hash code value for this object.
static AlpacaStreamAuthResult	interrupted()	Creates a result for waiting callers that were interrupted.
boolean	isAuthenticated()	Returns true when status() is AlpacaStreamAuthResult.Status.AUTHENTICATED.
String	message()	Returns the value of the message record component.
static AlpacaStreamAuthResult	serverRejected(Integer code, String message)	Creates a result for credentials or auth requests rejected by the server.
AlpacaStreamAuthResult.Status	status()	Returns the value of the status record component.
static AlpacaStreamAuthResult	timeout(Duration timeout)	Creates a result for waiting callers whose timeout elapsed.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

AlpacaStreamAuthResult

public AlpacaStreamAuthResult(AlpacaStreamAuthResult.Status status,
 Integer code,
 String message)

Creates an instance of a AlpacaStreamAuthResult record class.

Parameters:

status - the value for the status record component

code - the value for the code record component

message - the value for the message record component

Method Details

isAuthenticated

public boolean isAuthenticated()

Returns true when status() is AlpacaStreamAuthResult.Status.AUTHENTICATED.

authenticated

public static AlpacaStreamAuthResult authenticated()

Creates a successful authentication result.

serverRejected

public static AlpacaStreamAuthResult serverRejected(Integer code,
 String message)

Creates a result for credentials or auth requests rejected by the server.

closed

public static AlpacaStreamAuthResult closed(String reason)

Creates a result for streams closed before authentication completed.

timeout

public static AlpacaStreamAuthResult timeout(Duration timeout)

Creates a result for waiting callers whose timeout elapsed.

interrupted

public static AlpacaStreamAuthResult interrupted()

Creates a result for waiting callers that were interrupted.

failed

public static AlpacaStreamAuthResult failed(String message,
 Throwable cause)

Creates a result for non-server-rejection failures before authentication completed.

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.

status

public AlpacaStreamAuthResult.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

code

public Integer code()

Returns the value of the code record component.

Returns:

the value of the code record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component