org.lockss.ws.status

Interface DaemonStatusService

All Known Implementing Classes:

DaemonStatusServiceImpl

public interface DaemonStatusService

The Daemon Status SOAP web service interface.

Method Summary

Modifier and Type	Method and Description
Collection<IdNamePair>	getAuIds() Provides a list of the identifier/name pairs of the archival units in the system.
AuStatus	getAuStatus(String auId) Provides the status information of an archival unit in the system.
List<String>	getAuUrls(String auId, String url) Provides the URLs in an archival unit.
PlatformConfigurationWsResult	getPlatformConfiguration() Provides the platform configuration.
boolean	isDaemonReady() Provides an indication of whether the daemon is ready.
List<AuWsResult>	queryAus(String auQuery) Provides the selected properties of selected archival units in the system.
List<CrawlWsResult>	queryCrawls(String crawlQuery) Provides the selected properties of selected crawls in the system.
List<PeerWsResult>	queryPeers(String peerQuery) Provides the selected properties of selected peers in the system.
List<PluginWsResult>	queryPlugins(String pluginQuery) Provides the selected properties of selected plugins in the system.
List<PollWsResult>	queryPolls(String pollQuery) Provides the selected properties of selected polls in the system.
List<RepositoryWsResult>	queryRepositories(String repositoryQuery) Provides the selected properties of selected repositories in the system.
List<RepositorySpaceWsResult>	queryRepositorySpaces(String repositorySpaceQuery) Provides the selected properties of selected repository spaces in the system.
List<TdbAuWsResult>	queryTdbAus(String tdbAuQuery) Provides the selected properties of selected title database archival units.
List<TdbPublisherWsResult>	queryTdbPublishers(String tdbPublisherQuery) Provides the selected properties of selected title database publishers.
List<TdbTitleWsResult>	queryTdbTitles(String tdbTitleQuery) Provides the selected properties of selected title database titles.
List<VoteWsResult>	queryVotes(String voteQuery) Provides the selected properties of selected votes in the system.

Method Detail

isDaemonReady

boolean isDaemonReady()
               throws LockssWebServicesFault

Provides an indication of whether the daemon is ready.

Returns:

a boolean with the indication.

Throws:

LockssWebServicesFault - if there are problems.

getAuIds

Collection<IdNamePair> getAuIds()
                         throws LockssWebServicesFault

Provides a list of the identifier/name pairs of the archival units in the system.

Returns:

a List<IdNamePair> with the identifier/name pairs of the archival units in the system.

Throws:

LockssWebServicesFault - if there are problems.

getAuStatus

AuStatus getAuStatus(String auId)
              throws LockssWebServicesFault

Provides the status information of an archival unit in the system.

Parameters:

auId - A String with the identifier of the archival unit.

Returns:

an AuStatus with the status information of the archival unit.

Throws:

LockssWebServicesFault - if there are problems.

queryPlugins

List<PluginWsResult> queryPlugins(String pluginQuery)
                           throws LockssWebServicesFault

Provides the selected properties of selected plugins in the system.

Parameters:

pluginQuery - A String with the SQL-like query used to specify what properties to retrieve from which plugins.

Returns:

a List<PluginWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryAus

List<AuWsResult> queryAus(String auQuery)
                   throws LockssWebServicesFault

Provides the selected properties of selected archival units in the system.

Parameters:

auQuery - A String with the SQL-like query used to specify what properties to retrieve from which archival units.

Returns:

a List<AuWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryPeers

List<PeerWsResult> queryPeers(String peerQuery)
                       throws LockssWebServicesFault

Provides the selected properties of selected peers in the system.

Parameters:

peerQuery - A String with the SQL-like query used to specify what properties to retrieve from which peers.

Returns:

a List<PeerWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryVotes

List<VoteWsResult> queryVotes(String voteQuery)
                       throws LockssWebServicesFault

Provides the selected properties of selected votes in the system.

Parameters:

voteQuery - A String with the SQL-like query used to specify what properties to retrieve from which votes.

Returns:

a List<VotelWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryRepositorySpaces

List<RepositorySpaceWsResult> queryRepositorySpaces(String repositorySpaceQuery)
                                             throws LockssWebServicesFault

Provides the selected properties of selected repository spaces in the system.

Parameters:

repositorySpaceQuery - A String with the SQL-like query used to specify what properties to retrieve from which repository spaces.

Returns:

a List<RepositorySpaceWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryRepositories

List<RepositoryWsResult> queryRepositories(String repositoryQuery)
                                    throws LockssWebServicesFault

Provides the selected properties of selected repositories in the system.

Parameters:

repositoryQuery - A String with the SQL-like query used to specify what properties to retrieve from which repositories.

Returns:

a List<RepositoryWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryCrawls

List<CrawlWsResult> queryCrawls(String crawlQuery)
                         throws LockssWebServicesFault

Provides the selected properties of selected crawls in the system.

Parameters:

crawlQuery - A String with the SQL-like query used to specify what properties to retrieve from which crawls.

Returns:

a List<CrawlWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryPolls

List<PollWsResult> queryPolls(String pollQuery)
                       throws LockssWebServicesFault

Provides the selected properties of selected polls in the system.

Parameters:

pollQuery - A String with the SQL-like query used to specify what properties to retrieve from which polls.

Returns:

a List<PollWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

getPlatformConfiguration

PlatformConfigurationWsResult getPlatformConfiguration()
                                                throws LockssWebServicesFault

Provides the platform configuration.

Returns:

a PlatformConfigurationWsResult with the platform configuration.

Throws:

LockssWebServicesFault - if there are problems.

queryTdbPublishers

List<TdbPublisherWsResult> queryTdbPublishers(String tdbPublisherQuery)
                                       throws LockssWebServicesFault

Provides the selected properties of selected title database publishers.

Parameters:

tdbPublisherQuery - A String with the SQL-like query used to specify what properties to retrieve from which title database publishers.

Returns:

a List<TdbPublisherWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryTdbTitles

List<TdbTitleWsResult> queryTdbTitles(String tdbTitleQuery)
                               throws LockssWebServicesFault

Provides the selected properties of selected title database titles.

Parameters:

tdbTitleQuery - A String with the SQL-like query used to specify what properties to retrieve from which title database titles.

Returns:

a List<TdbTitleWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

queryTdbAus

List<TdbAuWsResult> queryTdbAus(String tdbAuQuery)
                         throws LockssWebServicesFault

Provides the selected properties of selected title database archival units.

Parameters:

tdbAuQuery - A String with the SQL-like query used to specify what properties to retrieve from which title database archival units.

Returns:

a List<TdbAuWsResult> with the results.

Throws:

LockssWebServicesFault - if there are problems.

getAuUrls

List<String> getAuUrls(String auId,
                       String url)
                throws LockssWebServicesFault

Provides the URLs in an archival unit.

Parameters:

auId - A String with the identifier of the archival unit.

url - A String with the URL above which no results will be provided, or NULL if all the URLS are to be provided.

Returns:

a List<String> with the results.

Throws:

LockssWebServicesFault - if there are problems.