com.exlibris.dps.sdk.repository
Interface DeliveryAccessWS

All Superinterfaces:

com.exlibris.core.infra.svc.api.GenericWebService

public interface DeliveryAccessWS
extends com.exlibris.core.infra.svc.api.GenericWebService

Method Summary

java.lang.String	getBaseFileUrl(java.lang.String dvs) Returns the Stream Gate file viewer base URL for the given dvs.
java.lang.String	getCMSRecord(java.lang.String dvs, java.lang.String iePID) Returns the CMS DC XML of the IE.
java.lang.String	getDnxDocument(java.lang.String dvs, java.lang.String pid) Returns the DNX document XML of the entity (IE/REP/FILE) that its PID is associated to the given dvs.
java.lang.String	getFilePathByDvs(java.lang.String dvs, java.lang.String pid) Returns the path to a file which is associated to the given dvs.
java.lang.String	getFullIEByDVS(java.lang.String dvs) Returns the IE METS document which is associated to the given dvs, including the IE, Representation and File level sections.
java.lang.String	getIE(java.lang.String pid) Deprecated.
java.lang.String	getIEByDVS(java.lang.String dvs) Returns the IE METS document which is associated to the given dvs, including the IE and Representation level sections.
java.lang.String	getMetadata(java.lang.String dvs, java.lang.String pid, java.lang.String mdType, java.lang.String mdSubType) Returns the Metadata XML of the entity (IE/REP/FILE) that its PID is associated to the given dvs.

Methods inherited from interface com.exlibris.core.infra.svc.api.GenericWebService

getHeartBit

Method Detail

getIE

@Deprecated
java.lang.String getIE(java.lang.String pid)
                       throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getIEByDVS

java.lang.String getIEByDVS(java.lang.String dvs)
                            throws java.lang.Exception

Returns the IE METS document which is associated to the given dvs, including the IE and Representation level sections.

Parameters:

dvs - The Delivery session key

Returns:

IE METS document xml

Throws:

java.lang.Exception - when the dvs is invalid

getFullIEByDVS

java.lang.String getFullIEByDVS(java.lang.String dvs)
                                throws java.lang.Exception

Returns the IE METS document which is associated to the given dvs, including the IE, Representation and File level sections.

Parameters:

dvs - The Delivery session key

Returns:

IE METS document xml

Throws:

java.lang.Exception - when the dvs is invalid

getFilePathByDvs

java.lang.String getFilePathByDvs(java.lang.String dvs,
                                  java.lang.String pid)
                                  throws java.lang.Exception

Returns the path to a file which is associated to the given dvs. File path is given by the StoragePlugin.getFullFilePath(String).

Parameters:

dvs - The Delivery session key

pid - file PID

Returns:

file path on NFS

Throws:

java.lang.Exception

getDnxDocument

java.lang.String getDnxDocument(java.lang.String dvs,
                                java.lang.String pid)
                                throws java.lang.Exception

Returns the DNX document XML of the entity (IE/REP/FILE) that its PID is associated to the given dvs.

Parameters:

dvs - The Delivery session key

pid - IE/REP/FILE PID

Returns:

DNX document XML

Throws:

java.lang.Exception

getMetadata

java.lang.String getMetadata(java.lang.String dvs,
                             java.lang.String pid,
                             java.lang.String mdType,
                             java.lang.String mdSubType)
                             throws java.lang.Exception

Returns the Metadata XML of the entity (IE/REP/FILE) that its PID is associated to the given dvs.

Parameters:

dvs - The Delivery session key

pid - IE/REP/FILE PID

mdType - Metadata type (e.g. descriptive)

mdSubType - Metadata sub type (e.g. dc)

Returns:

Metadata XML

Throws:

java.lang.Exception

getCMSRecord

java.lang.String getCMSRecord(java.lang.String dvs,
                              java.lang.String iePID)
                              throws java.lang.Exception

Returns the CMS DC XML of the IE.

Parameters:

dvs - The Delivery session key

iePID - IE PID

Returns:

CMS DC XML

Throws:

java.lang.Exception

getBaseFileUrl

java.lang.String getBaseFileUrl(java.lang.String dvs)
                                throws java.lang.Exception

Returns the Stream Gate file viewer base URL for the given dvs. This URL can be used by external viewers to get the files' streams. This method is more recommended than using the getFilePathByDvs as it doesn't expose the file path on the storage to the viewer. The external viewer should append the file PID to the baseFileUrl in order to get the file's stream from Rosetta.

Parameters:

dvs - The Delivery session key

Returns:

Stream Gate file viewer base URL

Throws:

java.lang.Exception