org.purl.sword.server
Interface SWORDServer

All Known Implementing Classes:

DSpaceSWORDServer, DummyServer

public interface SWORDServer

An abstract interface to be implemented by repositories wishing to provide a SWORD compliant service. http://www.ukoln.ac.uk/repositories/digirep/index/SWORD

Author:

Stuart Lewis

Method Summary

AtomDocumentResponse	doAtomDocument(AtomDocumentRequest adr) Answer a request for an entry document
DepositResponse	doDeposit(Deposit deposit) Answer a SWORD deposit
ServiceDocument	doServiceDocument(ServiceDocumentRequest sdr) Answer a Service Document request sent on behalf of a user

Method Detail

doServiceDocument

ServiceDocument doServiceDocument(ServiceDocumentRequest sdr)
                                  throws SWORDAuthenticationException,
                                         SWORDErrorException,
                                         SWORDException

Answer a Service Document request sent on behalf of a user

Parameters:

sdr - The Service Document Request object

Returns:

The ServiceDocument representing the service document

Throws:

SWORDAuthenticationException - Thrown if the authentication fails

SWORDErrorException - Thrown if there was an error with the input not matching the capabilities of the server

SWORDException - Thrown in an un-handalable Exception occurs. This will be dealt with by sending a HTTP 500 Server Exception

doDeposit

DepositResponse doDeposit(Deposit deposit)
                          throws SWORDAuthenticationException,
                                 SWORDErrorException,
                                 SWORDException

Answer a SWORD deposit

Parameters:

deposit - The Deposit object

Returns:

The response to the deposit

Throws:

SWORDAuthenticationException - Thrown if the authentication fails

SWORDErrorException - Thrown if there was an error with the input not matching the capabilities of the server

SWORDException - Thrown if an un-handalable Exception occurs. This will be dealt with by sending a HTTP 500 Server Exception

doAtomDocument

AtomDocumentResponse doAtomDocument(AtomDocumentRequest adr)
                                    throws SWORDAuthenticationException,
                                           SWORDErrorException,
                                           SWORDException

Answer a request for an entry document

Parameters:

adr - The Atom Document Request object

Returns:

The response to the atom document request

Throws:

SWORDAuthenticationException - Thrown if the authentication fails

SWORDErrorException - Thrown if there was an error with the input not matching the capabilities of the server

SWORDException - Thrown if an un-handalable Exception occurs. This will be dealt with by sending a HTTP 500 Server Exception