org.dspace.sword.client

Class DSpaceSwordClient

java.lang.Object

org.dspace.sword.client.DSpaceSwordClient

public class DSpaceSwordClient
extends Object

User: Robin Taylor Date: 15/02/11 Time: 21:12

Field Summary

Fields

Modifier and Type	Field and Description
protected HandleService	handleService

Constructor Summary

Constructors

Constructor and Description
DSpaceSwordClient()

Method Summary

Methods

Modifier and Type	Method and Description
void	createPackage(Context context, String handle, File file) Create the package and write it to disk.
void	deposit(Context context, String handle)
org.purl.sword.base.ServiceDocument	getServiceDocument()
String	sendMessage() Reads the file, probably a zipped package, and sends it to the Sword server.
void	setCollection(String destination)
void	setCredentials(String username, String password, String onBehalfOf)
void	setFilename()
void	setFileType(String fileType)
void	setPackageFormat(String packageFormat)
void	setRemoteServer(String chosenUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handleService

protected HandleService handleService

Constructor Detail

DSpaceSwordClient

public DSpaceSwordClient()

Method Detail

setFilename

public void setFilename()

setRemoteServer

public void setRemoteServer(String chosenUrl)
                     throws MalformedURLException

Throws:

MalformedURLException

setCredentials

public void setCredentials(String username,
                  String password,
                  String onBehalfOf)

getServiceDocument

public org.purl.sword.base.ServiceDocument getServiceDocument()
                                                       throws HttpException,
                                                              org.purl.sword.client.SWORDClientException

Throws:

HttpException

org.purl.sword.client.SWORDClientException

setCollection

public void setCollection(String destination)

setFileType

public void setFileType(String fileType)

setPackageFormat

public void setPackageFormat(String packageFormat)
                      throws PackageFormatException

Throws:

PackageFormatException

deposit

public void deposit(Context context,
           String handle)
             throws InvalidHandleException,
                    PackagerException,
                    org.purl.sword.client.SWORDClientException,
                    PackageFormatException,
                    HttpException

Throws:

InvalidHandleException

PackagerException

org.purl.sword.client.SWORDClientException

PackageFormatException

HttpException

createPackage

public void createPackage(Context context,
                 String handle,
                 File file)
                   throws InvalidHandleException,
                          PackagerException,
                          PackageFormatException

Create the package and write it to disk.

Parameters:

context - session context.

handle - object to be packaged.

file - write the package here.

Throws:

InvalidHandleException - if handle cannot be resolved.

PackagerException - on error.

PackageFormatException - on unknown package type.

sendMessage

public String sendMessage()
                   throws org.purl.sword.client.SWORDClientException,
                          HttpException

Reads the file, probably a zipped package, and sends it to the Sword server.

Returns:

A unique ID returned by a successful deposit

Throws:

org.purl.sword.client.SWORDClientException - passed through.

HttpException - on error.