com.github.agadar.nsapi.query

Class VerifyQuery

java.lang.Object

com.github.agadar.nsapi.query.blueprint.AbstractQuery<Q,R>

com.github.agadar.nsapi.query.blueprint.APIQuery<VerifyQuery,Boolean>

com.github.agadar.nsapi.query.VerifyQuery

public final class VerifyQuery
extends APIQuery<VerifyQuery,Boolean>

A query to the NationStates API's utility resource, verifying a user. Users can retrieve their code at https://www.nationstates.net/page=verify_login.

Author:

Agadar (https://github.com/Agadar/)

Field Summary

Fields inherited from class com.github.agadar.nsapi.query.blueprint.APIQuery

rateLimiter, resourceValue

Fields inherited from class com.github.agadar.nsapi.query.blueprint.AbstractQuery

logger

Constructor Summary

Constructors

Constructor and Description
VerifyQuery(String nation, String code) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
protected String	resourceString() Gives the resource string of this Query, e.g.
VerifyQuery	token(String token) Use an application-specific token.
protected <T extends Boolean> T	translateResponse(InputStream response, Class<T> type) Translates the stream response to the object this Query wishes to return via its execute() function.
protected void	validateQueryParameters() Validates the query parameters before executing the query.

Methods inherited from class com.github.agadar.nsapi.query.blueprint.APIQuery

execute, getRateLimiter, slowMode

Methods inherited from class com.github.agadar.nsapi.query.blueprint.AbstractQuery

closeInputStreamQuietly, execute, makeRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

VerifyQuery

public VerifyQuery(String nation,
                   String code)

Constructor.

Parameters:

nation - the nation to verify

code - the verification code

Method Detail

token

public final VerifyQuery token(String token)

Use an application-specific token. If a token is set, then users can retrieve their code at https://www.nationstates.net/page=verify_login?token=(Your token) instead.

Parameters:

token - application-specific token

Returns:

this

resourceString

protected String resourceString()

Description copied from class: APIQuery

Gives the resource string of this Query, e.g. 'nation', 'region', etc.

Specified by:

resourceString in class APIQuery<VerifyQuery,Boolean>

Returns:

the resource string of this Query

validateQueryParameters

protected void validateQueryParameters()

Description copied from class: AbstractQuery

Validates the query parameters before executing the query. If the query parameters are invalid, an exception is thrown. Child classes will want to override this class (making sure to still call super.validateQueryParameters()) if they have additional parameters to validate.

Overrides:

validateQueryParameters in class APIQuery<VerifyQuery,Boolean>

translateResponse

protected <T extends Boolean> T translateResponse(InputStream response,
                                                  Class<T> type)

Description copied from class: AbstractQuery

Translates the stream response to the object this Query wishes to return via its execute() function. The standard way to translate is via JAXB, which assumes the stream is in a valid XML-format. Child classes might want to override this function if they wish to return primitives or something else.

Overrides:

translateResponse in class AbstractQuery<VerifyQuery,Boolean>

Type Parameters:

T - type to parse to

Parameters:

response - the response to translate

type - type to parse to

Returns:

the translated response

buildURL

protected String buildURL()

Description copied from class: AbstractQuery

Generates a String URL based on the supplied values. Subclasses might want to override this method to build the String URL further to accommodate for additional shards/modes/options/etc.

Overrides:

buildURL in class APIQuery<VerifyQuery,Boolean>

Returns:

the generated String URL