Package land.oras.auth

Record Class HttpClient.TokenResponse

java.lang.Object

java.lang.Record

land.oras.auth.HttpClient.TokenResponse

Record Components:

token - The token

service - The service (not on response but on HTTP headers)

access_token - The access token

expires_in - The expires in

issued_at - The issued at

Enclosing class:

HttpClient

public static record HttpClient.TokenResponse(String token, @Nullable String access_token, @Nullable String service, @Nullable Integer expires_in, @Nullable ZonedDateTime issued_at)
extends Record

The token response

Constructor Summary

Constructors

Constructor	Description
TokenResponse(String token, @Nullable String access_token, @Nullable String service, @Nullable Integer expires_in, @Nullable ZonedDateTime issued_at)	Creates an instance of a TokenResponse record class.

Method Summary

Modifier and Type	Method	Description
@Nullable String	access_token()	Returns the value of the access_token record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable Integer	expires_in()	Returns the value of the expires_in record component.
HttpClient.TokenResponse	forService(String service)	Create a new token response with the service field set
String	getEffectiveToken()	>>>>>>> 6379975 (Store token into caffeine cache (#631)) Get the effective token
final int	hashCode()	Returns a hash code value for this object.
@Nullable ZonedDateTime	issued_at()	Returns the value of the issued_at record component.
@Nullable String	service()	Returns the value of the service record component.
String	token()	Returns the value of the token record component.
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

TokenResponse

public TokenResponse(String token,
 @Nullable String access_token,
 @Nullable String service,
 @Nullable Integer expires_in,
 @Nullable ZonedDateTime issued_at)

Creates an instance of a TokenResponse record class.

Parameters:

token - the value for the token record component

access_token - the value for the access_token record component

service - the value for the service record component

expires_in - the value for the expires_in record component

issued_at - the value for the issued_at record component

Method Details

forService

public HttpClient.TokenResponse forService(String service)

Create a new token response with the service field set

Parameters:

service - The service

Returns:

A new token response with the service field set

getEffectiveToken

public String getEffectiveToken()

>>>>>>> 6379975 (Store token into caffeine cache (#631)) Get the effective token

Returns:

The effective token, which is either the access_token or the token field depending on which one is present

toString

public 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.

token

public String token()

Returns the value of the token record component.

Returns:

the value of the token record component

access_token

public @Nullable String access_token()

Returns the value of the access_token record component.

Returns:

the value of the access_token record component

service

public @Nullable String service()

Returns the value of the service record component.

Returns:

the value of the service record component

expires_in

public @Nullable Integer expires_in()

Returns the value of the expires_in record component.

Returns:

the value of the expires_in record component

issued_at

public @Nullable ZonedDateTime issued_at()

Returns the value of the issued_at record component.

Returns:

the value of the issued_at record component