dk.netarkivet.viewerproxy
Interface Controller

All Known Implementing Classes:
DelegatingController, HTTPControllerClient

public interface Controller

The API for controlling the viewerproxy.


Method Summary
 void changeIndex(java.util.Set<java.lang.Long> jobList, java.lang.String label)
          Change current index to work on these jobs.
 void clearRecordedURIs()
          Clear collected URIs.
 java.util.Set<java.net.URI> getRecordedURIs()
          Get collected URIs.
 java.lang.String getStatus(java.util.Locale locale)
          Get current status of viewerproxy.
 void startRecordingURIs()
          Start URI collection.
 void stopRecordingURIs()
          Stop URI collection.
 

Method Detail

startRecordingURIs

void startRecordingURIs()
Start URI collection.


stopRecordingURIs

void stopRecordingURIs()
Stop URI collection.


clearRecordedURIs

void clearRecordedURIs()
Clear collected URIs.


getRecordedURIs

java.util.Set<java.net.URI> getRecordedURIs()
Get collected URIs.

Returns:
The collected URIs.

changeIndex

void changeIndex(java.util.Set<java.lang.Long> jobList,
                 java.lang.String label)
Change current index to work on these jobs.

Parameters:
jobList - The list of jobs.
label - A label this index should be known as

getStatus

java.lang.String getStatus(java.util.Locale locale)
Get current status of viewerproxy. The status is not supposed to be machine parsable. Do not base anything on the content of this status message, the format may change without notice.

Parameters:
locale - Indication of which locale to use for generating the string.
Returns:
A human-readable string with current status of the viewerproxy.