public interface OAIRepository extends OAIObject, org.apache.avalon.framework.configuration.Configurable
This class is a SAX base repository build open Cocoon's XMLPipe interface. SAX events are generated when methods corresponding to OAI verbs are called and sent to the appropriate consumer.
NOTE: the element corresponding to the verb name should be provided by these methods as in the sax stream if parameters are verified before response generation error elements will appear in the oai response and not within the verb response.
The SAX output is currently OAI-PMH 2.0 conformant.
OAIObject.Node
HTTP_HEADER_NAME_FROM, HTTP_HEADER_NAME_USER_AGENT, NUMBER_RECORDS_PER_RESPONSE, STRING_DATEFORMAT_GRANULARITY_DAY, STRING_DATEFORMAT_GRANULARITY_SECOND
Modifier and Type | Method and Description |
---|---|
void |
addDeletedRecord(java.lang.String id)
Adds a oai deleted record entry TO the repository
|
java.lang.String[] |
getAdminEmails()
Required element within a response from a repository queried with the "Identify" verb
|
java.lang.String |
getBaseURL() |
java.lang.String |
getCompression() |
java.lang.String |
getDeletedRecord() |
void |
getDescription(org.xml.sax.ContentHandler handler)
Sends the description xml for the repository to the provided content handler
|
java.lang.String |
getEarliestDatestamp() |
java.lang.String |
getGranularity() |
java.lang.String |
getProtocolVersion() |
void |
getRecord(OAIRequest request)
Send's xml data via SAX events to the Consumer, etc. see Cocoon's XMLProducer interface
|
java.lang.String |
getRepositoryName() |
java.lang.String |
getResumptionToken() |
void |
identify(OAIRequest request)
Send's xml data via SAX events to the Consumer, etc. see Cocoon's XMLProducer interface
|
void |
listIdentifiers(OAIRequest request)
Send's xml data via SAX events to the Consumer, etc. see Cocoon's XMLProducer interface
|
void |
listMetadataFormats(OAIRequest request)
Send's xml data via SAX events to the Consumer, etc. see Cocoon's XMLProducer interface
|
void |
listRecords(OAIRequest request)
Send's xml data via SAX events to the Consumer, etc. see Cocoon's XMLProducer interface
|
void |
listSets(OAIRequest request)
Send's xml data via SAX events to the Consumer, etc. see Cocoon's XMLProducer interface
|
void |
purgeDeletedRecords()
Deletes all deleted records FROM the repository
|
void |
removeDeletedRecord(java.lang.String id)
Removes a oai deleted record entry FROM the repository
|
boolean |
verifyParameters(OAIRequest request)
Verifies the request parameters respective of the
verb provided in the request and the repository's
level of support for certain optional features
like "resumptionToken"s and "set"s
note this method should return SAX events to any
XMLConsumer set if errors exist within the request parameters
|
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping
void getRecord(OAIRequest request) throws org.xml.sax.SAXException
request
- org.xml.sax.SAXException
void identify(OAIRequest request) throws org.xml.sax.SAXException
request
- org.xml.sax.SAXException
java.lang.String getGranularity()
java.lang.String getRepositoryName()
java.lang.String getEarliestDatestamp()
java.lang.String getDeletedRecord()
java.lang.String getProtocolVersion()
java.lang.String getBaseURL()
java.lang.String getResumptionToken()
java.lang.String[] getAdminEmails()
java.lang.String getCompression()
void getDescription(org.xml.sax.ContentHandler handler) throws org.xml.sax.SAXException
handler
- The handler to feed with eventsorg.xml.sax.SAXException
void listIdentifiers(OAIRequest request) throws org.xml.sax.SAXException
request
- org.xml.sax.SAXException
void listMetadataFormats(OAIRequest request) throws org.xml.sax.SAXException
request
- org.xml.sax.SAXException
void listRecords(OAIRequest request) throws org.xml.sax.SAXException
request
- org.xml.sax.SAXException
void listSets(OAIRequest request) throws org.xml.sax.SAXException
request
- org.xml.sax.SAXException
boolean verifyParameters(OAIRequest request) throws org.xml.sax.SAXException
request
- The request objecorg.xml.sax.SAXException
void removeDeletedRecord(java.lang.String id) throws SDXException
id
- The id of the record to removeSDXException
void addDeletedRecord(java.lang.String id) throws SDXException
id
- The id of the record to removeSDXException
void purgeDeletedRecords()
Copyright © 2000-2010 Ministere de la culture et de la communication / AJLSM. All Rights Reserved.