Record Class FencingToken

java.lang.Object

java.lang.Record

org.j7m.middleware.api.reliability.FencingToken

Record Components:

authority - fencing authority name

scope - protected resource scope

value - monotonic token value

All Implemented Interfaces:

Serializable, Comparable<FencingToken>

public record FencingToken(String authority, String scope, long value)
extends Record
implements Comparable<FencingToken>, Serializable

Monotonic token issued by a named fencing authority for a protected scope.

The record is immutable, serializable, thread-safe, and comparable only within the same authority and scope. Tokens prevent stale owners only when the protected resource enforces them.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FencingToken(String authority, String scope, long value)	Creates a validated fencing token.

Method Summary

Modifier and Type	Method	Description
String	authority()	Returns the value of the authority record component.
int	compareTo(FencingToken other)
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	scope()	Returns the value of the scope record component.
String	toString()
long	value()	Returns the value of the value record component.

Methods inherited from class Object

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

Constructor Details

FencingToken

public FencingToken(String authority,
 String scope,
 long value)

Creates a validated fencing token.

Throws:

IllegalArgumentException - when authority or scope is invalid, or the value is negative

Method Details

compareTo

public int compareTo(FencingToken other)

Specified by:

compareTo in interface Comparable<FencingToken>

toString

public String toString()

Specified by:

toString in class Record

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

authority

public String authority()

Returns the value of the authority record component.

Returns:

the value of the authority record component

scope

public String scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component

value

public long value()

Returns the value of the value record component.

Returns:

the value of the value record component