com.enjin.sdk

Class ProjectClient

java.lang.Object

com.enjin.sdk.schemas.BaseSchema

com.enjin.sdk.schemas.shared.SharedSchema

com.enjin.sdk.schemas.project.ProjectSchema

com.enjin.sdk.ProjectClient

All Implemented Interfaces:

IClient, IProjectSchema, ISharedSchema, java.io.Closeable, java.lang.AutoCloseable

public final class ProjectClient
extends ProjectSchema
implements IClient

Client for using the project schema.

See Also:

EnjinHosts

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectClient.ProjectClientBuilder Builder class for ProjectClient.

Field Summary

Fields inherited from class com.enjin.sdk.schemas.project.ProjectSchema

playerService, SCHEMA, walletService

Fields inherited from class com.enjin.sdk.schemas.shared.SharedSchema

assetService, balanceService, platformService, projectService, transactionService

Fields inherited from class com.enjin.sdk.schemas.BaseSchema

middleware, schema

Method Summary

Modifier and Type	Method and Description
void	auth(AccessToken accessToken) Authenticates the client using the given access token model.
void	auth(java.lang.String token) Authenticates this client with the given token.
java.util.concurrent.CompletableFuture<java.lang.Void>	authClient(@NonNull java.lang.String uuid, @NonNull java.lang.String secret) Sends a request to the platform to authenticate this client.
static ProjectClient.ProjectClientBuilder	builder() Creates a builder for this class.
void	close()
boolean	isAuthenticated() Determines whether this client is authenticated.
boolean	isAutomaticReauthenticationEnabled()
boolean	isClosed() Determines whether this client is closed.
boolean	isReauthenticationRunning()

Methods inherited from class com.enjin.sdk.schemas.project.ProjectSchema

advancedSendAsset, approveEnj, approveMaxEnj, authPlayer, authProject, bridgeAsset, bridgeAssets, bridgeClaimAsset, completeTrade, createAsset, createPlayer, createTrade, decreaseMaxMeltFee, decreaseMaxTransferFee, deletePlayer, getAssetsFromProjects, getPlayer, getPlayers, getWallet, getWallets, invalidateAssetMetadata, meltAsset, message, mintAsset, releaseReserve, resetEnjApproval, sendAsset, sendEnj, setApprovalForAll, setMeltFee, setTransferable, setTransferFee, setUri, setWhitelisted, unlinkWallet, updateName

Methods inherited from class com.enjin.sdk.schemas.shared.SharedSchema

cancelTransaction, getAsset, getAssets, getBalances, getBalancesFromProjects, getGasPrices, getPlatform, getProject, getRequest, getRequests, transactionRequest

Methods inherited from class com.enjin.sdk.schemas.BaseSchema

createRequestBody, createResult, createService, getLoggerProvider, sendRequest, version

Methods inherited from class java.lang.Object

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

Method Detail

auth

public void auth(java.lang.String token)

Authenticates this client with the given token.

If this client has automatic reauthentication enabled, then this method will halt the reauthentication timer.

Specified by:

auth in interface IClient

Parameters:

token - The auth token.

auth

public void auth(AccessToken accessToken)
          throws java.lang.IllegalArgumentException

Authenticates the client using the given access token model.

If this client has automatic reauthentication enabled, then this method may halt the reauthentication timer when accessToken is null. Otherwise the timer will be restarted.

Parameters:

accessToken - The access token.

Throws:

java.lang.IllegalArgumentException - If accessToken is not null and either its AccessToken.getToken() method or AccessToken.getExpiresIn() method returns null.

authClient

public java.util.concurrent.CompletableFuture<java.lang.Void> authClient(@NonNull
                                                                         @NonNull java.lang.String uuid,
                                                                         @NonNull
                                                                         @NonNull java.lang.String secret)
                                                                  throws java.lang.IllegalStateException

Sends a request to the platform to authenticate this client.

If this client is enabled for automatic reauthentication, then it will cache the UUID and secret and reauthenticate itself before the AccessToken returned by the platform expires.

Parameters:

uuid - The project's UUID.

secret - The project's secret.

Returns:

The future for this operation.

Throws:

java.lang.IllegalStateException - If this client is closed at the time this method is called.

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: IClient

Determines whether this client is authenticated.

Specified by:

isAuthenticated in interface IClient

Returns:

True if authenticated, false otherwise.

isClosed

public boolean isClosed()

Description copied from interface: IClient

Determines whether this client is closed.

Specified by:

isClosed in interface IClient

Returns:

True if closed, false otherwise.

builder

public static ProjectClient.ProjectClientBuilder builder()

Creates a builder for this class.

Returns:

The builder.

isAutomaticReauthenticationEnabled

public boolean isAutomaticReauthenticationEnabled()

Returns:

Whether this client is enabled for automatic reauthentication.

isReauthenticationRunning

public boolean isReauthenticationRunning()

Returns:

Whether the reauthentication timer is running.