com.socrata.exceptions

Class LongRunningQueryException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.socrata.exceptions.LongRunningQueryException

All Implemented Interfaces:

Serializable

public class LongRunningQueryException
extends Exception

Thrown if an operation takes a long time, and needs to be completed asynchronously. In this case, a GET operation of the location will be able to check for the tasks completion. There are two basic mechanisms Socrata uses for returning "future" results:

1. Location and Retry-After are returned as headers, and the caller should go back to the URL denoted in Location for getting the future result.
2. There is a ticket parameter in the body of the response. In this case, the ticket should be added to the calling URL as a parameter to retry.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
URI	location
String	ticket
long	timeToRetry

Constructor Summary

Constructors

Constructor and Description
LongRunningQueryException(URI location, long timeToRetry, String ticket)

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

Field Detail

location

public final URI location

timeToRetry

public final long timeToRetry

ticket

public final String ticket

Constructor Detail

LongRunningQueryException

public LongRunningQueryException(@Nullable
                         URI location,
                         long timeToRetry,
                         @Nullable
                         String ticket)

Parameters:

location - The URL to go to for getting the future result. If this is null, use the ticket parameter to construct a URL.

timeToRetry - The time in milliseconds to wait until retrying.

ticket - the ticket to use for polling for the future results. This should ONLY be used in location is null.