net.rithms.riot.api

Class ApiConfig

java.lang.Object

net.rithms.riot.api.ApiConfig

All Implemented Interfaces:

java.lang.Cloneable

public class ApiConfig
extends java.lang.Object
implements java.lang.Cloneable

Configuration class to use with the RiotApi.

Field Summary

Fields

Modifier and Type	Field and Description
int	DEFAULT_ASYNC_REQUEST_TIMEOUT
java.util.logging.Level	DEFAULT_DEBUG_LEVEL
boolean	DEFAULT_DEBUG_TO_FILE
int	DEFAULT_MAX_ASYNC_THREADS
RateLimitHandler	DEFAULT_RATE_LIMIT_HANDLER
int	DEFAULT_REQUEST_TIMEOUT
boolean	DEFAULT_TOURNAMENT_MOCK_MODE

Constructor Summary

Constructors

Constructor and Description
ApiConfig()

Method Summary

Modifier and Type	Method and Description
ApiConfig	clone()
int	getAsyncRequestTimeout()
java.util.logging.Level	getDebugLevel()
boolean	getDebugToFile()
java.lang.String	getKey()
int	getMaxAsyncThreads()
RateLimitHandler	getRateLimitHandler()
int	getRequestTimeout()
java.lang.String	getTournamentKey()
boolean	getTournamentMockMode()
ApiConfig	setAsyncRequestTimeout(int asyncRequestTimeout) Sets a specified timeout value, in milliseconds, for calls in RiotApiAsync to wait at most for a response.
ApiConfig	setDebugLevel(java.util.logging.Level debugLevel) Sets the debug level.
ApiConfig	setDebugToFile(boolean debugToFile) Sets whether the debug log should be saved in a file.
ApiConfig	setKey(java.lang.String key) Sets the api key for the Riot Api.
ApiConfig	setMaxAsyncThreads(int maxAsyncThreads) Sets the maximum amount of threads for asynchronous api calls running at once.
ApiConfig	setRateLimitHandler(RateLimitHandler rateLimitHandler) Sets the RateLimitHandler to take care of rate limiting.
ApiConfig	setRequestTimeout(int requestTimeout) Sets a specified timeout value, in milliseconds, for calls in RiotApi to wait at most for a response.
ApiConfig	setTournamentKey(java.lang.String tournamentKey) Sets the tournament api key for the Riot Api.
ApiConfig	setTournamentMockMode(boolean tournamentMockMode) Sets whether the api should redirect tournament method calls should be redirected to the TOURNAMENT-STUB endpoint.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ASYNC_REQUEST_TIMEOUT

public final int DEFAULT_ASYNC_REQUEST_TIMEOUT

See Also:

Constant Field Values

DEFAULT_DEBUG_LEVEL

public final java.util.logging.Level DEFAULT_DEBUG_LEVEL

DEFAULT_DEBUG_TO_FILE

public final boolean DEFAULT_DEBUG_TO_FILE

See Also:

Constant Field Values

DEFAULT_MAX_ASYNC_THREADS

public final int DEFAULT_MAX_ASYNC_THREADS

See Also:

Constant Field Values

DEFAULT_RATE_LIMIT_HANDLER

public final RateLimitHandler DEFAULT_RATE_LIMIT_HANDLER

DEFAULT_REQUEST_TIMEOUT

public final int DEFAULT_REQUEST_TIMEOUT

See Also:

Constant Field Values

DEFAULT_TOURNAMENT_MOCK_MODE

public final boolean DEFAULT_TOURNAMENT_MOCK_MODE

See Also:

Constant Field Values

Constructor Detail

ApiConfig

public ApiConfig()

Method Detail

clone

public ApiConfig clone()

Overrides:

clone in class java.lang.Object

getAsyncRequestTimeout

public int getAsyncRequestTimeout()

getDebugLevel

public java.util.logging.Level getDebugLevel()

getDebugToFile

public boolean getDebugToFile()

getKey

public java.lang.String getKey()

getMaxAsyncThreads

public int getMaxAsyncThreads()

getRateLimitHandler

public RateLimitHandler getRateLimitHandler()

getRequestTimeout

public int getRequestTimeout()

getTournamentKey

public java.lang.String getTournamentKey()

getTournamentMockMode

public boolean getTournamentMockMode()

setAsyncRequestTimeout

public ApiConfig setAsyncRequestTimeout(int asyncRequestTimeout)

Sets a specified timeout value, in milliseconds, for calls in RiotApiAsync to wait at most for a response. If set to zero, asynchronous requests won't time out.

To set the timeout for synchronous requests use setRequestTimeout(int) instead.

Parameters:

timeout - The maximum time for an asynchronous call to wait for a response until it times out

Returns:

This ApiConfig object for chaining

Throws:

java.lang.IllegalArgumentException - If the timeout value is smaller than 0

setDebugLevel

public ApiConfig setDebugLevel(java.util.logging.Level debugLevel)

Sets the debug level.

Parameters:

debugLevel - Debug level

Returns:

This ApiConfig object for chaining

setDebugToFile

public ApiConfig setDebugToFile(boolean debugToFile)

Sets whether the debug log should be saved in a file.

If debug logging to file is activated, a file named riot-api.log will be created and contain all logging messages for the level set via setDebugLevel(Level).

Parameters:

debugToFile - true if the debug log should be saved in a file, false otherwise

Returns:

This ApiConfig object for chaining

setKey

public ApiConfig setKey(java.lang.String key)

Sets the api key for the Riot Api. Most endpoints require this key to be set.

Parameters:

key - Your api key

Returns:

This ApiConfig object for chaining

Throws:

java.lang.NullPointerException - If the key is null

setMaxAsyncThreads

public ApiConfig setMaxAsyncThreads(int maxAsyncThreads)

Sets the maximum amount of threads for asynchronous api calls running at once. If set to zero, there is no limit.

If you make asynchronous calls, and the current thread limit is reached, the api call will be queued and executed when resources become available.

Parameters:

maxAsyncThreads - Max amount of threads to run at the same time

Returns:

This ApiConfig object for chaining

Throws:

java.lang.IllegalArgumentException - If the limit is smaller than 0

setRateLimitHandler

public ApiConfig setRateLimitHandler(RateLimitHandler rateLimitHandler)

Sets the RateLimitHandler to take care of rate limiting. Can bet set to null to ignore rate limiting.

Parameters:

rateLimitHandler - RateLimitHandler instance

Returns:

This ApiConfig object for chaining

setRequestTimeout

public ApiConfig setRequestTimeout(int requestTimeout)

Sets a specified timeout value, in milliseconds, for calls in RiotApi to wait at most for a response. If set to zero, requests won't time out.

To set the timeout for asynchronous requests use setAsyncRequestTimeout(int) instead.

Parameters:

timeout - The maximum time to wait for a response until a synchronous call fails

Returns:

This ApiConfig object for chaining

Throws:

java.lang.IllegalArgumentException - If the timeout value is smaller than 0

setTournamentKey

public ApiConfig setTournamentKey(java.lang.String tournamentKey)

Sets the tournament api key for the Riot Api. Tournament-related endpoints require this key to be set.

Parameters:

key - Your tournament api key

Returns:

This ApiConfig object for chaining

Throws:

java.lang.NullPointerException - If the tournamentKey is null

setTournamentMockMode

public ApiConfig setTournamentMockMode(boolean tournamentMockMode)

Sets whether the api should redirect tournament method calls should be redirected to the TOURNAMENT-STUB endpoint.

The TOURNAMENT-STUB endpoint provides dummy data meant for testing your app before going into production. Note that not all tournament methods are available in mock mode.

Parameters:

tournamentMockMode - true if tournament methods should be called in mock mode

Returns:

This ApiConfig object for chaining