org.dspace.sword2

Class SwordConfigurationDSpace

java.lang.Object

org.dspace.sword2.SwordConfigurationDSpace

All Implemented Interfaces:

org.swordapp.server.SwordConfiguration

public class SwordConfigurationDSpace
extends Object
implements org.swordapp.server.SwordConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log logger

Constructor Summary

Constructors

Constructor and Description
SwordConfigurationDSpace() Initialise the sword configuration.

Method Summary

Methods

Modifier and Type	Method and Description
String	administratorEmail()
boolean	allowCommunityDeposit()
boolean	allowUnauthenticatedMediaAccess()
String	generator()
String	generatorVersion()
List<String>	getAcceptPackaging(Collection col) Get a map of packaging URIs to Q values for the packaging types which the given collection will accept.
List<String>	getAccepts(Context context, DSpaceObject dso) Get the list of MIME types that the given DSpace object will accept as packages.
String	getAlternateUrl()
String	getAlternateUrlContentType()
String	getAuthType()
List<String>	getCollectionAccepts() Get the list of mime types that a Collection will accept as packages
List<String>	getDisseminatePackaging()
String	getFailedPackageDir() directory location of the files with original packages for failed ingests
List<String>	getItemAcceptPackaging()
int	getMaxUploadSize() What is the max upload size (in bytes) for the SWORD interface?
String	getStateDescription(String state)
String	getStateUri(String state)
String	getStringProperty(String module, String propName, String defaultValue)
String	getStringProperty(String module, String propName, String defaultValue, String[] allowedValues)
String	getSwordBundle() Get the bundle name that sword will store its original deposit packages in, when storing them inside an item
String	getTempDirectory()
SwordUrlManager	getUrlManager(Context context, SwordConfigurationDSpace config)
boolean	isAcceptableContentType(Context context, String type, DSpaceObject dso) Is the given content MIME type acceptable to the given DSpace object.
boolean	isAcceptedPackaging(String packageFormat, DSpaceObject dso) Is the given packaging/media type supported by the given DSpace object?
boolean	isEntryFirst()
boolean	isKeepOriginal() Should the repository keep the original package?
boolean	isKeepPackageOnFailedIngest() should the repository write file of the original package if ingest fails
boolean	isMediated() Does the server support mediated deposit (aka on-behalf-of)?
boolean	isVerbose() Is this a verbose deposit?
boolean	returnDepositReceipt()
boolean	returnErrorBody()
boolean	returnStackTraceInError()
void	setFailedPackageDir(String dir) set the directory to write file of the original package
void	setKeepOriginal(boolean keepOriginal) set whether the repository should keep copies of the original package
void	setKeepPackageOnFailedIngest(boolean keepOriginalOnFail) set whether the repository should write file of the original package if ingest fails
void	setMaxUploadSize(int maxUploadSize) Set the max uplaod size (in bytes) for the SWORD interface.
void	setMediated(boolean mediated) Set whether the server supports mediated deposit (aka on-behalf-of).
void	setSwordBundle(String swordBundle) Set the bundle name that sword will store its original deposit packages in, when storing them inside an item
void	setVerbose(boolean verbose) Set whether this is a verbose deposit.
boolean	storeAndCheckBinary()

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Logger log

logger

Constructor Detail

SwordConfigurationDSpace

public SwordConfigurationDSpace()

Initialise the sword configuration. It is at this stage that the object will interrogate the DSpace Configuration for details

Method Detail

getStringProperty

public String getStringProperty(String module,
                       String propName,
                       String defaultValue,
                       String[] allowedValues)

getStringProperty

public String getStringProperty(String module,
                       String propName,
                       String defaultValue)

returnDepositReceipt

public boolean returnDepositReceipt()

Specified by:

returnDepositReceipt in interface org.swordapp.server.SwordConfiguration

returnStackTraceInError

public boolean returnStackTraceInError()

Specified by:

returnStackTraceInError in interface org.swordapp.server.SwordConfiguration

returnErrorBody

public boolean returnErrorBody()

Specified by:

returnErrorBody in interface org.swordapp.server.SwordConfiguration

generator

public String generator()

Specified by:

generator in interface org.swordapp.server.SwordConfiguration

generatorVersion

public String generatorVersion()

Specified by:

generatorVersion in interface org.swordapp.server.SwordConfiguration

administratorEmail

public String administratorEmail()

Specified by:

administratorEmail in interface org.swordapp.server.SwordConfiguration

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface org.swordapp.server.SwordConfiguration

storeAndCheckBinary

public boolean storeAndCheckBinary()

Specified by:

storeAndCheckBinary in interface org.swordapp.server.SwordConfiguration

getTempDirectory

public String getTempDirectory()

Specified by:

getTempDirectory in interface org.swordapp.server.SwordConfiguration

getAlternateUrl

public String getAlternateUrl()

Specified by:

getAlternateUrl in interface org.swordapp.server.SwordConfiguration

getAlternateUrlContentType

public String getAlternateUrlContentType()

Specified by:

getAlternateUrlContentType in interface org.swordapp.server.SwordConfiguration

getUrlManager

public SwordUrlManager getUrlManager(Context context,
                            SwordConfigurationDSpace config)

getDisseminatePackaging

public List<String> getDisseminatePackaging()
                                     throws DSpaceSwordException,
                                            org.swordapp.server.SwordError

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

isEntryFirst

public boolean isEntryFirst()

allowCommunityDeposit

public boolean allowCommunityDeposit()

getSwordBundle

public String getSwordBundle()

Get the bundle name that sword will store its original deposit packages in, when storing them inside an item

Returns:

setSwordBundle

public void setSwordBundle(String swordBundle)

Set the bundle name that sword will store its original deposit packages in, when storing them inside an item

Parameters:

swordBundle -

isVerbose

public boolean isVerbose()

Is this a verbose deposit?

setVerbose

public void setVerbose(boolean verbose)

Set whether this is a verbose deposit.

Parameters:

verbose -

getMaxUploadSize

public int getMaxUploadSize()

What is the max upload size (in bytes) for the SWORD interface?

Specified by:

getMaxUploadSize in interface org.swordapp.server.SwordConfiguration

setMaxUploadSize

public void setMaxUploadSize(int maxUploadSize)

Set the max uplaod size (in bytes) for the SWORD interface.

Parameters:

maxUploadSize -

isMediated

public boolean isMediated()

Does the server support mediated deposit (aka on-behalf-of)?

setMediated

public void setMediated(boolean mediated)

Set whether the server supports mediated deposit (aka on-behalf-of).

Parameters:

mediated -

isKeepOriginal

public boolean isKeepOriginal()

Should the repository keep the original package?

setKeepOriginal

public void setKeepOriginal(boolean keepOriginal)

set whether the repository should keep copies of the original package

Parameters:

keepOriginal -

setKeepPackageOnFailedIngest

public void setKeepPackageOnFailedIngest(boolean keepOriginalOnFail)

set whether the repository should write file of the original package if ingest fails

Parameters:

keepOriginalOnFail -

isKeepPackageOnFailedIngest

public boolean isKeepPackageOnFailedIngest()

should the repository write file of the original package if ingest fails

Returns:

keepPackageOnFailedIngest

setFailedPackageDir

public void setFailedPackageDir(String dir)

set the directory to write file of the original package

Parameters:

dir -

getFailedPackageDir

public String getFailedPackageDir()

directory location of the files with original packages for failed ingests

Returns:

failedPackageDir

getAccepts

public List<String> getAccepts(Context context,
                      DSpaceObject dso)
                        throws DSpaceSwordException

Get the list of MIME types that the given DSpace object will accept as packages.

Parameters:

context -

dso -

Throws:

DSpaceSwordException

getCollectionAccepts

public List<String> getCollectionAccepts()
                                  throws DSpaceSwordException

Get the list of mime types that a Collection will accept as packages

Returns:

the list of mime types

Throws:

DSpaceSwordException

getAcceptPackaging

public List<String> getAcceptPackaging(Collection col)

Get a map of packaging URIs to Q values for the packaging types which the given collection will accept. The URI should be a unique identifier for the packaging type, such as: http://purl.org/net/sword-types/METSDSpaceSIP and the Q value is a floating point between 0 and 1 which defines how much the server "likes" this packaging type.

Parameters:

col -

getItemAcceptPackaging

public List<String> getItemAcceptPackaging()

isAcceptedPackaging

public boolean isAcceptedPackaging(String packageFormat,
                          DSpaceObject dso)
                            throws DSpaceSwordException,
                                   org.swordapp.server.SwordError

Is the given packaging/media type supported by the given DSpace object?

Parameters:

packageFormat -

dso -

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

isAcceptableContentType

public boolean isAcceptableContentType(Context context,
                              String type,
                              DSpaceObject dso)
                                throws DSpaceSwordException

Is the given content MIME type acceptable to the given DSpace object.

Parameters:

context -

type -

dso -

Throws:

DSpaceSwordException

getStateUri

public String getStateUri(String state)

getStateDescription

public String getStateDescription(String state)

allowUnauthenticatedMediaAccess

public boolean allowUnauthenticatedMediaAccess()

Specified by:

allowUnauthenticatedMediaAccess in interface org.swordapp.server.SwordConfiguration