Package com.xero.api

Class XeroRateLimitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.xero.api.XeroException

com.xero.api.XeroRateLimitException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

XeroAppMinuteRateLimitException, XeroDailyRateLimitException, XeroMinuteRateLimitException

public class XeroRateLimitException
extends XeroException

Base application exception all other rate limit Xero exceptions should extend

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
XeroRateLimitException(int statusCode, Integer appLimitRemaining, Integer dayLimitRemaining, Integer minuteLimitRemaining, Long retryAfterSeconds, String message, Exception e)	Init XeroRateLimitException

Method Summary

Modifier and Type	Method	Description
Integer	getAppLimitRemaining()	get remaining app limit
Integer	getDayLimitRemaining()	get remaining daily limit
String	getMessage()	get message
Integer	getMinuteLimitRemaining()	get remaining minute limit
Long	getRetryAfterSeconds()	get retry after seconds
int	getStatusCode()	get Status Code

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

XeroRateLimitException

public XeroRateLimitException(int statusCode,
 Integer appLimitRemaining,
 Integer dayLimitRemaining,
 Integer minuteLimitRemaining,
 Long retryAfterSeconds,
 String message,
 Exception e)

Init XeroRateLimitException

Parameters:

statusCode - int the server status code returned.

appLimitRemaining - Integer the number of calls remaining for app limit

dayLimitRemaining - Integer the number of calls in a 24 hour rolling window remain for an org

minuteLimitRemaining - Integer the number of calls in a 60 second rolling window remain for an org

retryAfterSeconds - Long the number of seconds to wait before resuming API calls

message - String the message pertaining to the rate limit

e - Exception object with details about the original exception

Method Details

getStatusCode

public int getStatusCode()

get Status Code

Returns:

int with server status code.

getMessage

public String getMessage()

get message

Overrides:

getMessage in class Throwable

Returns:

Sting with the message pertaining to the rate limit

getAppLimitRemaining

public Integer getAppLimitRemaining()

get remaining app limit

Returns:

Integer the number of calls remaining for app limit

getDayLimitRemaining

public Integer getDayLimitRemaining()

get remaining daily limit

Returns:

Integer the number of calls in a 24 hour rolling window remain for an org

getMinuteLimitRemaining

public Integer getMinuteLimitRemaining()

get remaining minute limit

Returns:

Integer the number of calls in a 60 second rolling window remain for an org

getRetryAfterSeconds

public Long getRetryAfterSeconds()

get retry after seconds

Returns:

Long the number of seconds to wait before resuming API calls