com.sk89q.squirrelid.resolver

Class HttpRepositoryService

java.lang.Object

com.sk89q.squirrelid.resolver.HttpRepositoryService

All Implemented Interfaces:

ProfileService

public class HttpRepositoryService
extends Object
implements ProfileService

Resolves names in bulk to UUIDs using Mojang's profile HTTP API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MINECRAFT_AGENT

Constructor Summary

Constructors

Constructor and Description
HttpRepositoryService(String agent) Create a new resolver.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Profile>	findAllByName(Iterable<String> names) Query the profile server for UUIDs for the given names.
void	findAllByName(Iterable<String> names, com.google.common.base.Predicate<Profile> consumer) Query the profile server for UUIDs for the given names.
Profile	findByName(String name) Query the profile server for the UUID of a name.
static ProfileService	forMinecraft() Create a resolver for Minecraft.
int	getIdealRequestLimit() Get the optimal maximum number of profiles that can be found with one ProfileService.findAllByName(Iterable) call.
int	getMaxRetries() Get the maximum number of HTTP request retries.
long	getRetryDelay() Get the number of milliseconds to delay after each failed HTTP request, doubling each time until success or total failure.
protected com.google.common.collect.ImmutableList<Profile>	query(Iterable<String> names) Perform a query for profiles without partitioning the queries.
void	setMaxRetries(int maxRetries) Set the maximum number of HTTP request retries.
void	setRetryDelay(long retryDelay) Set the number of milliseconds to delay after each failed HTTP request, doubling each time until success or total failure.

Methods inherited from class java.lang.Object

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

Field Detail

MINECRAFT_AGENT

public static final String MINECRAFT_AGENT

See Also:

Constant Field Values

Constructor Detail

HttpRepositoryService

public HttpRepositoryService(String agent)

Create a new resolver.

For Minecraft, use the MINECRAFT_AGENT constant. The UUID to name mapping is only available if a user owns the game for the provided "agent," so an incorrect agent may return zero results or incorrect results.

Parameters:

agent - the agent (i.e. the game)

Method Detail

getMaxRetries

public int getMaxRetries()

Get the maximum number of HTTP request retries.

Returns:

the maximum number of retries

setMaxRetries

public void setMaxRetries(int maxRetries)

Set the maximum number of HTTP request retries.

Parameters:

maxRetries - the maximum number of retries

getRetryDelay

public long getRetryDelay()

Get the number of milliseconds to delay after each failed HTTP request, doubling each time until success or total failure.

Returns:

delay in milliseconds

setRetryDelay

public void setRetryDelay(long retryDelay)

Set the number of milliseconds to delay after each failed HTTP request, doubling each time until success or total failure.

Parameters:

retryDelay - delay in milliseconds

getIdealRequestLimit

public int getIdealRequestLimit()

Description copied from interface: ProfileService

Get the optimal maximum number of profiles that can be found with one ProfileService.findAllByName(Iterable) call.

ProfileService.findAllByName(Iterable) (and similar) methods may split up requests into smaller ones to fit within one request. This method returns the ideal maximum number.

Specified by:

getIdealRequestLimit in interface ProfileService

Returns:

the number of profiles

findByName

@Nullable
public Profile findByName(String name)
                             throws IOException,
                                    InterruptedException

Description copied from interface: ProfileService

Query the profile server for the UUID of a name.

Specified by:

findByName in interface ProfileService

Parameters:

name - a name

Returns:

the profile of the user, otherwise null

Throws:

IOException - thrown on I/O error

InterruptedException - thrown on interruption

findAllByName

public void findAllByName(Iterable<String> names,
                          com.google.common.base.Predicate<Profile> consumer)
                   throws IOException,
                          InterruptedException

Description copied from interface: ProfileService

Query the profile server for UUIDs for the given names.

Specified by:

findAllByName in interface ProfileService

Parameters:

names - an iterable containing names to search

consumer - a consumer function that will receive discovered profiles

Throws:

IOException - thrown on I/O error

InterruptedException - thrown on interruption

findAllByName

public com.google.common.collect.ImmutableList<Profile> findAllByName(Iterable<String> names)
                                                               throws IOException,
                                                                      InterruptedException

Description copied from interface: ProfileService

Query the profile server for UUIDs for the given names.

Specified by:

findAllByName in interface ProfileService

Parameters:

names - an iterable containing names to search

Returns:

a list of found profiles

Throws:

IOException - thrown on I/O error

InterruptedException - thrown on interruption

query

protected com.google.common.collect.ImmutableList<Profile> query(Iterable<String> names)
                                                          throws IOException,
                                                                 InterruptedException

Perform a query for profiles without partitioning the queries.

Parameters:

names - an iterable of names

Returns:

a list of results

Throws:

IOException - thrown on I/O error

InterruptedException - thrown on interruption

forMinecraft

public static ProfileService forMinecraft()

Create a resolver for Minecraft.

Returns:

a UUID resolver