Package com.ultikits.ultitools.utils

Class UltiCloudRequests

java.lang.Object

com.ultikits.ultitools.utils.UltiCloudRequests

@Deprecated(since="6.3.1",
            forRemoval=true)
public final class UltiCloudRequests
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

Use CloudPlayerLinks to link a player; protocol 2.0.0 has no v1 REST cloud, so every call of this class is refused. Removed in 6.4.0.

The removed UltiCloud v1 request helper; every call is answered UltiCloudRequests.Outcome.PATH_NOT_ALLOWED.

Protocol 2.0.0 has no v1 REST cloud, so the two magic-link requests this class used to make (POST /auth/magic-link and GET /auth/magic-link/poll) no longer reach anything and are refused without opening a connection. The first such call in a run writes one INFO line that names the replacement.

Replacement. UltiLogin 2.1.0 uses CloudPlayerLinks: the framework asks the gateway for a one-time player link and the gateway reports how the web user proved the game identity, so no module talks to a cloud endpoint itself and no module ever holds the server credential.

Compatibility. Every public type and member of 6.3.0 is still present with the same signatures; only behaviour and this documentation changed. As of 6.3.1 the class, its two calls and its two nested types are deprecated for removal in 6.4.0. UltiLogin 2.0.0 maps UltiCloudRequests.Outcome.PATH_NOT_ALLOWED to a link error and never retries, so its /panel fails in the way it already handles.

Threading. The methods no longer perform network I/O, but they keep the 6.3.0 contract and still refuse the server's primary thread with IllegalStateException; callers that already hop to an asynchronous task keep working unchanged.

Since:

6.3.0

Scheduled removal version:

6.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UltiCloudRequests.Outcome	Deprecated, for removal: This API element is subject to removal in a future version. There is no replacement: CloudPlayerLinks reports its own outcomes.
static final class	UltiCloudRequests.Result	Deprecated, for removal: This API element is subject to removal in a future version. There is no replacement: CloudPlayerLinks reports its own outcomes.

Field Summary

Fields

Modifier and Type	Field	Description
private static final AtomicBoolean	ANNOUNCED	Deprecated, for removal: This API element is subject to removal in a future version.
private static final String	CREATE_PATH	Deprecated, for removal: This API element is subject to removal in a future version. The request path UltiLogin 2.0.0 used to create a link.
private static final Logger	LOGGER	Deprecated, for removal: This API element is subject to removal in a future version.
private static final String	POLL_PATH	Deprecated, for removal: This API element is subject to removal in a future version. The request path UltiLogin 2.0.0 used to poll that link.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	UltiCloudRequests()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
private static void	announceOnce(boolean removedCall)	Deprecated, for removal: This API element is subject to removal in a future version.
static UltiCloudRequests.Result	get(String path, Map<String,String> query)	Deprecated, for removal: This API element is subject to removal in a future version. Use 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>) to link a player; protocol 2.0.0 has no v1 REST cloud, so this call is always refused.
static UltiCloudRequests.Result	post(String path, String jsonBody)	Deprecated, for removal: This API element is subject to removal in a future version. Use 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>) to link a player; protocol 2.0.0 has no v1 REST cloud, so this call is always refused.
private static void	requireOffPrimaryThread()	Deprecated, for removal: This API element is subject to removal in a future version.
(package private) static void	resetAnnouncementForTesting()	Deprecated, for removal: This API element is subject to removal in a future version. Drops the once-per-run announcement so a test can observe it again.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final Logger LOGGER

Deprecated, for removal: This API element is subject to removal in a future version.

CREATE_PATH

private static final String CREATE_PATH

Deprecated, for removal: This API element is subject to removal in a future version.

The request path UltiLogin 2.0.0 used to create a link.

See Also:

• Constant Field Values

POLL_PATH

private static final String POLL_PATH

Deprecated, for removal: This API element is subject to removal in a future version.

The request path UltiLogin 2.0.0 used to poll that link.

See Also:

• Constant Field Values

ANNOUNCED

private static final AtomicBoolean ANNOUNCED

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

UltiCloudRequests

private UltiCloudRequests()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

post

@Deprecated(since="6.3.1",
            forRemoval=true)
public static UltiCloudRequests.Result post(String path,
 String jsonBody)

Deprecated, for removal: This API element is subject to removal in a future version.

Use 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>) to link a player; protocol 2.0.0 has no v1 REST cloud, so this call is always refused. Removed in 6.4.0.

Answers UltiCloudRequests.Outcome.PATH_NOT_ALLOWED without opening a connection; no request is made.

Parameters:

path - the request path; only the two removed magic-link paths write a diagnostic

jsonBody - the JSON request body, ignored because nothing is sent

Returns:

UltiCloudRequests.Outcome.PATH_NOT_ALLOWED with no status code and no body

Throws:

IllegalStateException - if called on the server's primary thread

Scheduled removal version:

6.4.0

get

@Deprecated(since="6.3.1",
            forRemoval=true)
public static UltiCloudRequests.Result get(String path,
 Map<String,String> query)

Deprecated, for removal: This API element is subject to removal in a future version.

Use 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>) to link a player; protocol 2.0.0 has no v1 REST cloud, so this call is always refused. Removed in 6.4.0.

Answers UltiCloudRequests.Outcome.PATH_NOT_ALLOWED without opening a connection; no request is made.

Parameters:

path - the request path; only the two removed magic-link paths write a diagnostic

query - query parameters, ignored because nothing is sent

Returns:

UltiCloudRequests.Outcome.PATH_NOT_ALLOWED with no status code and no body

Throws:

IllegalStateException - if called on the server's primary thread

Scheduled removal version:

6.4.0

requireOffPrimaryThread

private static void requireOffPrimaryThread()

Deprecated, for removal: This API element is subject to removal in a future version.

announceOnce

private static void announceOnce(boolean removedCall)

Deprecated, for removal: This API element is subject to removal in a future version.

resetAnnouncementForTesting

static void resetAnnouncementForTesting()

Deprecated, for removal: This API element is subject to removal in a future version.

Drops the once-per-run announcement so a test can observe it again.