Package gov.nasa.worldwind.retrieve
Class BasicRetrievalService
- java.lang.Object
-
- gov.nasa.worldwind.avlist.AVListImpl
-
- gov.nasa.worldwind.WWObjectImpl
-
- gov.nasa.worldwind.retrieve.BasicRetrievalService
-
- All Implemented Interfaces:
AVList
,MessageListener
,RetrievalService
,WWObject
,java.beans.PropertyChangeListener
,java.lang.Thread.UncaughtExceptionHandler
,java.util.EventListener
public final class BasicRetrievalService extends WWObjectImpl implements RetrievalService, java.lang.Thread.UncaughtExceptionHandler
Performs threaded retrieval of data.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface gov.nasa.worldwind.retrieve.RetrievalService
RetrievalService.SSLExceptionListener
-
-
Field Summary
Fields Modifier and Type Field Description protected RetrievalService.SSLExceptionListener
sslExceptionListener
-
Constructor Summary
Constructors Constructor Description BasicRetrievalService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
contains(Retriever retriever)
int
getNumRetrieversPending()
double
getProgress()
int
getRetrieverPoolSize()
RetrievalService.SSLExceptionListener
getSSLExceptionListener()
Indicates the listener to be called whenSSLHandshakeException
s are thrown during resource retrieval.boolean
hasActiveTasks()
boolean
isAvailable()
RetrievalFuture
runRetriever(Retriever retriever)
RetrievalFuture
runRetriever(Retriever retriever, double priority)
void
setRetrieverPoolSize(int poolSize)
void
setSSLExceptionListener(RetrievalService.SSLExceptionListener sslExceptionListener)
Specifies the listener called when aSSLHandshakeException
is thrown during resource retrieval.void
shutdown(boolean immediately)
void
uncaughtException(java.lang.Thread thread, java.lang.Throwable throwable)
-
Methods inherited from class gov.nasa.worldwind.WWObjectImpl
onMessage, propertyChange
-
Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getBooleanValue, getBooleanValue, getChangeSupport, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getRestorableStateForAVPair, getStringValue, getStringValue, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues
-
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface gov.nasa.worldwind.avlist.AVList
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues
-
Methods inherited from interface gov.nasa.worldwind.event.MessageListener
onMessage
-
-
-
-
Field Detail
-
sslExceptionListener
protected RetrievalService.SSLExceptionListener sslExceptionListener
-
-
Method Detail
-
getSSLExceptionListener
public RetrievalService.SSLExceptionListener getSSLExceptionListener()
Description copied from interface:RetrievalService
Indicates the listener to be called whenSSLHandshakeException
s are thrown during resource retrieval.- Specified by:
getSSLExceptionListener
in interfaceRetrievalService
- Returns:
- the exception listener, or null if no listener has been specified.
-
setSSLExceptionListener
public void setSSLExceptionListener(RetrievalService.SSLExceptionListener sslExceptionListener)
Description copied from interface:RetrievalService
Specifies the listener called when aSSLHandshakeException
is thrown during resource retrieval.- Specified by:
setSSLExceptionListener
in interfaceRetrievalService
- Parameters:
sslExceptionListener
- to listener to invoke, or null if no listener is to be invoked.
-
uncaughtException
public void uncaughtException(java.lang.Thread thread, java.lang.Throwable throwable)
- Specified by:
uncaughtException
in interfacejava.lang.Thread.UncaughtExceptionHandler
-
shutdown
public void shutdown(boolean immediately)
- Specified by:
shutdown
in interfaceRetrievalService
-
runRetriever
public RetrievalFuture runRetriever(Retriever retriever)
- Specified by:
runRetriever
in interfaceRetrievalService
- Parameters:
retriever
- the retriever to run- Returns:
- a future object that can be used to query the request status of cancel the request.
- Throws:
java.lang.IllegalArgumentException
- ifretriever
is null or has no name
-
runRetriever
public RetrievalFuture runRetriever(Retriever retriever, double priority)
- Specified by:
runRetriever
in interfaceRetrievalService
- Parameters:
retriever
- the retriever to runpriority
- the secondary priority of the retriever, or negative if it is to be the primary priority- Returns:
- a future object that can be used to query the request status of cancel the request.
- Throws:
java.lang.IllegalArgumentException
- ifretriever
is null or has no name
-
setRetrieverPoolSize
public void setRetrieverPoolSize(int poolSize)
- Specified by:
setRetrieverPoolSize
in interfaceRetrievalService
- Parameters:
poolSize
- the number of threads in the thread pool- Throws:
java.lang.IllegalArgumentException
- ifpoolSize
is non-positive
-
getRetrieverPoolSize
public int getRetrieverPoolSize()
- Specified by:
getRetrieverPoolSize
in interfaceRetrievalService
-
hasActiveTasks
public boolean hasActiveTasks()
- Specified by:
hasActiveTasks
in interfaceRetrievalService
-
isAvailable
public boolean isAvailable()
- Specified by:
isAvailable
in interfaceRetrievalService
-
getNumRetrieversPending
public int getNumRetrieversPending()
- Specified by:
getNumRetrieversPending
in interfaceRetrievalService
-
contains
public boolean contains(Retriever retriever)
- Specified by:
contains
in interfaceRetrievalService
- Parameters:
retriever
- the retriever to check- Returns:
true
if the retriever is being run or pending execution- Throws:
java.lang.IllegalArgumentException
- ifretriever
is null
-
getProgress
public double getProgress()
-
-