Package com.ultikits.ultitools.websocket

Class CloudPlayerLinks.LinkCreation

java.lang.Object

com.ultikits.ultitools.websocket.CloudPlayerLinks.LinkCreation

Enclosing class:

CloudPlayerLinks

public static final class CloudPlayerLinks.LinkCreation
extends Object

The answer to one CloudPlayerLinks.create(com.ultikits.ultitools.abstracts.UltiToolsPlugin, java.util.UUID, java.lang.String, com.ultikits.ultitools.websocket.CloudPlayerLinks.GameAuth, java.util.Set<com.ultikits.ultitools.websocket.CloudPlayerLinks.LinkProof>) call: either a link, or a failure with a safe message.

Since:

6.3.1

Field Summary

Fields

Modifier and Type	Field	Description
private final List<CloudPlayerLinks.LinkProof>	acceptedProofs
private final Instant	expiresAt
private final CloudPlayerLinks.Failure	failure
private final String	linkId
private final String	message
private final String	url

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LinkCreation(String linkId, String url, Instant expiresAt, Collection<CloudPlayerLinks.LinkProof> acceptedProofs, CloudPlayerLinks.Failure failure, String message)

Method Summary

Modifier and Type	Method	Description
List<CloudPlayerLinks.LinkProof>	acceptedProofs()
static CloudPlayerLinks.LinkCreation	created(String linkId, String url, Instant expiresAt, Collection<CloudPlayerLinks.LinkProof> acceptedProofs)	Creates a successful answer.
Instant	expiresAt()
static CloudPlayerLinks.LinkCreation	failed(CloudPlayerLinks.Failure failure, String message)	Creates a failed answer.
CloudPlayerLinks.Failure	failure()
String	linkId()
String	message()
String	toString()
String	url()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

linkId

private final String linkId

url

private final String url

expiresAt

private final Instant expiresAt

acceptedProofs

private final List<CloudPlayerLinks.LinkProof> acceptedProofs

failure

private final CloudPlayerLinks.Failure failure

message

private final String message

Constructor Details

LinkCreation

private LinkCreation(String linkId,
 String url,
 Instant expiresAt,
 Collection<CloudPlayerLinks.LinkProof> acceptedProofs,
 CloudPlayerLinks.Failure failure,
 String message)

Method Details

created

public static CloudPlayerLinks.LinkCreation created(String linkId,
 String url,
 Instant expiresAt,
 Collection<CloudPlayerLinks.LinkProof> acceptedProofs)

Creates a successful answer.

Parameters:

linkId - the id of the player.link.create this link answers

url - the one-time https URL to show the player

expiresAt - the issue time plus 600 seconds, on the framework's clock

acceptedProofs - the proofs the gateway accepted, never empty

Returns:

the answer

failed

public static CloudPlayerLinks.LinkCreation failed(CloudPlayerLinks.Failure failure,
 String message)

Creates a failed answer.

Parameters:

failure - why it failed

message - a safe diagnostic for the module or operator, never a credential

Returns:

the answer

linkId

public String linkId()

Returns:

the link id, or null for a failed answer

url

public String url()

Returns:

the one-time URL, or null for a failed answer

expiresAt

public Instant expiresAt()

Returns:

the expiry on the framework's clock, or null for a failed answer

acceptedProofs

public List<CloudPlayerLinks.LinkProof> acceptedProofs()

Returns:

the accepted proofs, empty for a failed answer

failure

public CloudPlayerLinks.Failure failure()

Returns:

why the request failed, or null for a successful answer

message

public String message()

Returns:

the safe failure message, or null for a successful answer

toString

public String toString()

Overrides:

toString in class Object