Package org.javastro.ivoa.registry.oaipmh.client

Interface OaiPMHClientInterface

@RegisterRestClient
@Produces({"text/xml","application/xml","*/*"})
public interface OaiPMHClientInterface

An interface for a REST client that interacts with an OAI-PMH (Open Archives Initiative Protocol for Metadata Harvesting) service. This interface defines methods corresponding to the various OAI-PMH verbs, allowing clients to perform operations such as identifying the repository, listing metadata formats, sets, identifiers, records, and retrieving specific records. The methods return a CompletionStage of String, indicating that the responses are handled asynchronously.

Method Summary

Modifier and Type	Method	Description
CompletionStage<String>	getRecord(String identifier, String metadataPrefix)
CompletionStage<String>	identify()
CompletionStage<String>	listIdentifiers(String metadataPrefix, String from, String until, String set, String resumptionToken)
CompletionStage<String>	listMetadataFormats(String identifier)
CompletionStage<String>	listRecords(String metadataPrefix, String from, String until, String set, String resumptionToken)
CompletionStage<String>	listSets()

Method Details

identify

@GET
@ClientQueryParam(name="verb",
                  value="Identify")
CompletionStage<String> identify()

listMetadataFormats

@GET
@ClientQueryParam(name="verb",
                  value="ListMetadataFormats")
CompletionStage<String> listMetadataFormats(@QueryParam("identifier")
 String identifier)

listSets

@GET
@ClientQueryParam(name="verb",
                  value="ListSets")
CompletionStage<String> listSets()

listIdentifiers

@GET
@ClientQueryParam(name="verb",
                  value="ListIdentifiers")
CompletionStage<String> listIdentifiers(@QueryParam("metadataPrefix")
 String metadataPrefix,
 @QueryParam("from")
 String from,
 @QueryParam("until")
 String until,
 @QueryParam("set")
 String set,
 @QueryParam("resumptionToken")
 String resumptionToken)

listRecords

@GET
@ClientQueryParam(name="verb",
                  value="ListRecords")
CompletionStage<String> listRecords(@QueryParam("metadataPrefix")
 String metadataPrefix,
 @QueryParam("from")
 String from,
 @QueryParam("until")
 String until,
 @QueryParam("set")
 String set,
 @QueryParam("resumptionToken")
 String resumptionToken)

getRecord

@GET
@ClientQueryParam(name="verb",
                  value="GetRecord")
CompletionStage<String> getRecord(@QueryParam("identifier")
 String identifier,
 @QueryParam("metadataPrefix")
 String metadataPrefix)