A B C D E G H I K L M N O P Q R S T U V W X

A

abort() - Method in class org.dspace.sword.SWORDContext
Abort all of the contexts held by this class.
Accept - Class in org.purl.sword.atom
 
Accept() - Constructor for class org.purl.sword.atom.Accept
 
Accept(String) - Constructor for class org.purl.sword.atom.Accept
 
ACCEPTED - Static variable in class org.purl.sword.base.Deposit
Submission accepted.
ACCEPTED - Static variable in interface org.purl.sword.base.HttpHeaders
Submission accepted.
addAcceptPackaging(String, float) - Method in class org.purl.sword.base.Collection
Add an acceptPackaging format.
addAcceptPackaging(String) - Method in class org.purl.sword.base.Collection
Add an acceptPackaging format.
addAccepts(String) - Method in class org.purl.sword.base.Collection
Add an accepts entry.
addAttributeValidationInfo(SwordValidationInfo) - Method in class org.purl.sword.base.SwordValidationInfo
 
addAuthors() - Method in class org.dspace.sword.DSpaceATOMEntry
add the author names from the bibliographic metadata.
addAuthors(Author) - Method in class org.purl.sword.atom.Entry
Add an author to the Entry.
addCategories() - Method in class org.dspace.sword.BitstreamEntryGenerator
Add all the subject classifications from the bibliographic metadata.
addCategories() - Method in class org.dspace.sword.ItemEntryGenerator
Add all the subject classifications from the bibliographic metadata.
addCategory(String) - Method in class org.purl.sword.atom.Entry
Add a category.
addCollection(Collection) - Method in class org.purl.sword.base.Workspace
Add a collection to the Workspace.
addContentElement() - Method in class org.dspace.sword.BitstreamEntryGenerator
Set the content type that DSpace received.
addContentElement() - Method in class org.dspace.sword.ItemEntryGenerator
Set the content type that DSpace received.
addContributor(Contributor) - Method in class org.purl.sword.atom.Entry
Add a contributor.
addContributors() - Method in class org.dspace.sword.DSpaceATOMEntry
Add the list of contributors to the item.
addGenerator() - Method in class org.dspace.sword.DSpaceATOMEntry
add the generator field content
addIdentifier() - Method in class org.dspace.sword.BitstreamEntryGenerator
Add the identifier for the item.
addIdentifier() - Method in class org.dspace.sword.ItemEntryGenerator
Add the identifier for the item.
addLastUpdatedDate() - Method in class org.dspace.sword.BitstreamEntryGenerator
Add the date that this item was last updated
addLastUpdatedDate() - Method in class org.dspace.sword.ItemEntryGenerator
Add the date that this item was last updated
addLink(Link) - Method in class org.purl.sword.atom.Entry
Get the link for this Entry.
addLinks() - Method in class org.dspace.sword.BitstreamEntryGenerator
Add links associated with this item.
addLinks() - Method in class org.dspace.sword.ItemEntryGenerator
Add links associated with this item.
addPackagingElement() - Method in class org.dspace.sword.DSpaceATOMEntry
set the packaging format of the deposit
addPublishDate() - Method in class org.dspace.sword.BitstreamEntryGenerator
Add the date of publication from the bibliographic metadata
addPublishDate() - Method in class org.dspace.sword.ItemEntryGenerator
Add the date of publication from the bibliographic metadata
addRights() - Method in class org.dspace.sword.BitstreamEntryGenerator
Add rights information.
addRights() - Method in class org.dspace.sword.ItemEntryGenerator
Add rights information.
addSummary() - Method in class org.dspace.sword.BitstreamEntryGenerator
Add the summary/abstract from the bibliographic metadata
addSummary() - Method in class org.dspace.sword.ItemEntryGenerator
Add the summary/abstract from the bibliographic metadata
addTitle() - Method in class org.dspace.sword.BitstreamEntryGenerator
Add the title from the bibliographic metadata
addTitle() - Method in class org.dspace.sword.ItemEntryGenerator
Add the title from the bibliographic metadata
addTreatment() - Method in class org.dspace.sword.DSpaceATOMEntry
Add deposit treatment text
addUnmarshallAttributeInfo(SwordValidationInfo) - Method in class org.purl.sword.base.SwordValidationInfo
 
addUnmarshallElementInfo(SwordValidationInfo) - Method in class org.purl.sword.base.SwordValidationInfo
 
addUnmarshallValidationInfo(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>) - Method in class org.purl.sword.base.SwordValidationInfo
 
addUnmarshallValidationInfo(SwordValidationInfo) - Method in class org.purl.sword.base.SwordValidationInfo
 
addValidationInfo(SwordValidationInfo) - Method in class org.purl.sword.base.SwordValidationInfo
Add a related information item to this resource.
addWorkspace(Workspace) - Method in class org.purl.sword.base.Service
Add a workspace.
ATOMCollectionGenerator - Class in org.dspace.sword
 
ATOMCollectionGenerator(SWORDService) - Constructor for class org.dspace.sword.ATOMCollectionGenerator
Create a new ATOM collection generator using the given sword service
AtomDocumentRequest - Class in org.purl.sword.base
Represents an AtomDocumentRequest.
AtomDocumentRequest() - Constructor for class org.purl.sword.base.AtomDocumentRequest
 
AtomDocumentResponse - Class in org.purl.sword.base
Represents a deposit response.
AtomDocumentResponse(int) - Constructor for class org.purl.sword.base.AtomDocumentResponse
Create a new response with the specified http code.
AtomDocumentServlet - Class in org.purl.sword.server
EntryDocumentServlet
AtomDocumentServlet() - Constructor for class org.purl.sword.server.AtomDocumentServlet
 
ATTRIBUTE_HREF - Static variable in class org.purl.sword.atom.Link
Label for the href attribute.
ATTRIBUTE_HREF - Static variable in class org.purl.sword.base.Collection
Label for the Href attribute.
ATTRIBUTE_HREF_LANG - Static variable in class org.purl.sword.atom.Link
Label for the hreflang attribute.
ATTRIBUTE_LENGTH - Static variable in class org.purl.sword.atom.Link
Label for the length attribute.
ATTRIBUTE_Q_NAME - Static variable in class org.purl.sword.base.SwordAcceptPackaging
 
ATTRIBUTE_REL - Static variable in class org.purl.sword.atom.Link
Label for the rel attribute.
ATTRIBUTE_SRC - Static variable in class org.purl.sword.atom.Content
The identifier for the src attribute.
ATTRIBUTE_TITLE - Static variable in class org.purl.sword.atom.Link
Label for the title attribute.
ATTRIBUTE_TYPE - Static variable in class org.purl.sword.atom.Content
The identifier for the type attribute.
ATTRIBUTE_TYPE - Static variable in class org.purl.sword.atom.Link
Label for the type attribute.
ATTRIBUTE_TYPE - Static variable in class org.purl.sword.atom.TextConstruct
label for the type attribute.
ATTRIBUTE_URI - Static variable in class org.purl.sword.atom.Generator
Label for the uri attribute.
ATTRIBUTE_VERSION - Static variable in class org.purl.sword.atom.Generator
Label for the version attribute.
authenticate(ServiceDocumentRequest) - Method in class org.dspace.sword.SWORDAuthenticator
Authenticate the given service document request.
authenticate(AtomDocumentRequest) - Method in class org.dspace.sword.SWORDAuthenticator
Authenticate the given atom document request.
authenticate(Deposit) - Method in class org.dspace.sword.SWORDAuthenticator
Authenticate the deposit request.
authenticates(Context, String, String) - Method in class org.dspace.sword.SWORDAuthentication
Does the given username and password authenticate for the given DSpace Context?
authenticates(Context, String, String) - Method in class org.dspace.sword.SWORDAuthenticator
Does the given username and password authenticate for the given DSpace Context?
authenticateWithBasic() - Method in class org.purl.sword.server.DepositServlet
Utility method to decide if we are using HTTP Basic authentication
Author - Class in org.purl.sword.atom
Represents an Author type, as used in ATOM.
Author() - Constructor for class org.purl.sword.atom.Author
Create a new instance and set the prefix to 'atom' and the local name to 'author'.
Author(XmlName) - Constructor for class org.purl.sword.atom.Author
 
Author(String, String) - Constructor for class org.purl.sword.atom.Author
Create a new instance and set the element name.
Author(String, String, String) - Constructor for class org.purl.sword.atom.Author
 

B

BAD_URL - Static variable in interface org.dspace.sword.DSpaceSWORDErrorCodes
if the url of the request does not resolve to something meaningful
BasicBooleanContentElement - Class in org.purl.sword.base
 
BasicBooleanContentElement(String, String, String) - Constructor for class org.purl.sword.base.BasicBooleanContentElement
 
BasicBooleanContentElement(XmlName) - Constructor for class org.purl.sword.base.BasicBooleanContentElement
 
BasicContentElement - Class in org.purl.sword.base
Represents a text construct in the ATOM elements.
BasicContentElement(String, String, String) - Constructor for class org.purl.sword.base.BasicContentElement
 
BasicContentElement(XmlName) - Constructor for class org.purl.sword.base.BasicContentElement
 
BasicIntegerContentElement - Class in org.purl.sword.base
 
BasicIntegerContentElement(String, String, String) - Constructor for class org.purl.sword.base.BasicIntegerContentElement
 
BasicIntegerContentElement(XmlName) - Constructor for class org.purl.sword.base.BasicIntegerContentElement
 
BasicStringContentElement - Class in org.purl.sword.base
 
BasicStringContentElement(String, String, String) - Constructor for class org.purl.sword.base.BasicStringContentElement
 
BasicStringContentElement(XmlName) - Constructor for class org.purl.sword.base.BasicStringContentElement
 
bitstream - Variable in class org.dspace.sword.DSpaceATOMEntry
The bitstream this ATOM entry represents
BitstreamEntryGenerator - Class in org.dspace.sword
 
BitstreamEntryGenerator(SWORDService) - Constructor for class org.dspace.sword.BitstreamEntryGenerator
Create a new ATOM Entry generator which can provide a SWORD Entry for a bitstream
buildCollection(DSpaceObject) - Method in class org.dspace.sword.ATOMCollectionGenerator
Build the ATOM Collection which represents the given DSpace Object
buildCollection(DSpaceObject) - Method in class org.dspace.sword.CollectionCollectionGenerator
Build the collection for the given DSpaceObject.
buildCollection(DSpaceObject) - Method in class org.dspace.sword.CommunityCollectionGenerator
 
buildCollection(DSpaceObject) - Method in class org.dspace.sword.ItemCollectionGenerator
Build the collection around the give DSpaceObject.

C

canSubmit(SWORDService, Deposit, DSpaceObject) - Method in class org.dspace.sword.SWORDAuthenticator
Can the users contained in this object's member SWORDContext make a successful submission to the selected collection.
canSubmitTo(SWORDContext, Collection) - Method in class org.dspace.sword.SWORDAuthenticator
Can the current SWORD Context permit deposit into the given collection in the given DSpace Context IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to ADD AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null)
canSubmitTo(SWORDContext, Item) - Method in class org.dspace.sword.SWORDAuthenticator
Does the given context have the authority to submit to the given item.
canSubmitTo(SWORDContext, DSpaceObject) - Method in class org.dspace.sword.SWORDAuthenticator
Can the given context submit to the specified dspace object.
Category - Class in org.purl.sword.atom
 
Category() - Constructor for class org.purl.sword.atom.Category
 
Category(String) - Constructor for class org.purl.sword.atom.Category
 
ChecksumUtils - Class in org.purl.sword.base
Utility class that holds Checksum related methods.
ChecksumUtils() - Constructor for class org.purl.sword.base.ChecksumUtils
 
clearAcceptPackaging() - Method in class org.purl.sword.base.Collection
Remove all of the accepted packaging formats associated with this Collection.
clearAccepts() - Method in class org.purl.sword.base.Collection
Remove all of the accepts associated with this Collection.
clearAuthors() - Method in class org.purl.sword.atom.Entry
Clear the list of authors.
clearCategories() - Method in class org.purl.sword.atom.Entry
Clear the list of categories.
clearContributors() - Method in class org.purl.sword.atom.Entry
Clear the list of contributors.
clearLinks() - Method in class org.purl.sword.atom.Entry
Clear the list of links.
clearUnmarshallItems() - Method in class org.purl.sword.base.SwordValidationInfo
Clear the list of unmarshalled info items.
clearValidationItems() - Method in class org.purl.sword.base.SwordValidationInfo
Clear the list of validation info items.
clearWorkspaces() - Method in class org.purl.sword.base.Service
Clear the list of workspaces.
Collection - Class in org.purl.sword.base
A representation of a SWORD Collection.
Collection() - Constructor for class org.purl.sword.base.Collection
Create a new instance.
Collection(String) - Constructor for class org.purl.sword.base.Collection
Create a new instance and set the initial location for the collection.
CollectionCollectionGenerator - Class in org.dspace.sword
Class to generate ATOM Collection Elements which represent DSpace Collections
CollectionCollectionGenerator(SWORDService) - Constructor for class org.dspace.sword.CollectionCollectionGenerator
Construct an object taking the sword service instance an argument
CollectionDepositor - Class in org.dspace.sword
 
CollectionDepositor(SWORDService, DSpaceObject) - Constructor for class org.dspace.sword.CollectionDepositor
Construct a depositor for the given service instance on the given DSpaceObject.
collectionIterator() - Method in class org.purl.sword.base.Workspace
Get an Iterator over the collections.
CollectionLocation - Class in org.dspace.sword
This class provides a single point of contact for resolving Collections from SWORD Deposit URLs and for generating SWORD Deposit URLs from Collections
CollectionLocation() - Constructor for class org.dspace.sword.CollectionLocation
 
commit() - Method in class org.dspace.sword.SWORDContext
Commit the primary context held by this class, and abort the authenticated user's context if it is different.
CommunityCollectionGenerator - Class in org.dspace.sword
 
CommunityCollectionGenerator(SWORDService) - Constructor for class org.dspace.sword.CommunityCollectionGenerator
 
constructEntry() - Method in class org.dspace.sword.DSpaceATOMEntry
Construct the entry
constructSubServiceUrl(Community) - Method in class org.dspace.sword.SWORDUrlManager
Construct the service document url for the given object, which will be supplied in the sword:service element of other service document entries
constructSubServiceUrl(Collection) - Method in class org.dspace.sword.SWORDUrlManager
Construct the service document url for the given object, which will be supplied in the sword:service element of other service document entries
Content - Class in org.purl.sword.atom
Represents an ATOM Content element.
Content() - Constructor for class org.purl.sword.atom.Content
Create a new instance and set the prefix to 'atom' and the local name to 'content'.
CONTENT_DISPOSITION - Static variable in interface org.purl.sword.base.HttpHeaders
The HTTP Header that specifies the content disposition item.
CONTENT_LENGTH - Static variable in interface org.purl.sword.base.HttpHeaders
The HTTP Header label that specifies the MD5 label.
CONTENT_MD5 - Static variable in interface org.purl.sword.base.HttpHeaders
The HTTP Header label that specifies the MD5 label.
ContentType - Enum in org.purl.sword.atom
Represents a content type for a text element.
Contributor - Class in org.purl.sword.atom
Represents an ATOM Contributor.
Contributor() - Constructor for class org.purl.sword.atom.Contributor
Create a new instance and set the prefix to 'atom' and the local name to 'contributor'.
CREATED - Static variable in class org.purl.sword.base.Deposit
Submission created
CREATED - Static variable in interface org.purl.sword.base.HttpHeaders
Submission created
createString(SwordValidationInfo, StringBuffer, String) - Method in class org.purl.sword.base.SwordValidationInfo
Utility method that will recursively print out the list of items for the specified validation info object.
createValidAttributeInfo(String, String) - Method in class org.purl.sword.base.XmlElement
 

D

DATE_FORMAT - Static variable in class org.purl.sword.base.XmlElement
The Date format that is used to parse dates to and from the ISO format in the XML data.
DATE_FORMATS - Static variable in class org.purl.sword.base.XmlElement
Array of possible date formats that are permitted for date elements.
DcAbstract - Class in org.purl.sword.base
 
DcAbstract() - Constructor for class org.purl.sword.base.DcAbstract
 
DcAbstract(String) - Constructor for class org.purl.sword.base.DcAbstract
 
deposit(Deposit) - Method in class org.dspace.sword.DepositManager
Once this object is fully prepared, this method will execute the deposit process.
deposit - Variable in class org.dspace.sword.DSpaceATOMEntry
the original deposit
Deposit - Class in org.purl.sword.base
Represents a deposit.
Deposit() - Constructor for class org.purl.sword.base.Deposit
 
DepositManager - Class in org.dspace.sword
This class is responsible for initiating the process of deposit of SWORD Deposit objects into the DSpace repository
DepositManager(SWORDService) - Constructor for class org.dspace.sword.DepositManager
Construct a new DepositManager using the given instantiation of the SWORD service implementation
Depositor - Class in org.dspace.sword
 
Depositor(SWORDService, DSpaceObject) - Constructor for class org.dspace.sword.Depositor
Construct a new Depositor with the given sword service on the given dspace object.
DepositResponse - Class in org.purl.sword.base
Represents a deposit response.
DepositResponse(int) - Constructor for class org.purl.sword.base.DepositResponse
Create a new response with the specified http code.
DepositResult - Class in org.dspace.sword
The DSpace class for representing the results of a deposit request.
DepositResult() - Constructor for class org.dspace.sword.DepositResult
 
DepositServlet - Class in org.purl.sword.server
DepositServlet
DepositServlet() - Constructor for class org.purl.sword.server.DepositServlet
 
doAtomDocument(AtomDocumentRequest) - Method in class org.dspace.sword.DSpaceSWORDServer
 
doAtomDocument(AtomDocumentRequest) - Method in class org.purl.sword.server.DummyServer
 
doAtomDocument(AtomDocumentRequest) - Method in interface org.purl.sword.server.SWORDServer
Answer a request for an entry document
doDeposit(Deposit) - Method in class org.dspace.sword.CollectionDepositor
Perform a deposit, using the supplied SWORD Deposit object
doDeposit(Deposit) - Method in class org.dspace.sword.Depositor
Execute the deposit process with the given sword deposit
doDeposit(Deposit) - Method in class org.dspace.sword.DSpaceSWORDServer
 
doDeposit(Deposit) - Method in class org.dspace.sword.ItemDepositor
 
doDeposit(Deposit) - Method in class org.purl.sword.server.DummyServer
 
doDeposit(Deposit) - Method in interface org.purl.sword.server.SWORDServer
Answer a SWORD deposit
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.AtomDocumentServlet
Process the get request.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.DepositServlet
Process the Get request.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.ServiceDocumentServlet
Process the get request.
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.DepositServlet
Process a post request.
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.ServiceDocumentServlet
Process the post request.
doServiceDocument(ServiceDocumentRequest) - Method in class org.dspace.sword.DSpaceSWORDServer
 
doServiceDocument(ServiceDocumentRequest) - Method in class org.purl.sword.server.DummyServer
Provides a dumb but plausible service document - it contains an anonymous workspace and collection, and one personalised for the onBehalfOf user.
doServiceDocument(ServiceDocumentRequest) - Method in interface org.purl.sword.server.SWORDServer
Answer a Service Document request sent on behalf of a user
DSpaceATOMEntry - Class in org.dspace.sword
Class to represent a DSpace Item as an ATOM Entry.
DSpaceATOMEntry(SWORDService) - Constructor for class org.dspace.sword.DSpaceATOMEntry
Create a new atom entry object around the given service
DSpaceSWORDErrorCodes - Interface in org.dspace.sword
Some URIs for DSpace specific errors which may be reported through the SWORDErrorException
DSpaceSWORDException - Exception in org.dspace.sword
This Exception class can be thrown by the internals of the DSpace SWORD implementation
DSpaceSWORDException() - Constructor for exception org.dspace.sword.DSpaceSWORDException
 
DSpaceSWORDException(String, Throwable) - Constructor for exception org.dspace.sword.DSpaceSWORDException
 
DSpaceSWORDException(String) - Constructor for exception org.dspace.sword.DSpaceSWORDException
 
DSpaceSWORDException(Throwable) - Constructor for exception org.dspace.sword.DSpaceSWORDException
 
DSpaceSWORDServer - Class in org.dspace.sword
An implementation of the SWORDServer interface to allow SWORD deposit operations on DSpace.
DSpaceSWORDServer() - Constructor for class org.dspace.sword.DSpaceSWORDServer
 
DummyServer - Class in org.purl.sword.server
A 'dummy server' which acts as dumb repository which implements the SWORD ServerInterface.
DummyServer() - Constructor for class org.purl.sword.server.DummyServer
 
DUPLICATE_ELEMENT - Static variable in class org.purl.sword.base.SwordValidationInfo
 

E

ELEMENT_AUTHOR_NAME - Static variable in class org.purl.sword.atom.Author
Deprecated. 
ELEMENT_CATEGORY - Static variable in class org.purl.sword.atom.Entry
Deprecated. 
ELEMENT_EMAIL - Static variable in class org.purl.sword.atom.Author
Deprecated. 
ELEMENT_GENERATOR - Static variable in class org.purl.sword.atom.Entry
Deprecated. 
ELEMENT_GENERATOR - Static variable in class org.purl.sword.base.Service
Deprecated. 
ELEMENT_ID - Static variable in class org.purl.sword.atom.Entry
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.atom.Author
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.atom.Entry
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.atom.Generator
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.atom.Link
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.atom.Title
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.base.Collection
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.base.Service
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.base.SwordAcceptPackaging
 
ELEMENT_NAME - Static variable in class org.purl.sword.base.SWORDErrorDocument
Deprecated. 
ELEMENT_NAME - Static variable in class org.purl.sword.base.Workspace
Deprecated. 
ELEMENT_PUBLISHED - Static variable in class org.purl.sword.atom.Entry
Deprecated. 
ELEMENT_UPDATED - Static variable in class org.purl.sword.atom.Entry
Deprecated. 
ELEMENT_URI - Static variable in class org.purl.sword.atom.Author
Deprecated. 
elementName() - Static method in class org.purl.sword.atom.Accept
Get the XmlName for this class.
elementName() - Static method in class org.purl.sword.atom.Author
Get the XmlName for this class.
elementName() - Static method in class org.purl.sword.atom.Category
 
elementName() - Static method in class org.purl.sword.atom.Content
 
elementName() - Static method in class org.purl.sword.atom.Contributor
Get the element name for this Xml Element.
elementName() - Static method in class org.purl.sword.atom.Email
 
elementName() - Static method in class org.purl.sword.atom.Entry
 
elementName() - Static method in class org.purl.sword.atom.Generator
 
elementName() - Static method in class org.purl.sword.atom.Id
 
elementName() - Static method in class org.purl.sword.atom.Link
 
elementName() - Static method in class org.purl.sword.atom.Name
 
elementName() - Static method in class org.purl.sword.atom.Published
 
elementName() - Static method in class org.purl.sword.atom.Rights
 
elementName() - Static method in class org.purl.sword.atom.Source
 
elementName() - Static method in class org.purl.sword.atom.Summary
 
elementName() - Static method in class org.purl.sword.atom.Title
 
elementName() - Static method in class org.purl.sword.atom.Updated
 
elementName() - Static method in class org.purl.sword.atom.Uri
 
elementName() - Static method in class org.purl.sword.base.Collection
 
elementName() - Static method in class org.purl.sword.base.DcAbstract
 
elementName() - Static method in class org.purl.sword.base.Service
 
elementName() - Static method in class org.purl.sword.base.SwordAcceptPackaging
 
elementName() - Static method in class org.purl.sword.base.SwordCollectionPolicy
 
elementName() - Static method in class org.purl.sword.base.SWORDErrorDocument
Get the element name.
elementName() - Static method in class org.purl.sword.base.SwordMaxUploadSize
 
elementName() - Static method in class org.purl.sword.base.SwordMediation
 
elementName() - Static method in class org.purl.sword.base.SwordNoOp
 
elementName() - Static method in class org.purl.sword.base.SwordPackaging
 
elementName() - Static method in class org.purl.sword.base.SwordService
 
elementName() - Static method in class org.purl.sword.base.SwordTreatment
 
elementName() - Static method in class org.purl.sword.base.SwordUserAgent
 
elementName() - Static method in class org.purl.sword.base.SwordVerbose
 
elementName() - Static method in class org.purl.sword.base.SwordVerboseDescription
 
elementName() - Static method in class org.purl.sword.base.SwordVersion
 
elementName() - Static method in class org.purl.sword.base.Workspace
 
elements() - Method in class org.purl.sword.base.SwordContentPackageTypes
 
Email - Class in org.purl.sword.atom
 
Email() - Constructor for class org.purl.sword.atom.Email
 
Email(String) - Constructor for class org.purl.sword.atom.Email
 
entry - Variable in class org.dspace.sword.DSpaceATOMEntry
the SWORD ATOM entry which this class effectively decorates
Entry - Class in org.purl.sword.atom
Represents an ATOM entry.
Entry() - Constructor for class org.purl.sword.atom.Entry
Create a new instance of the class and initialise it.
Entry(String, String) - Constructor for class org.purl.sword.atom.Entry
Create a new instance of the class an initalise it, setting the element namespace and name.
Entry(String, String, String) - Constructor for class org.purl.sword.atom.Entry
 
Entry(XmlName) - Constructor for class org.purl.sword.atom.Entry
 
equals(Object) - Method in class org.purl.sword.base.XmlName
 
ERROR_BAD_REQUEST - Static variable in interface org.purl.sword.base.ErrorCodes
ErrorBadRequest - where parameters are not understood
ERROR_CHECKSUM_MISMATCH - Static variable in interface org.purl.sword.base.ErrorCodes
ErrorChecksumMismatch - where the checksum of the file received does not match the checksum given in the header
ERROR_CONTENT - Static variable in interface org.purl.sword.base.ErrorCodes
ErrorContent - where the supplied format is not the same as that identified in the X-Format-Namespace and/or that supported by the server
ERROR_WITH_CONTENT - Static variable in class org.purl.sword.base.SwordValidationInfo
 
ErrorCodes - Interface in org.purl.sword.base
Definition of the error codes that will be used in SWORD error documents.
extractDSpaceObject(String) - Method in class org.dspace.sword.SWORDUrlManager
Extract a DSpaceObject from the given url.

G

generateMD5(String) - Static method in class org.purl.sword.base.ChecksumUtils
Generate an MD5 hash for the file that is specified in the filepath.
generateMD5(InputStream) - Static method in class org.purl.sword.base.ChecksumUtils
Generate an MD5 hash for the file that is specified in the filepath.
generateMD5(byte[]) - Static method in class org.purl.sword.base.ChecksumUtils
Generate an MD5 hash for the file that is specified in the filepath.
Generator - Class in org.purl.sword.atom
Represents an ATOM Generator element.
Generator() - Constructor for class org.purl.sword.atom.Generator
Create a new instance and set the prefix to 'atom' and the local name to 'generator'.
getAbstract() - Method in class org.purl.sword.base.Collection
Get the DC Term abstract.
getAcceptList() - Method in class org.purl.sword.base.Collection
 
getAcceptPackaging(Collection) - Method in class org.dspace.sword.SWORDConfiguration
Get a map of packaging URIs to Q values for the packaging types which the given collection will accept.
getAcceptPackaging() - Method in class org.purl.sword.base.Collection
Retrieve a hashtable that holds all the acceptsPackaging details.
getAccepts(Context, DSpaceObject) - Method in class org.dspace.sword.SWORDConfiguration
Get the list of mime types that the given dspace object will accept as packages
getAccepts() - Method in class org.purl.sword.base.Collection
Retrieve an array that holds all of the Accept details.
getAcceptsList() - Method in class org.purl.sword.base.Collection
Deprecated. 
getAllowedCollections(SWORDContext) - Method in class org.dspace.sword.SWORDAuthenticator
Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context Forwards to: getAllowedCollections(swordContext, null) See that method for details of the conditions applied
getAllowedCollections(SWORDContext, Community) - Method in class org.dspace.sword.SWORDAuthenticator
Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to ADD AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to ADD OR the on-behalf-of user is null)
getAllowedCommunities(SWORDContext) - Method in class org.dspace.sword.SWORDAuthenticator
Get an array of all the communities that the current SWORD context will allow deposit onto in the given DSpace context The user may submit to a community if the following conditions are met: IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to READ AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null)
getAllowedItems(SWORDContext, Collection) - Method in class org.dspace.sword.SWORDAuthenticator
Get a list of all the items that the current SWORD context will allow deposit onto in the given DSpace context IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to WRITE on the item and ADD on the ORIGINAL bundle AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle OR the on-behalf-of user is null)
getAttribute() - Method in class org.purl.sword.base.SwordValidationInfo
Return the attribute that this information describes.
getAuthenticated() - Method in class org.dspace.sword.SWORDContext
 
getAuthenticatorContext() - Method in class org.dspace.sword.SWORDContext
Get the context of the user who authenticated.
getAuthors() - Method in class org.purl.sword.atom.Entry
Get an iterator for the authors in the Entry.
getBaseDepositUrl() - Method in class org.dspace.sword.SWORDUrlManager
Get the base deposit URL for the DSpace SWORD implementation.
getBaseMediaLinkUrl() - Method in class org.dspace.sword.SWORDUrlManager
get the base media link url
getBaseServiceDocumentUrl() - Method in class org.dspace.sword.SWORDUrlManager
get the base url for service document requests
getBitstream() - Method in class org.dspace.sword.DepositResult
 
getBitstreamUrl(Bitstream) - Method in class org.dspace.sword.SWORDUrlManager
Central location for constructing usable urls for dspace bitstreams.
getCategories() - Method in class org.purl.sword.atom.Entry
Get an iterator for the categories in this Entry.
getCollection(Context, String) - Method in class org.dspace.sword.CollectionLocation
Obtain the collection which is represented by the given URL
getCollection(Context, String) - Method in class org.dspace.sword.SWORDUrlManager
Obtain the collection which is represented by the given URL
getCollectionAccepts() - Method in class org.dspace.sword.SWORDConfiguration
Get the list of mime types that a Collection will accept as packages
getCollectionPolicy() - Method in class org.purl.sword.base.Collection
Get the collection policy.
getCollections() - Method in class org.purl.sword.base.Workspace
Get a list of the collections
getCommunities(SWORDContext, Community) - Method in class org.dspace.sword.SWORDAuthenticator
Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context The user may submit to a community if the following conditions are met: IF: the authenticated user is an administrator AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null) OR IF: the authenticated user is authorised to READ AND: (the on-behalf-of user is an administrator OR the on-behalf-of user is authorised to READ OR the on-behalf-of user is null)
getContent() - Method in class org.purl.sword.atom.Entry
Get the content element for this Entry.
getContent() - Method in class org.purl.sword.atom.Generator
Get the content.
getContent() - Method in class org.purl.sword.atom.Link
Get the content.
getContent() - Method in class org.purl.sword.atom.TextConstruct
Get the content in this TextConstruct.
getContent() - Method in class org.purl.sword.base.BasicBooleanContentElement
 
getContent() - Method in class org.purl.sword.base.BasicIntegerContentElement
 
getContent() - Method in class org.purl.sword.base.BasicStringContentElement
 
getContent() - Method in class org.purl.sword.base.SwordAcceptPackaging
Get the content in this TextConstruct.
getContentAsString() - Method in class org.purl.sword.base.BasicBooleanContentElement
 
getContentAsString() - Method in class org.purl.sword.base.BasicContentElement
 
getContentAsString() - Method in class org.purl.sword.base.BasicIntegerContentElement
 
getContentAsString() - Method in class org.purl.sword.base.BasicStringContentElement
 
getContentDescription() - Method in class org.purl.sword.base.SwordValidationInfo
 
getContentDisposition() - Method in class org.purl.sword.base.Deposit
Return the content disposition value.
getContentLength() - Method in class org.purl.sword.base.Deposit
 
getContentType() - Method in class org.purl.sword.base.Deposit
 
getContext() - Method in class org.dspace.sword.SWORDContext
Returns the most appropriate context for operations on the database.
getContext() - Method in class org.dspace.sword.SWORDService
 
getContributors() - Method in class org.purl.sword.atom.Entry
Get a list of contributors.
getDepositID() - Method in class org.purl.sword.base.Deposit
 
getDepositLocation(Collection) - Method in class org.dspace.sword.SWORDUrlManager
Obtain the deposit URL for the given collection.
getDepositLocation(Item) - Method in class org.dspace.sword.SWORDUrlManager
Obtain the deposit URL for the given item.
getDepositLocation(Community) - Method in class org.dspace.sword.SWORDUrlManager
Obtain the deposit URL for the given community.
getDepositTarget(Deposit) - Method in class org.dspace.sword.DepositManager
 
getDescription() - Method in exception org.purl.sword.base.SWORDErrorException
 
getDSpaceObject(Context, String) - Method in class org.dspace.sword.SWORDUrlManager
Obtain the collection which is represented by the given URL
getElement() - Method in class org.purl.sword.base.SwordValidationInfo
Return the element that this information describes.
getEmail() - Method in class org.purl.sword.atom.Author
Get the author email.
getEntry() - Method in class org.purl.sword.base.DepositResponse
Get the SWORD Entry
getErrorCode() - Method in exception org.purl.sword.base.SWORDException
Get the error code
getErrorDocument() - Method in class org.purl.sword.base.DepositResponse
Get the SWORD Entry as an error document
getErrorURI() - Method in class org.purl.sword.base.SWORDErrorDocument
Get the error URI
getErrorURI() - Method in exception org.purl.sword.base.SWORDErrorException
 
getFile() - Method in class org.purl.sword.base.Deposit
 
getFilename(Context, Deposit, boolean) - Method in class org.dspace.sword.SWORDService
Construct the most appropriate filename for the incoming deposit
getFilename() - Method in class org.purl.sword.base.Deposit
Retrieve the filename that is associated with this deposit.
getGenerator() - Method in class org.purl.sword.atom.Entry
Get the generator for this Entry.
getGenerator() - Method in class org.purl.sword.atom.Source
Get the generator.
getGenerator() - Method in class org.purl.sword.base.Service
 
getGeneratorUrl() - Method in class org.dspace.sword.SWORDUrlManager
Get the generator url for atom entry documents.
getHandle() - Method in class org.dspace.sword.DepositResult
 
getHref() - Method in class org.purl.sword.atom.Link
Get the HREF attribute.
getHreflang() - Method in class org.purl.sword.atom.Link
Get the HREF Lang attribute.
getHttpResponse() - Method in class org.purl.sword.base.DepositResponse
Retrieve the HTTP Response code.
getId() - Method in class org.purl.sword.atom.Entry
Get the ID for this Entry.
getInstance(Context, Deposit, DSpaceObject) - Static method in class org.dspace.sword.SWORDIngesterFactory
Generate an object which conforms to the SWORDIngester interface.
getIPAddress() - Method in class org.purl.sword.base.AtomDocumentRequest
Get the IP address of the user
getIPAddress() - Method in class org.purl.sword.base.Deposit
Get the IP address of the user
getIPAddress() - Method in class org.purl.sword.base.ServiceDocumentRequest
Get the IP address of the user
getItem() - Method in class org.dspace.sword.DepositResult
 
getLength() - Method in class org.purl.sword.atom.Link
Get the length.
getLinks() - Method in class org.purl.sword.atom.Entry
Get the list of links for this Entry.
getLocalName() - Method in class org.purl.sword.base.XmlName
Get the local name.
getLocation(Collection) - Method in class org.dspace.sword.CollectionLocation
Obtain the deposit URL for the given collection.
getLocation() - Method in class org.purl.sword.base.AtomDocumentRequest
Get the location of the service document
getLocation() - Method in class org.purl.sword.base.Collection
Get the location.
getLocation() - Method in class org.purl.sword.base.Deposit
Get the location of the deposit
getLocation() - Method in class org.purl.sword.base.DepositResponse
Retrieve the Location header.
getLocation() - Method in class org.purl.sword.base.ServiceDocumentRequest
Get the location of the service document
getMaxUploadSize() - Method in class org.dspace.sword.SWORDConfiguration
what is the max upload size (in bytes) for the sword interface
getMaxUploadSize() - Method in class org.purl.sword.base.Service
Get the maximum upload file size (in kB)
getMd5() - Method in class org.purl.sword.base.Deposit
 
getMediaEntry(String) - Method in class org.dspace.sword.MediaEntryManager
Get the media entry for the given URL request.
getMediaLink() - Method in class org.dspace.sword.DepositResult
 
getMediaLink(Bitstream) - Method in class org.dspace.sword.SWORDUrlManager
get the media link url for the given bitstream
getMediation() - Method in class org.purl.sword.base.Collection
Get the mediation value.
getMessage() - Method in class org.purl.sword.base.SwordValidationInfo
Return the information message.
getName() - Method in class org.purl.sword.atom.Author
Retrieve the author name.
getNamespace() - Method in class org.purl.sword.base.XmlName
Get the current namespace value.
getOnBehalfOf() - Method in class org.dspace.sword.SWORDContext
 
getOnBehalfOf() - Method in class org.purl.sword.base.Deposit
 
getOnBehalfOf() - Method in class org.purl.sword.base.ServiceDocumentRequest
Get the onBehalfOf name.
getOnBehalfOfContext() - Method in class org.dspace.sword.SWORDContext
Get the context of the on-behalf-of user.
getPackaging() - Method in class org.purl.sword.base.Deposit
 
getPackaging() - Method in class org.purl.sword.base.SWORDEntry
Get the packaging format
getPassword() - Method in class org.purl.sword.base.AtomDocumentRequest
Get the password.
getPassword() - Method in class org.purl.sword.base.Deposit
 
getPassword() - Method in class org.purl.sword.base.ServiceDocumentRequest
Get the password.
getPrefix() - Method in class org.purl.sword.base.XmlName
Get the prefix.
getPublished() - Method in class org.purl.sword.atom.Entry
Get the published date, expressed as a String.
getQualifiedName() - Method in class org.purl.sword.base.XmlElement
Retrieve the qualified name for this object.
getQualifiedName(String) - Method in class org.purl.sword.base.XmlElement
Retrieve the qualified name.
getQualifiedName() - Method in class org.purl.sword.base.XmlName
 
getQualifiedNameWithPrefix(String, String) - Method in class org.purl.sword.base.XmlElement
Get the qualified name for the given prefix and name
getQualityValue() - Method in class org.purl.sword.base.QualityValue
Get the quality value
getQualityValue() - Method in class org.purl.sword.base.SwordAcceptPackaging
Get the type.
getRel() - Method in class org.purl.sword.atom.Link
Get the Rel attribute.
getRights() - Method in class org.purl.sword.atom.Entry
Get the rights for this Entry.
getService() - Method in class org.purl.sword.base.Collection
Get the sword service.
getService() - Method in class org.purl.sword.base.ServiceDocument
Retrieve the Service object associated with this document.
getServiceDocument() - Method in class org.dspace.sword.ServiceDocumentManager
Obtain the service document for the repository based on the DSpace context and the SWORD context which must be set for this object prior to calling this method.
getServiceDocument(String) - Method in class org.dspace.sword.ServiceDocumentManager
 
getSlug() - Method in class org.purl.sword.base.Deposit
 
getSource() - Method in class org.purl.sword.atom.Content
Get the Source.
getSource() - Method in class org.purl.sword.atom.Entry
Deprecated. 
getStatus() - Method in exception org.purl.sword.base.SWORDErrorException
 
getSummary() - Method in class org.purl.sword.atom.Entry
Get the summary.
getSwordBundle() - Method in class org.dspace.sword.SWORDConfiguration
Get the bundle name that sword will store its original deposit packages in, when storing them inside an item
getSwordConfig() - Method in class org.dspace.sword.SWORDService
 
getSwordContext() - Method in class org.dspace.sword.SWORDService
 
getSWORDEntry(DSpaceObject) - Method in class org.dspace.sword.DSpaceATOMEntry
get the sword entry for the given dspace object.
getSWORDEntry(DepositResult, Deposit) - Method in class org.dspace.sword.DSpaceATOMEntry
Construct the SWORDEntry object which represents the given item with the given handle.
getTempDir() - Method in class org.dspace.sword.SWORDConfiguration
Get the temp directory for storing files during deposit
getTempFilename() - Method in class org.dspace.sword.SWORDService
Get the name of the temp files that should be used
getTitle() - Method in class org.purl.sword.atom.Entry
Get the title.
getTitle() - Method in class org.purl.sword.atom.Link
Get the title.
getTitle() - Method in class org.purl.sword.base.Collection
Get the title.
getTitle() - Method in class org.purl.sword.base.Workspace
Get the content of the Title element.
getTreatment() - Method in class org.dspace.sword.DepositResult
 
getTreatment() - Method in class org.purl.sword.base.Collection
Get the treatment value.
getTreatment() - Method in class org.purl.sword.base.SWORDEntry
Get the treatment value.
getType() - Method in class org.purl.sword.atom.Content
Get the type.
getType() - Method in class org.purl.sword.atom.Link
Get the type.
getType() - Method in class org.purl.sword.atom.TextConstruct
Get the type.
getType() - Method in class org.purl.sword.base.SwordValidationInfo
Return the type of information.
getUnmarshallAttributeInfoIterator() - Method in class org.purl.sword.base.SwordValidationInfo
 
getUnmarshallElementInfoIterator() - Method in class org.purl.sword.base.SwordValidationInfo
 
getUpdated() - Method in class org.purl.sword.atom.Entry
Get the updated date, expressed as a String.
getUri() - Method in class org.purl.sword.atom.Author
Get the author URI.
getUri() - Method in class org.purl.sword.atom.Generator
Get the URI.
getUrl(HttpServletRequest) - Static method in class org.purl.sword.server.DepositServlet
Utility method to construct the URL called for this Servlet
getUrlManager() - Method in class org.dspace.sword.SWORDService
 
getUserAgent() - Method in class org.purl.sword.base.SWORDEntry
Get the user agent
getUsername() - Method in class org.purl.sword.base.AtomDocumentRequest
Retrieve the username.
getUsername() - Method in class org.purl.sword.base.Deposit
 
getUsername() - Method in class org.purl.sword.base.ServiceDocumentRequest
Retrieve the username.
getUsernamePassword(HttpServletRequest) - Method in class org.purl.sword.server.DepositServlet
Utility method to return the username and password (separated by a colon ':')
getValidationAttributeInfoIterator() - Method in class org.purl.sword.base.SwordValidationInfo
 
getValidationElementInfoIterator() - Method in class org.purl.sword.base.SwordValidationInfo
Return an iterator to view the nested validation info objects.
getVerboseDescription() - Method in class org.dspace.sword.SWORDService
 
getVerboseDescription() - Method in class org.purl.sword.base.SWORDEntry
Get the Verbose Description for this entry.
getVersion() - Method in class org.purl.sword.atom.Generator
Get the version.
getVersion() - Method in class org.purl.sword.base.Service
Get the SWORD version.
getWorkspaces() - Method in class org.purl.sword.base.Service
Get an Iterator over the workspaces.
getWorkspacesList() - Method in class org.purl.sword.base.Service
Get a List of workspaces
getXmlName() - Method in class org.purl.sword.base.XmlElement
 

H

handleIncorrectElement(Element, Properties) - Method in class org.purl.sword.base.XmlElement
 
HttpHeaders - Interface in org.purl.sword.base
Definition of the additional HTTP Header tags that will be used in the SWORD protocol.

I

Id - Class in org.purl.sword.atom
 
Id() - Constructor for class org.purl.sword.atom.Id
 
Id(String) - Constructor for class org.purl.sword.atom.Id
 
ingest(SWORDService, Deposit, DSpaceObject) - Method in class org.dspace.sword.SimpleFileIngester
perform the ingest using the given deposit object onto the specified target dspace object, using the sword service implementation
ingest(SWORDService, Deposit, DSpaceObject) - Method in interface org.dspace.sword.SWORDIngester
Ingest the package as described in the given Deposit object within the given DSpace Context
ingest(SWORDService, Deposit, DSpaceObject) - Method in class org.dspace.sword.SWORDMETSIngester
 
init() - Method in class org.dspace.sword.LoadDSpaceConfig
Deprecated.  
init() - Method in class org.purl.sword.server.AtomDocumentServlet
Initialise the servlet.
init() - Method in class org.purl.sword.server.DepositServlet
Initialise the servlet
init() - Method in class org.purl.sword.server.ServiceDocumentServlet
Initialise the servlet.
initialise() - Method in class org.purl.sword.atom.Entry
 
initialise() - Method in class org.purl.sword.atom.Generator
 
initialise() - Method in class org.purl.sword.atom.TextConstruct
 
initialise() - Method in class org.purl.sword.base.Collection
 
initialise() - Method in class org.purl.sword.base.SwordAcceptPackaging
 
initialise() - Method in class org.purl.sword.base.SWORDEntry
 
initialise() - Method in class org.purl.sword.base.SWORDErrorDocument
 
initialise() - Method in class org.purl.sword.base.Workspace
Initialise the object, ready for use.
instance() - Static method in class org.purl.sword.base.SwordContentPackageTypes
 
InvalidMediaTypeException - Exception in org.purl.sword.atom
An invalid media type has been detected during parsing.
InvalidMediaTypeException(String) - Constructor for exception org.purl.sword.atom.InvalidMediaTypeException
Create a new instance and store the message.
isAcceptableContentType(Context, String, DSpaceObject) - Method in class org.dspace.sword.SWORDConfiguration
is the given content mimetype acceptable to the given dspace object
isBaseMediaLinkUrl(String) - Method in class org.dspace.sword.SWORDUrlManager
is the given url the base media link url
isBaseServiceDocumentUrl(String) - Method in class org.dspace.sword.SWORDUrlManager
is the given url the base service document url
isElementChecked(XmlName) - Method in class org.purl.sword.atom.Entry
 
isElementChecked(XmlName) - Method in class org.purl.sword.base.SWORDEntry
 
isElementChecked(XmlName) - Method in class org.purl.sword.base.SWORDErrorDocument
 
isEmpty() - Method in class org.purl.sword.base.SwordContentPackageTypes
 
isInGroup(Group, EPerson) - Method in class org.dspace.sword.SWORDAuthenticator
Is the given eperson in the given group, or any of the groups that are also members of that group.
isInstanceOf(Element, String, String) - Method in class org.purl.sword.base.XmlElement
Determines if the specified element is an instance of the element name.
isInstanceOf(Element, XmlName) - Method in class org.purl.sword.base.XmlElement
 
isKeepOriginal() - Method in class org.dspace.sword.SWORDConfiguration
should the repository keep the original package
isMediated() - Method in class org.dspace.sword.SWORDConfiguration
does the server support mediated deposit (aka on-behalf-of)
isMediationSet() - Method in class org.purl.sword.base.Collection
 
isNoOp() - Method in class org.dspace.sword.SWORDConfiguration
is this a no-op deposit
isNoOp() - Method in class org.purl.sword.base.Deposit
 
isNoOp() - Method in class org.purl.sword.base.Service
Get the NoOp value.
isNoOp() - Method in class org.purl.sword.base.SWORDEntry
Get the current value of NoOp.
isNoOpSet() - Method in class org.purl.sword.base.Service
Determine if the NoOp value has been set.
isNoOpSet() - Method in class org.purl.sword.base.SWORDEntry
Determine if the noOp value has been set.
isOnBehalfOfAdmin(SWORDContext) - Method in class org.dspace.sword.SWORDAuthenticator
Is the given onBehalfOf user DSpace administrator? This translates as asking the question of whether the given eperson is a member of the special DSpace group Administrator, with id 1
isOnBehalfOfInGroup(SWORDContext, Group) - Method in class org.dspace.sword.SWORDAuthenticator
Is the onBehalfOf user a member of the given group or one of its sub groups
isSet() - Method in class org.purl.sword.base.BasicBooleanContentElement
 
isSet() - Method in class org.purl.sword.base.BasicIntegerContentElement
 
isSupportedMediaType(String, DSpaceObject) - Method in class org.dspace.sword.SWORDConfiguration
is the given packaging/media type supported by the given dspace object
isUserAdmin(SWORDContext) - Method in class org.dspace.sword.SWORDAuthenticator
Is the authenticated user a DSpace administrator? This translates as asking the question of whether the given eperson is a member of the special DSpace group Administrator, with id 1
isUserInGroup(SWORDContext, Group) - Method in class org.dspace.sword.SWORDAuthenticator
Is the authenticated user a member of the given group or one of its sub groups?
isValidType(String) - Method in class org.purl.sword.base.SwordContentPackageTypes
 
isVerbose() - Method in class org.dspace.sword.SWORDConfiguration
is this a verbose deposit
isVerbose() - Method in class org.dspace.sword.SWORDService
 
isVerbose() - Method in class org.purl.sword.base.Deposit
 
isVerbose() - Method in class org.purl.sword.base.Service
Get the Verbose setting.
isVerboseSet() - Method in class org.purl.sword.base.Service
Determine if the Verbose value has been set.
item - Variable in class org.dspace.sword.DSpaceATOMEntry
the item this ATOM entry represents
ItemCollectionGenerator - Class in org.dspace.sword
 
ItemCollectionGenerator(SWORDService) - Constructor for class org.dspace.sword.ItemCollectionGenerator
 
ItemDepositor - Class in org.dspace.sword
 
ItemDepositor(SWORDService, DSpaceObject) - Constructor for class org.dspace.sword.ItemDepositor
 
ItemEntryGenerator - Class in org.dspace.sword
 
ItemEntryGenerator(SWORDService) - Constructor for class org.dspace.sword.ItemEntryGenerator
 

K

keys() - Method in class org.purl.sword.base.SwordContentPackageTypes
 

L

Link - Class in org.purl.sword.atom
Represents an ATOM Link element.
Link() - Constructor for class org.purl.sword.atom.Link
Create a new instance and set prefix and local name to 'atom' and 'link', respectively.
LoadDSpaceConfig - Class in org.dspace.sword
Deprecated. Use Servlet Context Listener provided in dspace-api (remove in > 1.5.x)
LoadDSpaceConfig() - Constructor for class org.dspace.sword.LoadDSpaceConfig
Deprecated.  
log - Static variable in class org.dspace.sword.CollectionLocation
Log4j logger
log - Static variable in class org.dspace.sword.DepositManager
Log4j logger
log - Static variable in class org.dspace.sword.DSpaceSWORDServer
Log4j logger
log - Static variable in class org.dspace.sword.SWORDMETSIngester
Log4j logger
log - Static variable in class org.dspace.sword.SWORDService
Log4j logging instance

M

main(String[]) - Static method in class org.purl.sword.base.ChecksumUtils
Run a simple test to process the file.
makeErrorDocument(String, int, String, HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.DepositServlet
Utility method to construct a SWORDErrorDocumentTest
marshall() - Method in class org.purl.sword.atom.Author
Marshall the data in this object to a XOM Element.
marshall() - Method in class org.purl.sword.atom.Content
Marshall the data in this object to an Element object.
marshall() - Method in class org.purl.sword.atom.Entry
Mashall the data stored in this object into Element objects.
marshall() - Method in class org.purl.sword.atom.Generator
Marshall the data in the object to an Element object.
marshall() - Method in class org.purl.sword.atom.Link
Mashall the data stored in this object into Element objects.
marshall() - Method in class org.purl.sword.atom.Source
Marshall the data stored in this object into Element objects.
marshall() - Method in class org.purl.sword.atom.TextConstruct
Marshall the data in this object to an Element object.
marshall() - Method in class org.purl.sword.base.BasicContentElement
Marshall the data in this object to an Element object.
marshall() - Method in class org.purl.sword.base.Collection
Marshall the data in this object to an Element object.
marshall() - Method in class org.purl.sword.base.DepositResponse
Marshall the data in the enclosed SWORD Entry.
marshall() - Method in class org.purl.sword.base.Service
Marshall the data in this object to an Element object.
marshall() - Method in class org.purl.sword.base.ServiceDocument
Marshall the data in the Service element and generate a String representation.
marshall() - Method in class org.purl.sword.base.SwordAcceptPackaging
Marshall the data in this object to an Element object.
marshall() - Method in interface org.purl.sword.base.SwordElementInterface
Marshall the data in the object to the XOM Element.
marshall() - Method in class org.purl.sword.base.SWORDEntry
Overrides the marshall method in the parent Entry.
marshall() - Method in class org.purl.sword.base.SWORDErrorDocument
Overrides the marshall method in the parent SWORDEntry.
marshall() - Method in class org.purl.sword.base.Workspace
Marshall the data in this element to an Element.
marshallContent(Element) - Method in class org.purl.sword.base.BasicBooleanContentElement
 
marshallContent(Element) - Method in class org.purl.sword.base.BasicContentElement
 
marshallContent(Element) - Method in class org.purl.sword.base.BasicIntegerContentElement
 
marshallContent(Element) - Method in class org.purl.sword.base.BasicStringContentElement
 
marshallElements(Element) - Method in class org.purl.sword.atom.Entry
 
marshallElements(Element) - Method in class org.purl.sword.base.SWORDEntry
 
MAX_UPLOAD_SIZE_EXCEEDED - Static variable in interface org.purl.sword.base.ErrorCodes
MediationNotAllowed - where a client has attempted a mediated deposit, but this is not supported by the server
MEDIA_UNAVAILABLE - Static variable in interface org.dspace.sword.DSpaceSWORDErrorCodes
if the media requested is unavailable
MediaEntryManager - Class in org.dspace.sword
 
MediaEntryManager(SWORDService) - Constructor for class org.dspace.sword.MediaEntryManager
 
MEDIATION_NOT_ALLOWED - Static variable in interface org.purl.sword.base.ErrorCodes
MediationNotAllowed - where a client has attempted a mediated deposit, but this is not supported by the server
message(String) - Method in class org.dspace.sword.SWORDService
shortcut to registering a message with the verboseDescription member variable.
MISSING_ATTRIBUTE_WARNING - Static variable in class org.purl.sword.base.SwordValidationInfo
 
MISSING_CONTENT - Static variable in class org.purl.sword.base.SwordValidationInfo
 
MISSING_ELEMENT_ERROR - Static variable in class org.purl.sword.base.SwordValidationInfo
 
MISSING_ELEMENT_WARNING - Static variable in class org.purl.sword.base.SwordValidationInfo
 
myRepository - Variable in class org.purl.sword.server.DepositServlet
Sword repository

N

Name - Class in org.purl.sword.atom
 
Name() - Constructor for class org.purl.sword.atom.Name
 
Name(String) - Constructor for class org.purl.sword.atom.Name
 
Namespaces - Interface in org.purl.sword.base
List of the namespaces that are used by SWORD.
NS_APP - Static variable in interface org.purl.sword.base.Namespaces
Atom Publishing Protocol (APP) Namespace.
NS_ATOM - Static variable in interface org.purl.sword.base.Namespaces
ATOM Namespace.
NS_DC_TERMS - Static variable in interface org.purl.sword.base.Namespaces
DC Terms Namespace.
NS_SWORD - Static variable in interface org.purl.sword.base.Namespaces
Sword Namespace.

O

org.dspace.sword - package org.dspace.sword
 
org.purl.sword.atom - package org.purl.sword.atom
This package contains a collection of classes to represent the use of the ATOM Entry document within the SWORD profile.
org.purl.sword.base - package org.purl.sword.base
This package contains the base set of classes that are used by the demonstration SWORD Servers and SWORD Clients.
org.purl.sword.server - package org.purl.sword.server
 

P

PREFIX_APP - Static variable in interface org.purl.sword.base.Namespaces
APP Prefix.
PREFIX_ATOM - Static variable in interface org.purl.sword.base.Namespaces
ATOM Prefix.
PREFIX_DC_TERMS - Static variable in interface org.purl.sword.base.Namespaces
DC Terms Prefix.
PREFIX_SWORD - Static variable in interface org.purl.sword.base.Namespaces
SWORD Prefix.
processUnexpectedAttributes(Element, SwordValidationInfo) - Method in class org.purl.sword.base.SWORDErrorDocument
This method overrides the XmlElement definition so that it can allow the definition of the href attribute.
processUnexpectedAttributes(Element, ArrayList<SwordValidationInfo>) - Method in class org.purl.sword.base.XmlElement
 
processUnexpectedAttributes(Element, SwordValidationInfo) - Method in class org.purl.sword.base.XmlElement
Add the information to the unmarshall attribute section of the specified info object.
Published - Class in org.purl.sword.atom
 
Published() - Constructor for class org.purl.sword.atom.Published
 
Published(String) - Constructor for class org.purl.sword.atom.Published
 

Q

QualityValue - Class in org.purl.sword.base
A representation of a quality value.
QualityValue() - Constructor for class org.purl.sword.base.QualityValue
Create a quality value defaulting to 1
QualityValue(float) - Constructor for class org.purl.sword.base.QualityValue
Create a quality value

R

reset() - Method in class org.dspace.sword.DSpaceATOMEntry
Reset all the internal variables of the class to their original values
resetType() - Method in class org.purl.sword.base.SwordValidationInfo
 
resetType(Iterator<SwordValidationInfo>) - Method in class org.purl.sword.base.SwordValidationInfo
 
result - Variable in class org.dspace.sword.DSpaceATOMEntry
the deposit result
Rights - Class in org.purl.sword.atom
Represents an ATOM Rights element.
Rights() - Constructor for class org.purl.sword.atom.Rights
Create a new instance and set the prefix to 'atom' and the local name to 'rights'.

S

Service - Class in org.purl.sword.base
Represents an Atom Publishing Protocol Service element, with SWORD extensions.
Service() - Constructor for class org.purl.sword.base.Service
Create a new instance.
Service(String) - Constructor for class org.purl.sword.base.Service
Create a new instance.
Service(String, boolean, boolean) - Constructor for class org.purl.sword.base.Service
Create a new instance with the specified compliance level, noOp and verbose values.
ServiceDocument - Class in org.purl.sword.base
A representation of a SWORD Service Document.
ServiceDocument() - Constructor for class org.purl.sword.base.ServiceDocument
Create a new instance and set the initial service level to Zero.
ServiceDocument(String) - Constructor for class org.purl.sword.base.ServiceDocument
Create a new instance and set the specified service level.
ServiceDocument(Service) - Constructor for class org.purl.sword.base.ServiceDocument
Create a new instance and store the specified Service document.
ServiceDocumentManager - Class in org.dspace.sword
 
ServiceDocumentManager(SWORDService) - Constructor for class org.dspace.sword.ServiceDocumentManager
 
ServiceDocumentRequest - Class in org.purl.sword.base
Represents a ServiceDocumentRequest.
ServiceDocumentRequest() - Constructor for class org.purl.sword.base.ServiceDocumentRequest
 
ServiceDocumentServlet - Class in org.purl.sword.server
ServiceDocumentServlet
ServiceDocumentServlet() - Constructor for class org.purl.sword.server.ServiceDocumentServlet
 
setAbstract(String) - Method in class org.purl.sword.base.Collection
Set the abstract.
setAttribute(XmlName) - Method in class org.purl.sword.base.SwordValidationInfo
Set the attribute that this information describes.
setAuthenticated(EPerson) - Method in class org.dspace.sword.SWORDContext
 
setAuthenticatorContext(Context) - Method in class org.dspace.sword.SWORDContext
 
setBitstream(Bitstream) - Method in class org.dspace.sword.DepositResult
 
setCollectionPolicy(String) - Method in class org.purl.sword.base.Collection
Set the collection policy.
setContent(Content) - Method in class org.purl.sword.atom.Entry
Set the content element for this Entry.
setContent(String) - Method in class org.purl.sword.atom.Generator
Set the content.
setContent(String) - Method in class org.purl.sword.atom.Link
Set the content.
setContent(String) - Method in class org.purl.sword.atom.TextConstruct
Set the content.
setContent(boolean) - Method in class org.purl.sword.base.BasicBooleanContentElement
 
setContent(int) - Method in class org.purl.sword.base.BasicIntegerContentElement
 
setContent(String) - Method in class org.purl.sword.base.BasicStringContentElement
 
setContent(String) - Method in class org.purl.sword.base.SwordAcceptPackaging
Set the content.
setContentDescription(String) - Method in class org.purl.sword.base.SwordValidationInfo
 
setContentDisposition(String) - Method in class org.purl.sword.base.Deposit
Set the content disposition that is to be used for this deposit.
setContentLength(int) - Method in class org.purl.sword.base.Deposit
 
setContentType(String) - Method in class org.purl.sword.base.Deposit
 
setContext(Context) - Method in class org.dspace.sword.SWORDContext
 
setDepositID(String) - Method in class org.purl.sword.base.Deposit
 
setElement(XmlName) - Method in class org.purl.sword.base.SwordValidationInfo
Set the element that this information describes.
setEmail(String) - Method in class org.purl.sword.atom.Author
Set the author email.
setEntry(SWORDEntry) - Method in class org.purl.sword.base.DepositResponse
Set the entry element for this response.
setErrorURI(String) - Method in class org.purl.sword.base.SWORDErrorDocument
set the error URI
setFile(InputStream) - Method in class org.purl.sword.base.Deposit
 
setGenerator(Generator) - Method in class org.purl.sword.atom.Entry
Set the generator for this Entry.
setGenerator(Generator) - Method in class org.purl.sword.atom.Source
Set the generator.
setGenerator(Generator) - Method in class org.purl.sword.base.Service
 
setHandle(String) - Method in class org.dspace.sword.DepositResult
 
setHref(String) - Method in class org.purl.sword.atom.Link
Set the HREF attribute.
setHreflang(String) - Method in class org.purl.sword.atom.Link
Set the HREF Lang attribute.
setHttpResponse(int) - Method in class org.purl.sword.base.DepositResponse
Set the HTTP Response code.
setId(String) - Method in class org.purl.sword.atom.Entry
Set the ID for this Entry.
setIPAddress(String) - Method in class org.purl.sword.base.AtomDocumentRequest
Set the IP address of the user
setIPAddress(String) - Method in class org.purl.sword.base.Deposit
Set the IP address of the user
setIPAddress(String) - Method in class org.purl.sword.base.ServiceDocumentRequest
Set the IP address of the user
setItem(Item) - Method in class org.dspace.sword.DepositResult
 
setKeepOriginal(boolean) - Method in class org.dspace.sword.SWORDConfiguration
set whether the repository should keep copies of the original package
setLength(String) - Method in class org.purl.sword.atom.Link
Set the length.
setLocalName(String) - Method in class org.purl.sword.base.XmlName
Set the local name.
setLocation(String) - Method in class org.purl.sword.base.AtomDocumentRequest
Set the location of the service document
setLocation(String) - Method in class org.purl.sword.base.Collection
Set the location.
setLocation(String) - Method in class org.purl.sword.base.Deposit
Set the location of the deposit
setLocation(String) - Method in class org.purl.sword.base.DepositResponse
Set the HTTP Location header.
setLocation(String) - Method in class org.purl.sword.base.ServiceDocumentRequest
Set the location of the service document
setMaxUploadSize(int) - Method in class org.dspace.sword.SWORDConfiguration
set the max uplaod size (in bytes) for the sword interface
setMaxUploadSize(int) - Method in class org.purl.sword.base.Service
Set the maximum file upload size in kB
setMd5(String) - Method in class org.purl.sword.base.Deposit
 
setMediaLink(String) - Method in class org.dspace.sword.DepositResult
 
setMediated(boolean) - Method in class org.dspace.sword.SWORDConfiguration
set whether the server supports mediated deposit (aka on-behalf-of)
setMediation(boolean) - Method in class org.purl.sword.base.Collection
Set the mediation value.
setMessage(String) - Method in class org.purl.sword.base.SwordValidationInfo
Set the information message.
setName(String) - Method in class org.purl.sword.atom.Author
Set the author name.
setNamespace(String) - Method in class org.purl.sword.base.XmlName
Set the namespace value.
setNoOp(boolean) - Method in class org.dspace.sword.SWORDConfiguration
set whether this is a no-op deposit
setNoOp(boolean) - Method in class org.purl.sword.base.Deposit
 
setNoOp(boolean) - Method in class org.purl.sword.base.Service
Set the NoOp value.
setNoOp(boolean) - Method in class org.purl.sword.base.SWORDEntry
Call this method to set noOp.
setOnBehalfOf(EPerson) - Method in class org.dspace.sword.SWORDContext
 
setOnBehalfOf(String) - Method in class org.purl.sword.base.Deposit
 
setOnBehalfOf(String) - Method in class org.purl.sword.base.ServiceDocumentRequest
Set the onBehalfOf name.
setPackaging(String) - Method in class org.purl.sword.base.Deposit
 
setPackaging(String) - Method in class org.purl.sword.base.SWORDEntry
Set the packaging format
setPassword(String) - Method in class org.purl.sword.base.AtomDocumentRequest
Set the password.
setPassword(String) - Method in class org.purl.sword.base.Deposit
 
setPassword(String) - Method in class org.purl.sword.base.ServiceDocumentRequest
Set the password.
setPrefix(String) - Method in class org.purl.sword.base.XmlName
Set the prefix.
setPublished(String) - Method in class org.purl.sword.atom.Entry
Set the published date.
setQualityValue(float) - Method in class org.purl.sword.base.QualityValue
Set the quality value.
setQualityValue(QualityValue) - Method in class org.purl.sword.base.SwordAcceptPackaging
Set the type.
setRel(String) - Method in class org.purl.sword.atom.Link
Set the Rel attribute.
setRights(Rights) - Method in class org.purl.sword.atom.Entry
Set the rights for this Entry.
setService(String) - Method in class org.purl.sword.base.Collection
Set the sword service.
setService(Service) - Method in class org.purl.sword.base.ServiceDocument
Set the service object associated with this document.
setSlug(String) - Method in class org.purl.sword.base.Deposit
 
setSource(String) - Method in class org.purl.sword.atom.Content
Set the Source.
setSource(Source) - Method in class org.purl.sword.atom.Entry
Deprecated. 
setStatus(int) - Method in exception org.purl.sword.base.SWORDErrorException
Set the status
setSummary(Summary) - Method in class org.purl.sword.atom.Entry
Set the summary.
setSwordBundle(String) - Method in class org.dspace.sword.SWORDConfiguration
Set the bundle name that sword will store its original deposit packages in, when storing them inside an item
setSwordConfig(SWORDConfiguration) - Method in class org.dspace.sword.SWORDService
 
setSwordContext(SWORDContext) - Method in class org.dspace.sword.SWORDService
 
setTitle(Title) - Method in class org.purl.sword.atom.Entry
Set the title.
setTitle(String) - Method in class org.purl.sword.atom.Link
Set the title.
setTitle(String) - Method in class org.purl.sword.base.Collection
Set the title.
setTitle(String) - Method in class org.purl.sword.base.Workspace
Set the title.
setTreatment(String) - Method in class org.dspace.sword.DepositResult
 
setTreatment(String) - Method in class org.purl.sword.base.Collection
Set the treatment.
setTreatment(String) - Method in class org.purl.sword.base.SWORDEntry
Set the treatment value.
setType(String) - Method in class org.purl.sword.atom.Content
Set the type for the content.
setType(String) - Method in class org.purl.sword.atom.Link
Set the type.
setType(ContentType) - Method in class org.purl.sword.atom.TextConstruct
Set the type.
setType(SwordValidationInfoType) - Method in class org.purl.sword.base.SwordValidationInfo
Set the type of information
setUpdated(String) - Method in class org.purl.sword.atom.Entry
Set the updated date.
setUri(String) - Method in class org.purl.sword.atom.Author
Set the author URI.
setUri(String) - Method in class org.purl.sword.atom.Generator
Set the URI.
setUrlManager(SWORDUrlManager) - Method in class org.dspace.sword.SWORDService
 
setUserAgent(String) - Method in class org.purl.sword.base.SWORDEntry
Set the user agent
setUsername(String) - Method in class org.purl.sword.base.AtomDocumentRequest
Set the username.
setUsername(String) - Method in class org.purl.sword.base.Deposit
 
setUsername(String) - Method in class org.purl.sword.base.ServiceDocumentRequest
Set the username.
setVerbose(boolean) - Method in class org.dspace.sword.SWORDConfiguration
set whether this is a verbose deposit
setVerbose(boolean) - Method in class org.dspace.sword.SWORDService
 
setVerbose(boolean) - Method in class org.purl.sword.base.Deposit
 
setVerbose(boolean) - Method in class org.purl.sword.base.Service
Set the Verbose value.
setVerboseDescription(String) - Method in class org.purl.sword.base.SWORDEntry
Set the verbose description.
setVersion(String) - Method in class org.purl.sword.atom.Generator
Set the version.
setVersion(String) - Method in class org.purl.sword.base.Service
Set the SWORD version.
SimpleFileIngester - Class in org.dspace.sword
 
SimpleFileIngester() - Constructor for class org.dspace.sword.SimpleFileIngester
 
SLUG - Static variable in interface org.purl.sword.base.HttpHeaders
The Slug header.
SOFTWARE_URI - Static variable in interface org.dspace.sword.SWORDProperties
 
Source - Class in org.purl.sword.atom
Represents an ATOM Generator element.
Source() - Constructor for class org.purl.sword.atom.Source
Create a new instance and set the prefix to 'atom' and the local name to 'source'.
Summary - Class in org.purl.sword.atom
Represents an ATOM Summary element.
Summary() - Constructor for class org.purl.sword.atom.Summary
Create a new instance and set the prefix to 'atom' and the local name to 'summary'.
SwordAcceptPackaging - Class in org.purl.sword.base
Represents a text construct in the ATOM elements.
SwordAcceptPackaging() - Constructor for class org.purl.sword.base.SwordAcceptPackaging
 
SwordAcceptPackaging(String, float) - Constructor for class org.purl.sword.base.SwordAcceptPackaging
 
SwordAcceptPackaging(String, QualityValue) - Constructor for class org.purl.sword.base.SwordAcceptPackaging
 
SWORDAuthentication - Class in org.dspace.sword
This class offers a thin wrapper for the default DSpace authentication module for the SWORD implementation
SWORDAuthentication() - Constructor for class org.dspace.sword.SWORDAuthentication
 
SWORDAuthenticationException - Exception in org.purl.sword.base
Represents a SWORD exception to be thrown if bad authentication credentials are passed to a repository.
SWORDAuthenticationException(String, Exception) - Constructor for exception org.purl.sword.base.SWORDAuthenticationException
Create a new instance and store the specified message and source data.
SWORDAuthenticationException(String) - Constructor for exception org.purl.sword.base.SWORDAuthenticationException
Create a new instance and store the specified message.
SWORDAuthenticator - Class in org.dspace.sword
This class offers a thin wrapper for the default DSpace authentication module for the SWORD implementation
SWORDAuthenticator() - Constructor for class org.dspace.sword.SWORDAuthenticator
 
SwordCollectionPolicy - Class in org.purl.sword.base
 
SwordCollectionPolicy() - Constructor for class org.purl.sword.base.SwordCollectionPolicy
 
SwordCollectionPolicy(String) - Constructor for class org.purl.sword.base.SwordCollectionPolicy
 
SWORDConfiguration - Class in org.dspace.sword
 
SWORDConfiguration() - Constructor for class org.dspace.sword.SWORDConfiguration
Initialise the sword configuration.
SwordContentPackageTypes - Class in org.purl.sword.base
 
SwordContentPackageTypes() - Constructor for class org.purl.sword.base.SwordContentPackageTypes
 
SWORDContext - Class in org.dspace.sword
This class holds information about authenticated users (both the depositing user and the on-behalf-of user), and their associated DSpace Context objects.
SWORDContext() - Constructor for class org.dspace.sword.SWORDContext
 
SwordElementInterface - Interface in org.purl.sword.base
Common methods that should be supported by all classes that represent data in the SWORD api.
SWORDEntry - Class in org.purl.sword.base
Extension of the ATOM Entry class.
SWORDEntry(String, String, String) - Constructor for class org.purl.sword.base.SWORDEntry
Create a new SWORDEntry with the given namespace and element.
SWORDEntry() - Constructor for class org.purl.sword.base.SWORDEntry
A default constructor.
SWORDEntry(XmlName) - Constructor for class org.purl.sword.base.SWORDEntry
 
SWORDErrorDocument - Class in org.purl.sword.base
Extension of the SWORD Entry class, specialized for Error Documents.
SWORDErrorDocument() - Constructor for class org.purl.sword.base.SWORDErrorDocument
Create the error document (intended to be used when unmarshalling an error document as this will set the errorURI)
SWORDErrorDocument(String) - Constructor for class org.purl.sword.base.SWORDErrorDocument
Create the error document
SWORDErrorException - Exception in org.purl.sword.base
Represents a generic SWORD exception.
SWORDErrorException(String, String) - Constructor for exception org.purl.sword.base.SWORDErrorException
Create a new instance and store the specified data.
SWORDException - Exception in org.purl.sword.base
Represents a generic SWORD exception.
SWORDException(String, Exception) - Constructor for exception org.purl.sword.base.SWORDException
Create a new instance and store the specified message and source data.
SWORDException(String, Exception, String) - Constructor for exception org.purl.sword.base.SWORDException
Create a new instance and store the specified message and source data.
SWORDException(String) - Constructor for exception org.purl.sword.base.SWORDException
Create a new instance and store the specified message.
SWORDIngester - Interface in org.dspace.sword
Interface behind which can be implemented ingest mechanisms for SWORD deposit requests.
SWORDIngesterFactory - Class in org.dspace.sword
Factory class which will mint objects conforming to the SWORDIngester interface.
SWORDIngesterFactory() - Constructor for class org.dspace.sword.SWORDIngesterFactory
 
SwordMaxUploadSize - Class in org.purl.sword.base
 
SwordMaxUploadSize() - Constructor for class org.purl.sword.base.SwordMaxUploadSize
 
SwordMaxUploadSize(int) - Constructor for class org.purl.sword.base.SwordMaxUploadSize
 
SwordMediation - Class in org.purl.sword.base
 
SwordMediation() - Constructor for class org.purl.sword.base.SwordMediation
 
SwordMediation(boolean) - Constructor for class org.purl.sword.base.SwordMediation
 
SWORDMETSIngester - Class in org.dspace.sword
 
SWORDMETSIngester() - Constructor for class org.dspace.sword.SWORDMETSIngester
 
swordNoOp - Variable in class org.purl.sword.base.SWORDEntry
Specifies whether the document was run in noOp mode, i.e.
SwordNoOp - Class in org.purl.sword.base
 
SwordNoOp() - Constructor for class org.purl.sword.base.SwordNoOp
 
SwordNoOp(boolean) - Constructor for class org.purl.sword.base.SwordNoOp
 
SwordPackaging - Class in org.purl.sword.base
 
SwordPackaging() - Constructor for class org.purl.sword.base.SwordPackaging
 
SwordPackaging(String) - Constructor for class org.purl.sword.base.SwordPackaging
 
SWORDProperties - Interface in org.dspace.sword
 
SWORDServer - Interface in org.purl.sword.server
An abstract interface to be implemented by repositories wishing to provide a SWORD compliant service.
swordService - Variable in class org.dspace.sword.ATOMCollectionGenerator
the sword service definition
swordService - Variable in class org.dspace.sword.Depositor
The sword service implementation
swordService - Variable in class org.dspace.sword.DSpaceATOMEntry
sword service implementation
SWORDService - Class in org.dspace.sword
 
SWORDService(SWORDContext) - Constructor for class org.dspace.sword.SWORDService
Construct a new service instance around the given authenticated sword context
SwordService - Class in org.purl.sword.base
 
SwordService() - Constructor for class org.purl.sword.base.SwordService
 
SwordService(String) - Constructor for class org.purl.sword.base.SwordService
 
swordTreatment - Variable in class org.purl.sword.base.SWORDEntry
Used for a human readable statement about what treatment the deposited resource has received.
SwordTreatment - Class in org.purl.sword.base
 
SwordTreatment() - Constructor for class org.purl.sword.base.SwordTreatment
 
SwordTreatment(String) - Constructor for class org.purl.sword.base.SwordTreatment
 
SWORDUrlManager - Class in org.dspace.sword
 
SWORDUrlManager(SWORDConfiguration, Context) - Constructor for class org.dspace.sword.SWORDUrlManager
 
swordUserAgent - Variable in class org.purl.sword.base.SWORDEntry
The user agent
SwordUserAgent - Class in org.purl.sword.base
 
SwordUserAgent() - Constructor for class org.purl.sword.base.SwordUserAgent
 
SwordUserAgent(String) - Constructor for class org.purl.sword.base.SwordUserAgent
 
SwordValidationInfo - Class in org.purl.sword.base
Represents an validation information item about the elements/attributes.
SwordValidationInfo(XmlName) - Constructor for class org.purl.sword.base.SwordValidationInfo
Create a new information object for the specified element.
SwordValidationInfo(XmlName, XmlName) - Constructor for class org.purl.sword.base.SwordValidationInfo
Create a new information object for the specified element's attribute.
SwordValidationInfo(XmlName, String, SwordValidationInfoType) - Constructor for class org.purl.sword.base.SwordValidationInfo
Create a new instance of a validation information object that reports on an element.
SwordValidationInfo(XmlName, XmlName, String, SwordValidationInfoType) - Constructor for class org.purl.sword.base.SwordValidationInfo
Create a new instance of a validation information object that reports on an attribute in the specified element.
SwordValidationInfoType - Enum in org.purl.sword.base
 
SwordVerbose - Class in org.purl.sword.base
 
SwordVerbose() - Constructor for class org.purl.sword.base.SwordVerbose
 
SwordVerbose(boolean) - Constructor for class org.purl.sword.base.SwordVerbose
 
swordVerboseDescription - Variable in class org.purl.sword.base.SWORDEntry
Use to supply a verbose description.
SwordVerboseDescription - Class in org.purl.sword.base
 
SwordVerboseDescription() - Constructor for class org.purl.sword.base.SwordVerboseDescription
 
SwordVerboseDescription(String) - Constructor for class org.purl.sword.base.SwordVerboseDescription
 
SwordVersion - Class in org.purl.sword.base
 
SwordVersion() - Constructor for class org.purl.sword.base.SwordVersion
 
SwordVersion(String) - Constructor for class org.purl.sword.base.SwordVersion
 

T

TARGET_OWNER_UKNOWN - Static variable in interface org.purl.sword.base.ErrorCodes
TargetOwnerUnknown - where the server cannot identify the specified TargetOwner
TextConstruct - Class in org.purl.sword.atom
Represents a text construct in the ATOM elements.
TextConstruct(String, String) - Constructor for class org.purl.sword.atom.TextConstruct
Create a new instance, specifying the prefix and local name.
TextConstruct(String) - Constructor for class org.purl.sword.atom.TextConstruct
Create a new instance.
TextConstruct(XmlName) - Constructor for class org.purl.sword.atom.TextConstruct
Create a new instance.
TextConstruct(String, String, String) - Constructor for class org.purl.sword.atom.TextConstruct
 
Title - Class in org.purl.sword.atom
Represents an ATOM Title element.
Title() - Constructor for class org.purl.sword.atom.Title
Create a new instance and set the prefix to 'atom' and the local name to 'title'.
toString() - Method in class org.purl.sword.atom.Author
Return the string.
toString() - Method in class org.purl.sword.atom.Content
Get a string representation.
toString() - Method in enum org.purl.sword.atom.ContentType
Retrieve a string representation of this object.
toString() - Method in class org.purl.sword.atom.Generator
Get a string representation.
toString() - Method in class org.purl.sword.atom.Link
 
toString() - Method in class org.purl.sword.atom.TextConstruct
Get a string representation.
toString() - Method in class org.purl.sword.base.Collection
Get a string representation of this object.
toString() - Method in class org.purl.sword.base.DepositResponse
Retrieve a string representation of this data.
toString() - Method in class org.purl.sword.base.QualityValue
Get a String representation of this quality value
toString() - Method in class org.purl.sword.base.ServiceDocument
Return the Service Document in it's XML form.
toString() - Method in class org.purl.sword.base.SwordAcceptPackaging
Get a string representation.
toString() - Method in class org.purl.sword.base.SwordValidationInfo
 

U

undoDeposit(DepositResult) - Method in class org.dspace.sword.CollectionDepositor
Reverse any changes which may have resulted as the consequence of a deposit.
undoDeposit(DepositResult) - Method in class org.dspace.sword.Depositor
Undo any changes to the archive effected by the deposit
undoDeposit(DepositResult) - Method in class org.dspace.sword.ItemDepositor
 
UNKNOWN_ATTRIBUTE - Static variable in class org.purl.sword.base.SwordValidationInfo
 
UNKNOWN_ELEMENT - Static variable in class org.purl.sword.base.SwordValidationInfo
 
unmarshall(Element, Properties) - Method in class org.purl.sword.atom.Author
Unmarshall the author details from the specified element.
unmarshall(Element) - Method in class org.purl.sword.atom.Author
Unmarshall the author details from the specified element.
unmarshall(Element) - Method in class org.purl.sword.atom.Content
 
unmarshall(Element, Properties) - Method in class org.purl.sword.atom.Content
Unmarshall the content element into the data in this object.
unmarshall(Element) - Method in class org.purl.sword.atom.Entry
Unmarshall the contents of the Entry element into the internal data objects in this object.
unmarshall(Element, Properties) - Method in class org.purl.sword.atom.Entry
 
unmarshall(Element) - Method in class org.purl.sword.atom.Generator
Unmarshall the specified Generator element into the data in this object.
unmarshall(Element, Properties) - Method in class org.purl.sword.atom.Generator
 
unmarshall(Element) - Method in class org.purl.sword.atom.Link
Unmarshall the contents of the Link element into the internal data objects in this object.
unmarshall(Element, Properties) - Method in class org.purl.sword.atom.Link
 
unmarshall(Element) - Method in class org.purl.sword.atom.Source
Unmarshall the contents of the source element into the internal data objects in this object.
unmarshall(Element, Properties) - Method in class org.purl.sword.atom.Source
 
unmarshall(Element) - Method in class org.purl.sword.atom.TextConstruct
Unmarshall the text element into this object.
unmarshall(Element, Properties) - Method in class org.purl.sword.atom.TextConstruct
 
unmarshall(Element, Properties) - Method in class org.purl.sword.base.BasicContentElement
Unmarshall the text element into this object.
unmarshall(Element) - Method in class org.purl.sword.base.BasicContentElement
 
unmarshall(Element) - Method in class org.purl.sword.base.Collection
Unmarshall the content element into the data in this object.
unmarshall(Element, Properties) - Method in class org.purl.sword.base.Collection
 
unmarshall(String) - Method in class org.purl.sword.base.DepositResponse
Unmarshall the specified XML data into a SWORD Entry.
unmarshall(String, Properties) - Method in class org.purl.sword.base.DepositResponse
 
unmarshall(Element) - Method in class org.purl.sword.base.Service
Unmarshall the content element into the data in this object.
unmarshall(Element, Properties) - Method in class org.purl.sword.base.Service
 
unmarshall(String) - Method in class org.purl.sword.base.ServiceDocument
Convert the specified XML string into a set of objects used within the service.
unmarshall(String, Properties) - Method in class org.purl.sword.base.ServiceDocument
 
unmarshall(Element) - Method in class org.purl.sword.base.ServiceDocument
Unmarshall the specified element.
unmarshall(Element, Properties) - Method in class org.purl.sword.base.ServiceDocument
Unmarshall the specified element, and return the generated validation information.
unmarshall(Element, Properties) - Method in class org.purl.sword.base.SwordAcceptPackaging
Unmarshall the text element into this object.
unmarshall(Element) - Method in class org.purl.sword.base.SwordAcceptPackaging
 
unmarshall(Element) - Method in interface org.purl.sword.base.SwordElementInterface
Unmarshall the data in the specified element and store it in the object.
unmarshall(Element, Properties) - Method in class org.purl.sword.base.SWORDEntry
 
unmarshall(Element) - Method in class org.purl.sword.base.SWORDEntry
Overrides the unmarshall method in the parent Entry.
unmarshall(Element) - Method in class org.purl.sword.base.SWORDErrorDocument
Overrides the unmarshall method in the parent SWORDEntry.
unmarshall(Element, Properties) - Method in class org.purl.sword.base.SWORDErrorDocument
 
unmarshall(Element) - Method in class org.purl.sword.base.Workspace
Unmarshall the workspace element into the data in this object.
unmarshall(Element, Properties) - Method in class org.purl.sword.base.Workspace
 
unmarshallBoolean(Element) - Method in class org.purl.sword.base.XmlElement
Extract a boolean value from the specified element.
unmarshallContent(Element) - Method in class org.purl.sword.base.BasicBooleanContentElement
 
unmarshallContent(Element) - Method in class org.purl.sword.base.BasicContentElement
 
unmarshallContent(Element) - Method in class org.purl.sword.base.BasicIntegerContentElement
 
unmarshallContent(Element) - Method in class org.purl.sword.base.BasicStringContentElement
 
unmarshallErrorDocument(String) - Method in class org.purl.sword.base.DepositResponse
 
unmarshallErrorDocument(String, Properties) - Method in class org.purl.sword.base.DepositResponse
Unmarshall the specified XML data into a SWORD error document.
UnmarshallException - Exception in org.purl.sword.base
Represents information about an exception that is generated during the Unmarshall process.
UnmarshallException(String, Exception) - Constructor for exception org.purl.sword.base.UnmarshallException
Create a new instance and store the specified message and source data.
UnmarshallException(String) - Constructor for exception org.purl.sword.base.UnmarshallException
Create a new instance and store the specified message.
unmarshallInteger(Element) - Method in class org.purl.sword.base.XmlElement
Extract an integer value from the specified element.
unmarshallString(Element) - Method in class org.purl.sword.base.XmlElement
Extract a string value from the specified element.
unmarshallWithoutValidate(Element, Properties) - Method in class org.purl.sword.atom.Entry
 
unmarshallWithValidation(Element, Properties) - Method in class org.purl.sword.base.SWORDEntry
Overrides the unmarshall method in the parent Entry.
UNPACKAGE_FAIL - Static variable in interface org.dspace.sword.DSpaceSWORDErrorCodes
if unpackaging the package fails
Updated - Class in org.purl.sword.atom
 
Updated() - Constructor for class org.purl.sword.atom.Updated
 
Updated(String) - Constructor for class org.purl.sword.atom.Updated
 
Uri - Class in org.purl.sword.atom
 
Uri() - Constructor for class org.purl.sword.atom.Uri
 
Uri(String) - Constructor for class org.purl.sword.atom.Uri
 
USER_AGENT - Static variable in interface org.purl.sword.base.HttpHeaders
The user agent.

V

validate(Properties) - Method in class org.purl.sword.atom.Author
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.atom.Author
 
validate(Properties) - Method in class org.purl.sword.atom.Content
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.atom.Content
 
validate(Properties) - Method in class org.purl.sword.atom.Entry
 
validate(SwordValidationInfo, Properties) - Method in class org.purl.sword.atom.Entry
 
validate(Properties) - Method in class org.purl.sword.atom.Generator
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.atom.Generator
 
validate(Properties) - Method in class org.purl.sword.atom.Link
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.atom.Link
 
validate(Properties) - Method in class org.purl.sword.atom.Source
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.atom.Source
 
validate(Properties) - Method in class org.purl.sword.atom.TextConstruct
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.atom.TextConstruct
 
validate(Properties) - Method in class org.purl.sword.base.BasicContentElement
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.base.BasicContentElement
 
validate(Properties) - Method in class org.purl.sword.base.Collection
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.base.Collection
 
validate(Properties) - Method in class org.purl.sword.base.Service
 
validate(ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.base.Service
 
validate() - Method in class org.purl.sword.base.ServiceDocument
 
validate(Properties) - Method in class org.purl.sword.base.ServiceDocument
 
validate(Properties) - Method in class org.purl.sword.base.SwordAcceptPackaging
 
validate(ArrayList<SwordValidationInfo>, ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.base.SwordAcceptPackaging
 
validate(Properties) - Method in class org.purl.sword.base.SWORDEntry
 
validate(SwordValidationInfo, Properties) - Method in class org.purl.sword.base.SWORDEntry
 
validate(Properties) - Method in class org.purl.sword.base.SWORDErrorDocument
 
validate(SwordValidationInfo, Properties) - Method in class org.purl.sword.base.SWORDErrorDocument
 
validate(Properties) - Method in class org.purl.sword.base.Workspace
 
validate(ArrayList<SwordValidationInfo>, Properties) - Method in class org.purl.sword.base.Workspace
 
validate(Properties) - Method in class org.purl.sword.base.XmlElement
 
validateContent(Properties) - Method in class org.purl.sword.base.BasicBooleanContentElement
 
validateContent(Properties) - Method in class org.purl.sword.base.BasicContentElement
 
validateContent(Properties) - Method in class org.purl.sword.base.BasicIntegerContentElement
 
validateContent(Properties) - Method in class org.purl.sword.base.BasicStringContentElement
 
valueOf(String) - Static method in enum org.purl.sword.atom.ContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.purl.sword.base.SwordValidationInfoType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.purl.sword.atom.ContentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.purl.sword.base.SwordValidationInfoType
Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in interface org.dspace.sword.SWORDProperties
The version of the SWORD service we are offering

W

Workspace - Class in org.purl.sword.base
Represents an Atom Publishing Protocol Workspace element.
Workspace() - Constructor for class org.purl.sword.base.Workspace
Create a new instance of the workspace, with no title.
Workspace(String) - Constructor for class org.purl.sword.base.Workspace
Create a new instance of the workspace with the specified title.

X

X_CORRUPT - Static variable in interface org.purl.sword.base.HttpHeaders
An HTTP Header label that the server should not epect, and thus created a corrupt header.
X_ERROR_CODE - Static variable in interface org.purl.sword.base.HttpHeaders
The HTTP Header that specifies the error code information.
X_NO_OP - Static variable in interface org.purl.sword.base.HttpHeaders
The HTTP Header label that specifies the desired NoOp status.
X_ON_BEHALF_OF - Static variable in interface org.purl.sword.base.HttpHeaders
The HTTP Header label that specifies the On Behalf Of information.
X_PACKAGING - Static variable in interface org.purl.sword.base.HttpHeaders
The HTTP Header label that specifies the Packaging information.
X_VERBOSE - Static variable in interface org.purl.sword.base.HttpHeaders
The HTTP Header label that specifies the desired Verbose status.
XmlElement - Class in org.purl.sword.base
Parent class for all classes that represent an XML element.
XmlElement(String) - Constructor for class org.purl.sword.base.XmlElement
Create a new instance.
XmlElement(String, String) - Constructor for class org.purl.sword.base.XmlElement
Create a new instance.
XmlElement(String, String, String) - Constructor for class org.purl.sword.base.XmlElement
Create a new insatnce.
XmlElement(XmlName) - Constructor for class org.purl.sword.base.XmlElement
 
xmlName - Variable in class org.purl.sword.base.XmlElement
 
XmlName - Class in org.purl.sword.base
 
XmlName(String, String, String) - Constructor for class org.purl.sword.base.XmlName
Create a new instance with the specified prefix and local name.
XmlName(Element) - Constructor for class org.purl.sword.base.XmlName
 
XmlName(Attribute) - Constructor for class org.purl.sword.base.XmlName
 

A B C D E G H I K L M N O P Q R S T U V W X

Copyright © 2010 DuraSpace. All Rights Reserved.