net.rithms.riot.api.request

Class AsyncRequest

java.lang.Object

net.rithms.riot.api.request.Request

net.rithms.riot.api.request.AsyncRequest

All Implemented Interfaces:

java.lang.Runnable

public class AsyncRequest
extends Request
implements java.lang.Runnable

This class is used to fire asynchronous call at the Riot Api. You should not construct these requests manually. To fire asynchronous requests, use a RiotApiAsync object.

Author:

Daniel 'Linnun' Figge

See Also:

RiotApiAsync

Field Summary

Fields inherited from class net.rithms.riot.api.request.Request

CODE_ERROR_BAD_GATEWAY, CODE_ERROR_BAD_REQUEST, CODE_ERROR_FORBIDDEN, CODE_ERROR_GATEWAY_TIMEOUT, CODE_ERROR_METHOD_NOT_ALLOWED, CODE_ERROR_NOT_FOUND, CODE_ERROR_RATE_LIMITED, CODE_ERROR_SERVER_ERROR, CODE_ERROR_SERVICE_UNAVAILABLE, CODE_ERROR_UNAUTHORIZED, CODE_ERROR_UNPROCESSABLE_ENTITY, CODE_ERROR_UNSUPPORTED_MEDIA_TYPE, CODE_SUCCESS_NO_CONTENT, CODE_SUCCESS_OK

Constructor Summary

Constructors

Constructor and Description
AsyncRequest(ApiConfig config, ApiMethod object) Constructs an asynchronous request

Method Summary

Modifier and Type	Method and Description
void	addListeners(RequestListener... listeners) Adds one or more RequestListener to this request
void	await() Waits indefinitely until the request completes.
void	await(long timeout, java.util.concurrent.TimeUnit unit) Waits for at most the given time until the request completes.
void	await(long timeout, java.util.concurrent.TimeUnit unit, boolean cancelOnTimeout) Waits for at most the given time until the request completes.
boolean	cancel() Attempts to cancel the request.
void	execute() Executes the request
<T> T	getDto() Retrieves the request's result.
<T> T	getDtoAndThrowException() Retrieves the request's result.
boolean	isSent() Returns true if this request has started execution
void	removeAllListeners() Removes all RequestListener from this request
void	removeListener(RequestListener listeners) Removes one or more RequestListener from this request
void	run()

Methods inherited from class net.rithms.riot.api.request.Request

getException, getObject, getResponse, isCancelled, isDone, isFailed, isPending, isSuccessful, isTimeOut

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncRequest

public AsyncRequest(ApiConfig config,
                    ApiMethod object)

Constructs an asynchronous request

Parameters:

config - Configuration to use

method - Api method to call

See Also:

ApiConfig, ApiMethod

Method Detail

addListeners

public void addListeners(RequestListener... listeners)

Adds one or more RequestListener to this request

Parameters:

listeners - One or more request listeners

See Also:

RequestListener

await

public void await()
           throws java.lang.InterruptedException

Waits indefinitely until the request completes.

If the thread is interrupted while waiting for the request to complete, this method will throw an InterruptedException and the thread's interrupt flag will be cleared.

Please note that this method is blocking and thus negates the advantage of the asynchronous nature of this class. Consider using a RequestListener instead.

Throws:

java.lang.InterruptedException - If the method is interrupted by calling Thread.interrupt(). The interrupt flag will be cleared

await

public void await(long timeout,
                  java.util.concurrent.TimeUnit unit)
           throws java.lang.InterruptedException,
                  java.util.concurrent.TimeoutException

Waits for at most the given time until the request completes.

If the thread is interrupted while waiting for the request to complete, this method will throw an InterruptedException and the thread's interrupt flag will be cleared.

Please note that this method is blocking and thus negates the advantage of the asynchronous nature of this class. Consider using a RequestListener instead.

Parameters:

timeout - The maximum amount of the given time unit to wait

unit - The time unit of the timeout argument

Throws:

java.lang.InterruptedException - If the method is interrupted by calling Thread.interrupt(). The interrupt flag will be cleared

java.util.concurrent.TimeoutException - If the given time elapsed without the request completing

await

public void await(long timeout,
                  java.util.concurrent.TimeUnit unit,
                  boolean cancelOnTimeout)
           throws java.lang.InterruptedException,
                  java.util.concurrent.TimeoutException

Waits for at most the given time until the request completes.

If the thread is interrupted while waiting for the request to complete, this method will throw an InterruptedException and the thread's interrupt flag will be cleared.

Please note that this method is blocking and thus negates the advantage of the asynchronous nature of this class. Consider using a RequestListener instead.

Parameters:

timeout - The maximum amount of the given time unit to wait

unit - The time unit of the timeout argument

cancelOnTimeout - Whether or not the request should be cancelled, if the given timeout is elapsed without the request completing

Throws:

java.lang.InterruptedException - If the method is interrupted by calling Thread.interrupt(). The interrupt flag will be cleared

java.util.concurrent.TimeoutException - If the given time elapsed without the request completing

cancel

public boolean cancel()

Description copied from class: Request

Attempts to cancel the request. This attempt will fail if the request has already been completed, or could not be cancelled for some other reason. If successful, and this request has not started when cancel is called, this request should never run.

Overrides:

cancel in class Request

Returns:

false if the request could not be cancelled, typically because it has already completed normally; true otherwise

execute

public void execute()

Description copied from class: Request

Executes the request

getDto

public <T> T getDto()

Retrieves the request's result. If an exception would be thrown, it is swallowed, since you should only call this method, if the request succeeded.

If you want this method to throw exceptions, please use getDtoAndThrowException() instead.

Overrides:

getDto in class Request

Returns:

The object returned by the api call, or null if the request did not finish yet

getDtoAndThrowException

public <T> T getDtoAndThrowException()
                              throws RiotApiException

Retrieves the request's result. If an exception occures, it is thrown.

If you do not want this method to throw exceptions, please use getDto() instead.

Returns:

The object returned by the api call, or null if the request did not finish yet

Throws:

RiotApiException - If an exception occurs while parsing the Riot Api's response

isSent

public boolean isSent()

Returns true if this request has started execution

Returns:

true if this request has started execution

removeAllListeners

public void removeAllListeners()

Removes all RequestListener from this request

See Also:

RequestListener

removeListener

public void removeListener(RequestListener listeners)

Removes one or more RequestListener from this request

Parameters:

listener - One or more listeners to remove

See Also:

RequestListener

run

public void run()

Specified by:

run in interface java.lang.Runnable