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

A

ACCEPTED - Static variable in class org.purl.sword.base.Deposit

Submission accepted.

ACCEPTED - Static variable in interface org.purl.sword.base.HttpHeaders

Submission accepted.

addAccepts(String) - Method in class org.purl.sword.base.Collection

Add an accepts entry.

addAuthors() - Method in class org.dspace.sword.DSpaceATOMEntry

add the author names from the bibliographic metadata.

addAuthors(Author) - Method in class org.w3.atom.Entry

Add an author to the Entry.

addCategories() - Method in class org.dspace.sword.DSpaceATOMEntry

Add all the subject classifications from the bibliographic metadata.

addCategory(String) - Method in class org.w3.atom.Entry

Add a category.

addCollection(Collection) - Method in class org.purl.sword.base.Workspace

Add a collection to the Workspace.

addContentElement(String, boolean) - Method in class org.dspace.sword.DSpaceATOMEntry

Set the content type that DSpace received.

addContributor(Contributor) - Method in class org.w3.atom.Entry

Add a contributor.

addContributors() - Method in class org.dspace.sword.DSpaceATOMEntry

Add the list of contributors to the item.

addIdentifier(String, boolean) - Method in class org.dspace.sword.DSpaceATOMEntry

Add the identifier for the item.

addLastUpdatedDate() - Method in class org.dspace.sword.DSpaceATOMEntry

Add the date that this item was last updated

addLink(Link) - Method in class org.w3.atom.Entry

Get the link for this Entry.

addLinks(String) - Method in class org.dspace.sword.DSpaceATOMEntry

Add links associated with this item.

addPublishDate() - Method in class org.dspace.sword.DSpaceATOMEntry

Add the date of publication from the bibliographic metadata

addRights(String) - Method in class org.dspace.sword.DSpaceATOMEntry

Add rights information.

addSource() - Method in class org.dspace.sword.DSpaceATOMEntry

Add the source of the bibliographic metadata.

addSummary() - Method in class org.dspace.sword.DSpaceATOMEntry

Add the summary/abstract from the bibliographic metadata

addTitle() - Method in class org.dspace.sword.DSpaceATOMEntry

Add the title from the bibliographic metadata

addWorkspace(Workspace) - Method in class org.purl.sword.base.Service

Add a workspace.

addWorkspace(Workspace) - Method in class org.purl.sword.base.ServiceDocument

Deprecated. Please access the value directly from the service.

ATTR_SRC - Static variable in class org.w3.atom.Content

The identifier for the src attribute.

ATTR_TYPE - Static variable in class org.w3.atom.Content

The identifier for the type attribute.

authenticates(Context, String, String) - Method in class org.dspace.sword.SWORDAuthentication

Does the given username and password authenticate for the given DSpace Context?

Author - Class in org.w3.atom

Represents an Author type, as used in ATOM.

Author() - Constructor for class org.w3.atom.Author

Create a new instance and set the prefix to 'atom' and the local name to 'author'.

Author(String, String) - Constructor for class org.w3.atom.Author

Create a new instance and set the element name.

C

canSubmitTo(Context, Collection) - Method in class org.dspace.sword.SWORDContext

Can the current SWORD Context permit deposit into the given collection in the given DSpace Context

ChecksumUtils - Class in org.purl.sword.base

Utility class that holds Checksum related methods.

ChecksumUtils() - Constructor for class org.purl.sword.base.ChecksumUtils

clearAccepts() - Method in class org.purl.sword.base.Collection

Remove all of the accepts associated with this Collection.

clearAuthors() - Method in class org.w3.atom.Entry

Clear the list of authors.

clearCategories() - Method in class org.w3.atom.Entry

Clear the list of categories.

clearContributors() - Method in class org.w3.atom.Entry

Clear the list of contributors.

clearLinks() - Method in class org.w3.atom.Entry

Clear the list of links.

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.

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

Content - Class in org.w3.atom

Represents an ATOM Content element.

Content() - Constructor for class org.w3.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.w3.atom

Contributor - Class in org.w3.atom

Represents an ATOM Contributor.

Contributor() - Constructor for class org.w3.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

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.

dateToString(Date) - Method in class org.purl.sword.base.XmlElement

Convert the date to a string.

deposit() - Method in class org.dspace.sword.DepositManager

Once this object is fully prepared, this method will execute the deposit process.

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() - Constructor for class org.dspace.sword.DepositManager

DepositResponse - Class in org.purl.sword.base

DepositResponse(int) - Constructor for class org.purl.sword.base.DepositResponse

depositResponseTest() - Method in class org.purl.sword.test.SwordTest

Create a test DepositResponse class.

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() - Constructor for class org.purl.sword.server.DepositServlet

doDeposit(Deposit) - Method in class org.dspace.sword.DSpaceSWORDServer

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.DepositServlet

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.ServiceDocumentServlet

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.DepositServlet

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.purl.sword.server.ServiceDocumentServlet

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() - Constructor for class org.dspace.sword.DSpaceATOMEntry

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

DummyServerTest - Class in org.purl.sword.test

DummyServerTest() - Constructor for class org.purl.sword.test.DummyServerTest

E

ELEMENT_NAME - Static variable in class org.purl.sword.base.Collection

The element name.

ELEMENT_NAME - Static variable in class org.purl.sword.base.Workspace

The element name that is used in the textual representatin of the XML data.

entry - Variable in class org.dspace.sword.DSpaceATOMEntry

the SWORD ATOM entry which this class effectively decorates

Entry - Class in org.w3.atom

Represents an ATOM entry.

Entry() - Constructor for class org.w3.atom.Entry

Create a new instance of the class and initialise it.

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 recevied 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

ErrorCodes - Interface in org.purl.sword.base

Definition of the error codes that will be used in the SWORD protocol (in X-Error-Code).

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.w3.atom

Represents an ATOM Generator element.

Generator() - Constructor for class org.w3.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.

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

Retrieve an array that holds all of the Accept details.

getAllowedCollections(Context) - Method in class org.dspace.sword.SWORDContext

Get an array of all the collections that the current SWORD context will allow deposit onto in the given DSpace context

getAuthenticated() - Method in class org.dspace.sword.SWORDContext

getAuthors() - Method in class org.w3.atom.Entry

Get an iterator for the authors in the Entry.

getCategories() - Method in class org.w3.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

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

getComplianceLevel() - Method in class org.purl.sword.base.Service

Get the service compliance level.

getComplianceLevel() - Method in class org.purl.sword.base.ServiceDocument

Deprecated. Please access the compliance level directly from the service.

getContent() - Method in class org.w3.atom.Entry

Get the content element for this Entry.

getContent() - Method in class org.w3.atom.Generator

Get the content.

getContent() - Method in class org.w3.atom.Link

Get the content.

getContent() - Method in class org.w3.atom.TextConstruct

Get the content in this TextConstruct.

getContentLength() - Method in class org.purl.sword.base.Deposit

getContentType() - Method in class org.purl.sword.base.Deposit

getContributors() - Method in class org.w3.atom.Entry

Get a list of contributors.

getDepositID() - Method in class org.purl.sword.base.Deposit

getEmail() - Method in class org.w3.atom.Author

Get the author email.

getEntry() - Method in class org.purl.sword.base.DepositResponse

getErrorCode() - Method in exception org.purl.sword.base.SWORDException

Get the error code

getFile() - Method in class org.purl.sword.base.Deposit

getFilename() - Method in class org.purl.sword.base.Deposit

Retrieve the filename that is associated with this deposit.

getFormatNamespace() - Method in class org.purl.sword.base.Collection

Get the format namespace.

getFormatNamespace() - Method in class org.purl.sword.base.Deposit

getFormatNamespace() - Method in class org.purl.sword.base.SWORDEntry

Get the format namespace.

getGenerator() - Method in class org.w3.atom.Source

Get the generator.

getHandle() - Method in class org.dspace.sword.DepositResult

getHref() - Method in class org.w3.atom.Link

Get the HREF attribute.

getHreflang() - Method in class org.w3.atom.Link

Get the HREF Lang attribute.

getHttpResponse() - Method in class org.purl.sword.base.DepositResponse

getId() - Method in class org.w3.atom.Entry

Get the ID for this Entry.

getInstance(Context, Deposit) - 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.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.w3.atom.Link

Get the length.

getLinks() - Method in class org.w3.atom.Entry

Get the list of links for this Entry.

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.Collection

Get the location.

getLocation() - Method in class org.purl.sword.base.Deposit

Get the location of the deposit

getLogger() - Static method in class org.purl.sword.base.InfoLogger

Returns the single instance of this class.

getMd5() - Method in class org.purl.sword.base.Deposit

getMediation() - Method in class org.purl.sword.base.Collection

Get the mediation value.

getName() - Method in class org.w3.atom.Author

Retrieve the author name.

getNamespace() - Method in class org.purl.sword.base.Collection

Deprecated. Use getFormatNamespace()

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

getPassword() - Method in class org.purl.sword.base.Deposit

getPassword() - Method in class org.purl.sword.base.ServiceDocumentRequest

getPublished() - Method in class org.w3.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.

getRel() - Method in class org.w3.atom.Link

Get the Rel attribute.

getRights() - Method in class org.w3.atom.Entry

Get the rights for this Entry.

getService() - Method in class org.purl.sword.base.ServiceDocument

Retrieve the Service object associated with this document.

getServiceDocument() - Method in class org.dspace.sword.SWORDService

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.

getSlug() - Method in class org.purl.sword.base.Deposit

getSource() - Method in class org.w3.atom.Content

Get the Source.

getSource() - Method in class org.w3.atom.Entry

Get the source for this Entry.

getSummary() - Method in class org.w3.atom.Entry

Get the summary.

getSWORDEntry(Item, String, boolean) - Method in class org.dspace.sword.DSpaceATOMEntry

Construct the SWORDEntry object which represents the given item with the given handle.

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.

getTitle() - Method in class org.w3.atom.Entry

Get the title.

getTitle() - Method in class org.w3.atom.Link

Get the title.

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.w3.atom.Content

Get the type.

getType() - Method in class org.w3.atom.Link

Get the type.

getType() - Method in class org.w3.atom.TextConstruct

Get the type.

getUpdated() - Method in class org.w3.atom.Entry

Get the updated date, expressed as a String.

getUri() - Method in class org.w3.atom.Author

Get the author URI.

getUri() - Method in class org.w3.atom.Generator

Get the URI.

getUsername() - Method in class org.purl.sword.base.Deposit

getUsername() - Method in class org.purl.sword.base.ServiceDocumentRequest

getVerboseDescription() - Method in class org.dspace.sword.DepositResult

getVerboseDescription() - Method in class org.purl.sword.base.SWORDEntry

Get the Verbose Description for this entry.

getVersion() - Method in class org.w3.atom.Generator

Get the version.

getWorkspaceCollections() - Method in class org.purl.sword.base.ServiceDocument

Deprecated. Please access the value directly from the service.

getWorkspaces() - Method in class org.purl.sword.base.Service

Get an Iterator over the workspaces.

getWorkspaces() - Method in class org.purl.sword.base.ServiceDocument

Deprecated. Please access the value directly from the service.

getWorkspacesList() - Method in class org.purl.sword.base.Service

Get a List of workspaces

H

HttpHeaders - Interface in org.purl.sword.base

Definition of the additional HTTP Header tags that will be used in the SWORD protocol.

I

InfoLogger - Class in org.purl.sword.base

InfoLogger() - Constructor for class org.purl.sword.base.InfoLogger

InfoLoggerLevel - Enum in org.purl.sword.base

This enumeration determines the logging level to be used for the InfoLogger class.

ingest(Context, Deposit) - Method in interface org.dspace.sword.SWORDIngester

Ingest the package as described in the given Deposit object within the given DSpace Context

ingest(Context, Deposit) - Method in class org.dspace.sword.SWORDMETSIngester

init() - Method in class org.dspace.sword.LoadDSpaceConfig

Deprecated.

init() - Method in class org.purl.sword.server.DepositServlet

init() - Method in class org.purl.sword.server.ServiceDocumentServlet

InvalidMediaTypeException - Exception in org.w3.atom

An invalid media type has been detected during parsing.

InvalidMediaTypeException(String) - Constructor for exception org.w3.atom.InvalidMediaTypeException

Create a new instance and store the message.

isInGroup(Group, EPerson) - Method in class org.dspace.sword.SWORDContext

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.

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(Context) - Method in class org.dspace.sword.SWORDContext

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(Group) - Method in class org.dspace.sword.SWORDContext

Is the onBehalfOf user a member of the given group or one of its sub groups

isUserAdmin(Context) - Method in class org.dspace.sword.SWORDContext

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(Group) - Method in class org.dspace.sword.SWORDContext

Is the authenticated user a member of the given group or one of its sub groups?

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

L

Link - Class in org.w3.atom

Represents an ATOM Link element.

Link() - Constructor for class org.w3.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.

localName - Variable in class org.purl.sword.base.XmlElement

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

main(String[]) - Static method in class org.purl.sword.test.DummyServerTest

A main method to test the dummy SWORD server.

main(String[]) - Static method in class org.purl.sword.test.SwordTest

Start the test of the ServiceDocument followed by the DepositResponse.

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() - 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 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.Workspace

Marshall the data in this element to an Element.

marshall() - Method in class org.w3.atom.Author

Marshall the data in this object to a XOM Element.

marshall() - Method in class org.w3.atom.Content

Marshall the data in this object to an Element object.

marshall() - Method in class org.w3.atom.Entry

Mashall the data stored in this object into Element objects.

marshall() - Method in class org.w3.atom.Generator

Marshall the data in the object to an Element object.

marshall() - Method in class org.w3.atom.Link

Mashall the data stored in this object into Element objects.

marshall() - Method in class org.w3.atom.Source

Marshall the data stored in this object into Element objects.

marshall() - Method in class org.w3.atom.TextConstruct

Marshall the data in this object to an Element object.

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

N

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.

number() - Method in enum org.purl.sword.base.ServiceLevel

Get the number for the ServiceLevel object.

O

org.dspace.sword - package org.dspace.sword

org.purl.sword.base - package org.purl.sword.base

org.purl.sword.server - package org.purl.sword.server

org.purl.sword.test - package org.purl.sword.test

org.w3.atom - package org.w3.atom

P

prefix - Variable in class org.purl.sword.base.XmlElement

The name to use for the prefix.

R

Rights - Class in org.w3.atom

Represents an ATOM Rights element.

Rights() - Constructor for class org.w3.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(ServiceLevel) - Constructor for class org.purl.sword.base.Service

Create a new instance.

Service(ServiceLevel, 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(ServiceLevel) - 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.

ServiceDocument(ServiceLevel, boolean, boolean, String, Collection) - Constructor for class org.purl.sword.base.ServiceDocument

Deprecated. Please use the other constructors.

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() - Constructor for class org.purl.sword.server.ServiceDocumentServlet

serviceDocumentTest() - Method in class org.purl.sword.test.SwordTest

Create a test ServiceDocument class.

ServiceLevel - Enum in org.purl.sword.base

Represents the SWORD Service Level.

setAbstract(String) - Method in class org.purl.sword.base.Collection

Set the abstract.

setAuthenticated(EPerson) - Method in class org.dspace.sword.SWORDContext

setCollectionPolicy(String) - Method in class org.purl.sword.base.Collection

Set the collection policy.

setComplianceLevel(ServiceLevel) - Method in class org.purl.sword.base.Service

Set the service compliance level.

setContent(Content) - Method in class org.w3.atom.Entry

Set the content element for this Entry.

setContent(String) - Method in class org.w3.atom.Generator

Set the content.

setContent(String) - Method in class org.w3.atom.Link

Set the content.

setContent(String) - Method in class org.w3.atom.TextConstruct

Set the content.

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.DepositManager

setContext(Context) - Method in class org.dspace.sword.SWORDService

Set the DSpace context to use

setDeposit(Deposit) - Method in class org.dspace.sword.DepositManager

setDepositID(String) - Method in class org.purl.sword.base.Deposit

setEmail(String) - Method in class org.w3.atom.Author

Set the author email.

setEntry(SWORDEntry) - Method in class org.purl.sword.base.DepositResponse

setFile(InputStream) - Method in class org.purl.sword.base.Deposit

setFilename(String) - Method in class org.purl.sword.base.Deposit

Set the filename that is to be used for this deposit.

setFormatNamespace() - Method in class org.dspace.sword.DSpaceATOMEntry

setFormatNamespace(String) - Method in class org.purl.sword.base.Collection

Set the format namespace.

setFormatNamespace(String) - Method in class org.purl.sword.base.Deposit

setFormatNamespace(String) - Method in class org.purl.sword.base.SWORDEntry

Set the format namespace.

setGenerator(Generator) - Method in class org.w3.atom.Source

Set the generator.

setHandle(String) - Method in class org.dspace.sword.DepositResult

setHref(String) - Method in class org.w3.atom.Link

Set the HREF attribute.

setHreflang(String) - Method in class org.w3.atom.Link

Set the HREF Lang attribute.

setHttpResponse(int) - Method in class org.purl.sword.base.DepositResponse

setId(String) - Method in class org.w3.atom.Entry

Set the ID for this Entry.

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

setLength(String) - Method in class org.w3.atom.Link

Set the length.

setLevel(InfoLoggerLevel) - Method in class org.purl.sword.base.InfoLogger

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

setMd5(String) - Method in class org.purl.sword.base.Deposit

setMediation(boolean) - Method in class org.purl.sword.base.Collection

Set the mediation value.

setName(String) - Method in class org.w3.atom.Author

Set the author name.

setNamespace(String) - Method in class org.purl.sword.base.Collection

Deprecated. Use setFormatNamespace

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.ServiceDocument

Deprecated. Please access the value directly from the service.

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

setPassword(String) - Method in class org.purl.sword.base.Deposit

setPassword(String) - Method in class org.purl.sword.base.ServiceDocumentRequest

setPublished(String) - Method in class org.w3.atom.Entry

Set the published date.

setRel(String) - Method in class org.w3.atom.Link

Set the Rel attribute.

setRights(Rights) - Method in class org.w3.atom.Entry

Set the rights for this Entry.

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.w3.atom.Content

Set the Source.

setSource(Source) - Method in class org.w3.atom.Entry

Set the source for this entry.

setSummary(Summary) - Method in class org.w3.atom.Entry

Set the summary.

setSWORDContext(SWORDContext) - Method in class org.dspace.sword.DepositManager

setSWORDContext(SWORDContext) - Method in class org.dspace.sword.SWORDService

Set the SWORD Context to use

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.

setTitle(Title) - Method in class org.w3.atom.Entry

Set the title.

setTitle(String) - Method in class org.w3.atom.Link

Set the title.

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.w3.atom.Content

Set the type for the content.

setType(String) - Method in class org.w3.atom.Link

Set the type.

setType(ContentType) - Method in class org.w3.atom.TextConstruct

Set the type.

setUpdated(String) - Method in class org.w3.atom.Entry

Set the updated date.

setUri(String) - Method in class org.w3.atom.Author

Set the author URI.

setUri(String) - Method in class org.w3.atom.Generator

Set the URI.

setUsername(String) - Method in class org.purl.sword.base.Deposit

setUsername(String) - Method in class org.purl.sword.base.ServiceDocumentRequest

setVerbose(boolean) - Method in class org.purl.sword.base.Deposit

setVerbose(boolean) - Method in class org.purl.sword.base.Service

Set the Verbose value.

setVerbose(boolean) - Method in class org.purl.sword.base.ServiceDocument

Deprecated. Please access the value directly from the service.

setVerboseDescription(String) - Method in class org.dspace.sword.DepositResult

setVerboseDescription(String) - Method in class org.purl.sword.base.SWORDEntry

Set the verbose description.

setVersion(String) - Method in class org.w3.atom.Generator

Set the version.

SLUG - Static variable in interface org.purl.sword.base.HttpHeaders

The Slug header.

Source - Class in org.w3.atom

Represents an ATOM Generator element.

Source() - Constructor for class org.w3.atom.Source

Create a new instance and set the prefix to 'atom' and the local name to 'source'.

stringToDate(String) - Method in class org.purl.sword.base.XmlElement

Convert the string into a Date object.

Summary - Class in org.w3.atom

Represents an ATOM Summary element.

Summary() - Constructor for class org.w3.atom.Summary

Create a new instance and set the prefix to 'atom' and the local name to 'summary'.

supportsNoOp() - Method in class org.purl.sword.base.ServiceDocument

Deprecated. Please access the value directly from the service.

supportsVerbose() - Method in class org.purl.sword.base.ServiceDocument

Deprecated. Please access the value directly from the service.

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.

SWORDContentTypeException - Exception in org.purl.sword.base

Represents a SWORD exception to be thrown if a format supplied in a deposit is not accepted by the repository.

SWORDContentTypeException() - Constructor for exception org.purl.sword.base.SWORDContentTypeException

SWORDContext - Class in org.dspace.sword

This class represents the users who are involved in the deposit or service document request process.

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() - Constructor for class org.purl.sword.base.SWORDEntry

Create a new instance of the class.

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

SWORDMETSIngester - Class in org.dspace.sword

SWORDMETSIngester() - Constructor for class org.dspace.sword.SWORDMETSIngester

SWORDServer - Interface in org.purl.sword.server

An abstract interface to be implemnted by repositories wishing to provide a SWORD compliant service.

SWORDService - Class in org.dspace.sword

Represents the SWORD service provided by DSpace.

SWORDService() - Constructor for class org.dspace.sword.SWORDService

SwordTest - Class in org.purl.sword.test

Simple test class for the ServiceDocument and DepositResponse classes in the SWORD common classes.

SwordTest() - Constructor for class org.purl.sword.test.SwordTest

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.w3.atom

Represents a text construct in the ATOM elements.

TextConstruct(String, String) - Constructor for class org.w3.atom.TextConstruct

Create a new instance, specifying the prefix and local name.

TextConstruct(String) - Constructor for class org.w3.atom.TextConstruct

Create a new instance.

Title - Class in org.w3.atom

Represents an ATOM Title element.

Title() - Constructor for class org.w3.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.base.Collection

Get a string representation of this object.

toString() - Method in class org.purl.sword.base.DepositResponse

toString() - Method in class org.purl.sword.base.ServiceDocument

Return the Service Document in it's XML form.

toString() - Method in enum org.w3.atom.ContentType

Retrieve a string representation of this object.

U

unmarshall(Element) - Method in class org.purl.sword.base.Collection

Unmarshall the content element into the data in this object.

unmarshall(String) - 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(String) - Method in class org.purl.sword.base.ServiceDocument

Convert the specified XML string into a set of objects used within the service.

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) - 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.Workspace

Unmarshall the workspace element into the data in this object.

unmarshall(Element) - Method in class org.w3.atom.Author

Unmarshall the author details from the specified element.

unmarshall(Element) - Method in class org.w3.atom.Content

Unmarshall the content element into the data in this object.

unmarshall(Element) - Method in class org.w3.atom.Entry

Unmarshall the contents of the Entry element into the internal data objects in this object.

unmarshall(Element) - Method in class org.w3.atom.Generator

Unmarshall the specified Generator element into the data in this object.

unmarshall(Element) - Method in class org.w3.atom.Link

Unmarshall the contents of the Link element into the internal data objects in this object.

unmarshall(Element) - Method in class org.w3.atom.Source

Unmarshall the contents of the source element into the internal data objects in this object.

unmarshall(Element) - Method in class org.w3.atom.TextConstruct

Unmarshall the text element into this object.

unmarshallBoolean(Element) - Method in class org.purl.sword.base.XmlElement

Extract a boolean value from the specified element.

unmarshallDate(Element) - Method in class org.purl.sword.base.XmlElement

Extract an date value from the specified element.

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.

V

valueOf(String) - Static method in enum org.purl.sword.base.InfoLoggerLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.purl.sword.base.ServiceLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.w3.atom.ContentType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.purl.sword.base.InfoLoggerLevel

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum org.purl.sword.base.ServiceLevel

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum org.w3.atom.ContentType

Returns an array containing the constants of this enum type, in the order they're declared.

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.

writeError(String) - Method in class org.purl.sword.base.InfoLogger

writeInfo(String) - Method in class org.purl.sword.base.InfoLogger

writeWarning(String) - Method in class org.purl.sword.base.InfoLogger

X

X_ERROR_CODE - Static variable in interface org.purl.sword.base.HttpHeaders

The HTTP Header that specifies the error code information.

X_FORMAT_NAMESPACE - Static variable in interface org.purl.sword.base.HttpHeaders

The HTTP Header label that specifies the Format Namespace 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_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

XmlElement(String, String) - Constructor for class org.purl.sword.base.XmlElement

Create a new instance.

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