org.dc.riot.lol.rx.service

Class ApiKey

java.lang.Object

org.dc.riot.lol.rx.service.ApiKey

public class ApiKey
extends java.lang.Object

Primary entry point for using this service. Once an API key has been created an ApiFactory can be created to generate HTTP network accessors to the LoL API.

Since:

1.0.0

See Also:

Your Dashboard to create an API key, RiotApi, ApiFactory

Constructor Summary

Constructors

Constructor and Description
ApiKey(java.lang.String key, RateRule... rules) This constructor is exposed for convenience, but a better approach to creating ApiKey instances is to use loadApiKeys() or loadApiKeys(File)

Method Summary

Modifier and Type	Method and Description
RateRule[]	getRules()
TicketBucket	getTicketBucket(Region region) Gets the TicketBucket for the given Region.
static ApiKey[]	loadApiKeys() Read API keys in the file ./API_KEY.
static ApiKey[]	loadApiKeys(java.io.File file) Read API keys in the given file.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiKey

public ApiKey(java.lang.String key,
              RateRule... rules)

This constructor is exposed for convenience, but a better approach to creating ApiKey instances is to use loadApiKeys() or loadApiKeys(File)

Parameters:

key - the key string from your developer dashboard

rules - the rate rules associated with your key, also on your developer dashboard

Method Detail

getRules

public RateRule[] getRules()

Returns:

this ApiKey's RateRules

getTicketBucket

public TicketBucket getTicketBucket(Region region)

Gets the TicketBucket for the given Region. Creates one if it does not exist.

Parameters:

region - Region to retrieve

Returns:

a TicketBucket for this Region

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

loadApiKeys

public static ApiKey[] loadApiKeys()
                            throws java.io.FileNotFoundException

Read API keys in the file ./API_KEY. This method exists as a convenience for developers to load keys without command line or checking in API keys to source control

Returns:

list of ApiKey found in the ./API_KEY file

Throws:

java.io.FileNotFoundException - if the ./API_KEY file cannot be found

loadApiKeys

public static ApiKey[] loadApiKeys(java.io.File file)
                            throws java.io.FileNotFoundException

Read API keys in the given file. This method exists as a convenience for developers to load keys without command line or checking in API keys to source control

Parameters:

file - API key file to read

Returns:

list of ApiKey found in the specified file

Throws:

java.io.FileNotFoundException - if the specified file cannot be found