Request

java.lang.Object
- net.rithms.riot.api.request.Request

Direct Known Subclasses:

AsyncRequest
```
public class Request
extends java.lang.Object
```
This class is used to fire synchronous call at the Riot Api. You should not construct these requests manually. To fire synchronous requests, use a RiotApi object.

Author:

Daniel 'Linnun' Figge

See Also:

RiotApi

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CODE_ERROR_BAD_GATEWAY`
`static int`	`CODE_ERROR_BAD_REQUEST`
`static int`	`CODE_ERROR_FORBIDDEN`
`static int`	`CODE_ERROR_GATEWAY_TIMEOUT`
`static int`	`CODE_ERROR_METHOD_NOT_ALLOWED`
`static int`	`CODE_ERROR_NOT_FOUND`
`static int`	`CODE_ERROR_RATE_LIMITED`
`static int`	`CODE_ERROR_SERVER_ERROR`
`static int`	`CODE_ERROR_SERVICE_UNAVAILABLE`
`static int`	`CODE_ERROR_UNAUTHORIZED`
`static int`	`CODE_ERROR_UNPROCESSABLE_ENTITY`
`static int`	`CODE_ERROR_UNSUPPORTED_MEDIA_TYPE`
`static int`	`CODE_SUCCESS_NO_CONTENT`
`static int`	`CODE_SUCCESS_OK`

Constructor Summary

Constructors
Constructor and Description

Request(ApiConfig config, ApiMethod object)
Constructs a synchronous request

Constructors
Constructor and Description
`Request(ApiConfig config, ApiMethod object)` Constructs a synchronous request

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cancel()` Attempts to cancel the request.
`<T> T`	`getDto()` Retrieves the result of the request.
`RiotApiException`	`getException()` Returns the exception that was thrown when calling `execute()`.
`ApiMethod`	`getObject()` Returns the object defining the request
`RequestResponse`	`getResponse()` Returns the raw response from the Riot Api
`boolean`	`isCancelled()` Returns `true` if this request was cancelled before it completed normally.
`boolean`	`isDone()` Returns `true` if this request completed.
`boolean`	`isFailed()` Returns `true` if this request failed.
`boolean`	`isPending()` Returns `true` if this request is still waiting for a response from the Riot Api.
`boolean`	`isSuccessful()` Returns `true` if this request completed successfully.
`boolean`	`isTimeOut()` Returns `true` if this request timed out before it completed normally.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CODE_SUCCESS_OK
```
public static final int CODE_SUCCESS_OK
```
    See Also:
    
    Constant Field Values
  - CODE_SUCCESS_NO_CONTENT
```
public static final int CODE_SUCCESS_NO_CONTENT
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_BAD_REQUEST
```
public static final int CODE_ERROR_BAD_REQUEST
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_UNAUTHORIZED
```
public static final int CODE_ERROR_UNAUTHORIZED
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_FORBIDDEN
```
public static final int CODE_ERROR_FORBIDDEN
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_NOT_FOUND
```
public static final int CODE_ERROR_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_METHOD_NOT_ALLOWED
```
public static final int CODE_ERROR_METHOD_NOT_ALLOWED
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_UNSUPPORTED_MEDIA_TYPE
```
public static final int CODE_ERROR_UNSUPPORTED_MEDIA_TYPE
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_UNPROCESSABLE_ENTITY
```
public static final int CODE_ERROR_UNPROCESSABLE_ENTITY
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_RATE_LIMITED
```
public static final int CODE_ERROR_RATE_LIMITED
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_SERVER_ERROR
```
public static final int CODE_ERROR_SERVER_ERROR
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_BAD_GATEWAY
```
public static final int CODE_ERROR_BAD_GATEWAY
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_SERVICE_UNAVAILABLE
```
public static final int CODE_ERROR_SERVICE_UNAVAILABLE
```
    See Also:
    
    Constant Field Values
  - CODE_ERROR_GATEWAY_TIMEOUT
```
public static final int CODE_ERROR_GATEWAY_TIMEOUT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Request
```
public Request(ApiConfig config,
               ApiMethod object)
        throws RateLimitException,
               RiotApiException
```
    Constructs a synchronous request
    
    Parameters:
    
    config - Configuration to use
    
    method - Api method to call
    
    Throws:
    
    RateLimitException
    
    RiotApiException
    
    See Also:
    
    ApiConfig, ApiMethod
- Method Detail
  - cancel
```
public boolean cancel()
```
    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.
    
    Returns:
    
    false if the request could not be cancelled, typically because it has already completed normally; true otherwise
  - getDto
```
public <T> T getDto()
             throws RiotApiException,
                    RateLimitException
```
    Retrieves the result of the request.
    
    Returns:
    
    The object returned by the api call
    
    Throws:
    
    java.lang.IllegalStateException - If this request did not complete yet or did not succeed
    
    RiotApiException - If parsing the Riot Api's response fails
    
    RateLimitException
  - getException
```
public RiotApiException getException()
```
    Returns the exception that was thrown when calling execute().
    
    Returns:
    
    The exception that was thrown when executing this request
  - getObject
```
public ApiMethod getObject()
```
    Returns the object defining the request
    
    Returns:
    
    An ApiMethod object
    
    See Also:
    
    ApiMethod
  - getResponse
```
public RequestResponse getResponse()
```
    Returns the raw response from the Riot Api
    
    Returns:
    
    A RequestResponse object, providing raw data of the Riot Api's response
    
    See Also:
    
    RequestResponse
  - isCancelled
```
public boolean isCancelled()
```
    Returns true if this request was cancelled before it completed normally.
    
    Returns:
    
    true if this request was cancelled before it completed
  - isDone
```
public boolean isDone()
```
    Returns true if this request completed. Completion may be due to normal termination, an exception, cancellation or timing out -- in all of these cases, this method will return true.
    
    Returns:
    
    true if this request completed
  - isFailed
```
public boolean isFailed()
```
    Returns true if this request failed.
    
    Returns:
    
    true if this request failed
  - isPending
```
public boolean isPending()
```
    Returns true if this request is still waiting for a response from the Riot Api.
    
    Returns:
    
    true if this request is still waiting for a response
  - isSuccessful
```
public boolean isSuccessful()
```
    Returns true if this request completed successfully.
    
    Returns:
    
    true if this request completed successfully
  - isTimeOut
```
public boolean isTimeOut()
```
    Returns true if this request timed out before it completed normally.
    
    Returns:
    
    true if this request timed out before it completed

Class Request

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CODE_SUCCESS_OK

CODE_SUCCESS_NO_CONTENT

CODE_ERROR_BAD_REQUEST

CODE_ERROR_UNAUTHORIZED

CODE_ERROR_FORBIDDEN

CODE_ERROR_NOT_FOUND

CODE_ERROR_METHOD_NOT_ALLOWED

CODE_ERROR_UNSUPPORTED_MEDIA_TYPE

CODE_ERROR_UNPROCESSABLE_ENTITY

CODE_ERROR_RATE_LIMITED

CODE_ERROR_SERVER_ERROR

CODE_ERROR_BAD_GATEWAY

CODE_ERROR_SERVICE_UNAVAILABLE

CODE_ERROR_GATEWAY_TIMEOUT

Constructor Detail

Request

Method Detail

cancel

getDto

getException

getObject

getResponse

isCancelled

isDone

isFailed

isPending

isSuccessful

isTimeOut