com.corelightservices.api

Class CLSApiContext

java.lang.Object

com.corelightservices.api.CLSApiContext

public class CLSApiContext
extends Object

Helper class for executing api requests. To instantiate CLSApiContext you will need an API Key. You can generate API Keys for your project at corelightservices.com.

Constructor Summary

Constructors

Constructor and Description
CLSApiContext(String apiKey) Constructor

Method Summary

Modifier and Type	Method and Description
CLSAchievementClaim	ClaimAchievement(String playerApiReference, String achievementApiReference) Convenience override for ClaimAchievement(playerApiReference, achievementApiReference, null)
CLSAchievementClaim	ClaimAchievement(String playerApiReference, String achievementApiReference, Double progress) Awards an event achievement to a player or updates progress on a progress achievement.
CLSAchievement	GetAchievement(String achievementApiReference) Requests information about a specific achievement.
List<CLSAchievementClaim>	GetAchievementClaims(String playerApiReference) Convenience override for GetAchievementClaims(playerApiReference, null)
List<CLSAchievementClaim>	GetAchievementClaims(String playerApiReference, String achievementApiReference) Requests achievement claims for a specific player.
List<CLSAchievement>	GetAchievements() Requests information about all achievements.
CLSPlayer	GetPlayer(String playerApiReference) Requests information about a specific player.
CLSProject	GetProject() Requests information about the project the API key was generated for.
CLSScoreboard	GetScoreboardResults(String scoreboardApiReference, int offset, int limit) Requests scoreboard results.
CLSScoreboard	GetScoreboardResults(String scoreboardApiReference, String playerApiReference, int offset, int limit) Requests scoreboard results for a specific player.
CLSScoreboardEntry	InsertScoreboardRecord(String scoreboardApiReference, CLSPlayer player, double value) Records a new scoreboard entry.
CLSScoreboardEntry	InsertScoreboardRecord(String scoreboardApiReference, String playerApiReference, double value) Records a new scoreboard entry.
CLSPlayer	RegisterPlayer() Registers a new player at CLS.
CLSPlayer	RegisterPlayer(String playerName) Registers a new player with username at CLS.
CLSPlayer	UpdatePlayer(CLSPlayer player, String playerName) Registers a new player at CLS.
CLSPlayer	UpdatePlayer(String playerApiReference, String playerName) Registers a new player at CLS.
boolean	ValidateKey() Checks the API key for validity.

Methods inherited from class java.lang.Object

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

Constructor Detail

CLSApiContext

public CLSApiContext(String apiKey)
              throws CLSInvalidApiKeyException

Constructor

Parameters:

apiKey - The projects API-Key

Throws:

CLSInvalidApiKeyException - if the provided api key is not a valid key

Method Detail

ValidateKey

public boolean ValidateKey()

Checks the API key for validity.

Returns:

True if API key is valid

GetProject

public CLSProject GetProject()
                      throws IOException,
                             CLSApiException

Requests information about the project the API key was generated for.

Returns:

The requestet project

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

GetPlayer

public CLSPlayer GetPlayer(String playerApiReference)
                    throws IOException,
                           CLSApiException

Requests information about a specific player.

Parameters:

playerApiReference - The CLS player api-reference

Returns:

The requestet player

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

RegisterPlayer

public CLSPlayer RegisterPlayer()
                         throws IOException,
                                CLSApiException

Registers a new player at CLS.

Returns:

The registered player

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

RegisterPlayer

public CLSPlayer RegisterPlayer(String playerName)
                         throws IOException,
                                CLSApiException

Registers a new player with username at CLS.

Parameters:

playerName - The players user name

Returns:

The registered player

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

UpdatePlayer

public CLSPlayer UpdatePlayer(String playerApiReference,
                              String playerName)
                       throws IOException,
                              CLSApiException

Registers a new player at CLS.

Parameters:

playerApiReference - The CLS player api-reference

playerName - The players new user name

Returns:

The updated player

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

UpdatePlayer

public CLSPlayer UpdatePlayer(CLSPlayer player,
                              String playerName)
                       throws IOException,
                              CLSApiException

Registers a new player at CLS.

Parameters:

player - The CLS player

playerName - The players new user name

Returns:

The updated player

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

GetScoreboardResults

public CLSScoreboard GetScoreboardResults(String scoreboardApiReference,
                                          int offset,
                                          int limit)
                                   throws IOException,
                                          CLSApiException

Requests scoreboard results.

Parameters:

scoreboardApiReference - The CLS scoreboard api-reference

limit - Defines the offset for the entry query (0 <= offset)

limit - Defines how many records should be queried (1 <= limit <= 1000)

Returns:

The requestet scoreboard including it's records

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

GetScoreboardResults

public CLSScoreboard GetScoreboardResults(String scoreboardApiReference,
                                          String playerApiReference,
                                          int offset,
                                          int limit)
                                   throws IOException,
                                          CLSApiException

Requests scoreboard results for a specific player.

Parameters:

scoreboardApiReference - The CLS scoreboard api-reference

playerApiReference - The CLS player api-reference

limit - Defines the offset for the entry query (0 < offset)

limit - Defines how many records should be queried (1 <= limit <= 1000)

Returns:

The requestet scoreboard including it's records

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

InsertScoreboardRecord

public CLSScoreboardEntry InsertScoreboardRecord(String scoreboardApiReference,
                                                 CLSPlayer player,
                                                 double value)
                                          throws IOException,
                                                 CLSApiException

Records a new scoreboard entry.

Parameters:

scoreboardApiReference - The CLS scoreboard api-reference

player - The CLS player that should be referenced by the record

value - The value of the scoreboard entry (eg. the players score)

Returns:

The created scoreboard entry

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

InsertScoreboardRecord

public CLSScoreboardEntry InsertScoreboardRecord(String scoreboardApiReference,
                                                 String playerApiReference,
                                                 double value)
                                          throws IOException,
                                                 CLSApiException

Records a new scoreboard entry.

Parameters:

scoreboardApiReference - The CLS scoreboard api-reference

playerApiReference - The api-reference of the CLS player that should be referenced by the record

value - The value of the scoreboard entry (eg. the players score)

Returns:

The created scoreboard entry

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

GetAchievement

public CLSAchievement GetAchievement(String achievementApiReference)
                              throws IOException,
                                     CLSApiException

Requests information about a specific achievement.

Parameters:

achievementApiReference - The CLS achievement api-reference

Returns:

The requestet achievement

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

GetAchievements

public List<CLSAchievement> GetAchievements()
                                     throws IOException,
                                            CLSApiException

Requests information about all achievements.

Returns:

The requestet achievement

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

GetAchievementClaims

public List<CLSAchievementClaim> GetAchievementClaims(String playerApiReference)
                                               throws IOException,
                                                      CLSApiException

Convenience override for GetAchievementClaims(playerApiReference, null)

Parameters:

playerApiReference - The CLS player api-reference

Returns:

The requestet achievement claims

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

GetAchievementClaims

public List<CLSAchievementClaim> GetAchievementClaims(String playerApiReference,
                                                      String achievementApiReference)
                                               throws IOException,
                                                      CLSApiException

Requests achievement claims for a specific player. When achievementApiReference is null, claims for all achievements are retrieved.

Parameters:

playerApiReference - The CLS player api-reference

achievementApiReference - The CLS achievement api-reference

Returns:

The requestet achievement claims

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

ClaimAchievement

public CLSAchievementClaim ClaimAchievement(String playerApiReference,
                                            String achievementApiReference)
                                     throws IOException,
                                            CLSApiException

Convenience override for ClaimAchievement(playerApiReference, achievementApiReference, null)

Parameters:

playerApiReference - The CLS player api-reference

achievementApiReference - The CLS achievement api-reference

Returns:

The requestet achievement claim

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response

ClaimAchievement

public CLSAchievementClaim ClaimAchievement(String playerApiReference,
                                            String achievementApiReference,
                                            Double progress)
                                     throws IOException,
                                            CLSApiException

Awards an event achievement to a player or updates progress on a progress achievement.

Parameters:

playerApiReference - The CLS player api-reference

achievementApiReference - The CLS achievement api-reference

progress - The progress that will be added to the current achievement progress (should be null for event achievements and greater than 0 for progress achievements)

Returns:

The requestet achievement claim

Throws:

IOException - if api request failed on a network level

CLSApiException - if the api reports an error or returns an invalid response