org.dspace.sword2

Class SwordUrlManager

java.lang.Object

org.dspace.sword2.SwordUrlManager

public class SwordUrlManager
extends Object

Author:

Richard Jones Class responsible for constructing and de-constructing sword url space urls

Constructor Summary

Constructors

Constructor and Description
SwordUrlManager(SwordConfigurationDSpace config, Context context)

Method Summary

Methods

Modifier and Type	Method and Description
String	constructSubServiceUrl(Collection collection) Construct the service document URL for the given object, which will be supplied in the sword:service element of other service document entries.
String	constructSubServiceUrl(Community community) Construct the service document URL for the given object, which will be supplied in the sword:service element of other service document entries.
DSpaceObject	extractDSpaceObject(String url) Extract a DSpaceObject from the given URL.
String	getActionableBitstreamUrl(Bitstream bitstream)
String	getAggregationUrl(Item item)
String	getAtomStatementUri(Item item)
String	getBaseCollectionUrl() Get the base deposit URL for the DSpace SWORD implementation.
String	getBaseServiceDocumentUrl() Get the base URL for service document requests.
Bitstream	getBitstream(Context context, String location)
String	getBitstreamUrl(Bitstream bitstream) Central location for constructing usable URLs for DSpace bitstreams.
Collection	getCollection(Context context, String location) Obtain the collection which is represented by the given URL
org.apache.abdera.i18n.iri.IRI	getContentUrl(Item item)
String	getDepositLocation(Collection collection) Obtain the deposit URL for the given collection.
String	getDepositLocation(Community community) Obtain the deposit URL for the given community.
org.apache.abdera.i18n.iri.IRI	getEditIRI(Item item)
Item	getItem(Context context, String location)
org.apache.abdera.i18n.iri.IRI	getMediaFeedUrl(Item item)
String	getOreStatementUri(Item item)
String	getSplashUrl(Item item)
String	getSwordBaseUrl()
String	getTypeSuffix(Context context, String location)
boolean	isActionableBitstreamUrl(Context context, String url)
boolean	isBaseServiceDocumentUrl(String url) Is the given URL the base service document URL?
boolean	isFeedRequest(Context context, String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

SwordUrlManager

public SwordUrlManager(SwordConfigurationDSpace config,
               Context context)

Method Detail

getDepositLocation

public String getDepositLocation(Collection collection)
                          throws DSpaceSwordException

Obtain the deposit URL for the given collection. These URLs should not be considered persistent, but will remain consistent unless configuration changes are made to DSpace

Parameters:

collection -

Returns:

The Deposit URL

Throws:

DSpaceSwordException

getDepositLocation

public String getDepositLocation(Community community)
                          throws DSpaceSwordException

Obtain the deposit URL for the given community. These URLs should not be considered persistent, but will remain consistent unless configuration changes are made to DSpace

Parameters:

community -

Returns:

The Deposit URL

Throws:

DSpaceSwordException

getSwordBaseUrl

public String getSwordBaseUrl()
                       throws DSpaceSwordException

Throws:

DSpaceSwordException

getItem

public Item getItem(Context context,
           String location)
             throws DSpaceSwordException,
                    org.swordapp.server.SwordError

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

getTypeSuffix

public String getTypeSuffix(Context context,
                   String location)

isFeedRequest

public boolean isFeedRequest(Context context,
                    String url)

getCollection

public Collection getCollection(Context context,
                       String location)
                         throws DSpaceSwordException,
                                org.swordapp.server.SwordError

Obtain the collection which is represented by the given URL

Parameters:

context - the DSpace context

location - the URL to resolve to a collection

Returns:

The collection to which the url resolves

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

constructSubServiceUrl

public String constructSubServiceUrl(Community community)
                              throws DSpaceSwordException

Construct the service document URL for the given object, which will be supplied in the sword:service element of other service document entries.

Parameters:

community -

Throws:

DSpaceSwordException

constructSubServiceUrl

public String constructSubServiceUrl(Collection collection)
                              throws DSpaceSwordException

Construct the service document URL for the given object, which will be supplied in the sword:service element of other service document entries.

Parameters:

collection -

Throws:

DSpaceSwordException

extractDSpaceObject

public DSpaceObject extractDSpaceObject(String url)
                                 throws DSpaceSwordException,
                                        org.swordapp.server.SwordError

Extract a DSpaceObject from the given URL. If this method is unable to locate a meaningful and appropriate DSpace object it will throw the appropriate SWORD error.

Parameters:

url -

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

getBaseServiceDocumentUrl

public String getBaseServiceDocumentUrl()
                                 throws DSpaceSwordException

Get the base URL for service document requests.

Throws:

DSpaceSwordException

getBaseCollectionUrl

public String getBaseCollectionUrl()
                            throws DSpaceSwordException

Get the base deposit URL for the DSpace SWORD implementation. This is effectively the URL of the servlet which deals with deposit requests, and is used as the basis for the individual Collection URLs If the configuration sword.deposit.url is set, this will be returned, but if not, it will construct the url as follows: [dspace.baseUrl]/sword/deposit where dspace.baseUrl is also in the configuration file.

Returns:

the base URL for sword deposit

Throws:

DSpaceSwordException

isBaseServiceDocumentUrl

public boolean isBaseServiceDocumentUrl(String url)
                                 throws DSpaceSwordException

Is the given URL the base service document URL?

Parameters:

url -

Throws:

DSpaceSwordException

getBitstreamUrl

public String getBitstreamUrl(Bitstream bitstream)
                       throws DSpaceSwordException

Central location for constructing usable URLs for DSpace bitstreams. There is no place in the main DSpace code base for doing this.

Parameters:

bitstream -

Throws:

DSpaceSwordException

getActionableBitstreamUrl

public String getActionableBitstreamUrl(Bitstream bitstream)
                                 throws DSpaceSwordException

Throws:

DSpaceSwordException

isActionableBitstreamUrl

public boolean isActionableBitstreamUrl(Context context,
                               String url)

getBitstream

public Bitstream getBitstream(Context context,
                     String location)
                       throws DSpaceSwordException,
                              org.swordapp.server.SwordError

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

getAtomStatementUri

public String getAtomStatementUri(Item item)
                           throws DSpaceSwordException

Throws:

DSpaceSwordException

getOreStatementUri

public String getOreStatementUri(Item item)
                          throws DSpaceSwordException

Throws:

DSpaceSwordException

getAggregationUrl

public String getAggregationUrl(Item item)
                         throws DSpaceSwordException

Throws:

DSpaceSwordException

getEditIRI

public org.apache.abdera.i18n.iri.IRI getEditIRI(Item item)
                                          throws DSpaceSwordException

Throws:

DSpaceSwordException

getSplashUrl

public String getSplashUrl(Item item)
                    throws DSpaceSwordException

Throws:

DSpaceSwordException

getContentUrl

public org.apache.abdera.i18n.iri.IRI getContentUrl(Item item)
                                             throws DSpaceSwordException

Throws:

DSpaceSwordException

getMediaFeedUrl

public org.apache.abdera.i18n.iri.IRI getMediaFeedUrl(Item item)
                                               throws DSpaceSwordException

Throws:

DSpaceSwordException