org.spongepowered.api.profile

Interface GameProfileManager

public interface GameProfileManager

Manages GameProfile creation and data population.

The manager may cache the data of a request for faster lookups. Note that the cached data may not always be up to date.

Method Summary

Modifier and Type	Method and Description
GameProfile	createProfile(UUID uniqueId, String name) Creates a GameProfile from the provided ID and name.
ProfileProperty	createProfileProperty(String name, String value, String signature) Creates a ProfileProperty from the provided name, value, and optional signature.
default CompletableFuture<GameProfile>	fill(GameProfile profile) Fills a GameProfile.
default CompletableFuture<GameProfile>	fill(GameProfile profile, boolean signed) Fills a GameProfile.
CompletableFuture<GameProfile>	fill(GameProfile profile, boolean signed, boolean useCache) Fills a GameProfile.
default CompletableFuture<GameProfile>	get(String name) Looks up a GameProfile by its user name (case-insensitive).
CompletableFuture<GameProfile>	get(String name, boolean useCache) Looks up a GameProfile by its user name (case-insensitive).
default CompletableFuture<GameProfile>	get(UUID uniqueId) Looks up a GameProfile by its unique ID.
CompletableFuture<GameProfile>	get(UUID uniqueId, boolean useCache) Looks up a GameProfile by its unique ID.
CompletableFuture<Collection<GameProfile>>	getAllById(Iterable<UUID> uniqueIds, boolean useCache) Gets a collection of GameProfiles by their unique IDs.
CompletableFuture<Collection<GameProfile>>	getAllByName(Iterable<String> names, boolean useCache) Gets a collection of GameProfiles by their user names (case-insensitive).
GameProfileCache	getCache() Gets the active GameProfile cache.
GameProfileCache	getDefaultCache() Gets the default cache.
void	setCache(GameProfileCache cache) Sets the GameProfile cache.

Method Detail

createProfile

GameProfile createProfile(UUID uniqueId,
                          @Nullable
                          String name)

Creates a GameProfile from the provided ID and name.

Parameters:

uniqueId - The unique ID

name - The name

Returns:

The created profile

See Also:

GameProfile.of(UUID, String)

createProfileProperty

ProfileProperty createProfileProperty(String name,
                                      String value,
                                      @Nullable
                                      String signature)

Creates a ProfileProperty from the provided name, value, and optional signature.

Parameters:

name - The name for the property

value - The value of the property

signature - The signature of the property

Returns:

The created profile property

See Also:

ProfileProperty.of(String, String), ProfileProperty.of(String, String, String)

get

default CompletableFuture<GameProfile> get(UUID uniqueId)

Looks up a GameProfile by its unique ID.

This method checks the local profile cache before contacting the profile servers. Use get(UUID, boolean) to disable the cache lookup.

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

uniqueId - The unique ID

Returns:

The result of the request

get

default CompletableFuture<GameProfile> get(String name)

Looks up a GameProfile by its user name (case-insensitive).

This method checks the local profile cache before contacting the profile servers. Use get(String, boolean) to disable the cache lookup.

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

name - The username

Returns:

The result of the request

get

CompletableFuture<GameProfile> get(UUID uniqueId,
                                   boolean useCache)

Looks up a GameProfile by its unique ID.

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

uniqueId - The unique ID

useCache - true to perform a cache lookup first

Returns:

The result of the request

get

CompletableFuture<GameProfile> get(String name,
                                   boolean useCache)

Looks up a GameProfile by its user name (case-insensitive).

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

name - The username

useCache - true to perform a cache lookup first

Returns:

The result of the request

getAllById

CompletableFuture<Collection<GameProfile>> getAllById(Iterable<UUID> uniqueIds,
                                                      boolean useCache)

Gets a collection of GameProfiles by their unique IDs.

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

uniqueIds - The UUIDs

useCache - true to perform a cache lookup first

Returns:

The result of the request

getAllByName

CompletableFuture<Collection<GameProfile>> getAllByName(Iterable<String> names,
                                                        boolean useCache)

Gets a collection of GameProfiles by their user names (case-insensitive).

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

names - The user names

useCache - true to perform a cache lookup first

Returns:

The result of the request

fill

default CompletableFuture<GameProfile> fill(GameProfile profile)

Fills a GameProfile.

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

profile - The profile to fill

Returns:

The result of the request

fill

default CompletableFuture<GameProfile> fill(GameProfile profile,
                                            boolean signed)

Fills a GameProfile.

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

profile - The profile to fill

signed - true if we should request that the profile data be signed

Returns:

The result of the request

fill

CompletableFuture<GameProfile> fill(GameProfile profile,
                                    boolean signed,
                                    boolean useCache)

Fills a GameProfile.

The returned CompletableFuture throws an ExecutionException caused by a ProfileNotFoundException if the profile does not exist or an IOException if a network error occurred.

Parameters:

profile - The profile to fill

signed - true if we should request that the profile data be signed

useCache - true to perform a cache lookup first

Returns:

The result of the request

getCache

GameProfileCache getCache()

Gets the active GameProfile cache.

Returns:

The active cache

setCache

void setCache(GameProfileCache cache)

Sets the GameProfile cache.

To restore the original cache, pass the result of getDefaultCache().

Parameters:

cache - The new cache

getDefaultCache

GameProfileCache getDefaultCache()

Gets the default cache.

Returns:

The default cache.