public interface DeliveryAccessWS
extends com.exlibris.core.infra.svc.api.GenericWebService
Modifier and Type | Method and Description |
---|---|
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 |
getExtendedIEByDVS(java.lang.String dvs,
long flags)
Returns the IE METS document which is associated to the given dvs, including all data defined by the flags.
|
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)
Deprecated.
|
java.lang.String |
getIE(java.lang.String pid)
Deprecated.
|
java.lang.String |
getIEByDVS(java.lang.String dvs)
Deprecated.
|
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.
|
@Deprecated java.lang.String getIE(java.lang.String pid) throws java.lang.Exception
java.lang.Exception
@Deprecated @WSDLDocumentation(value="Returns the IE METS document which is associated to the given dvs, including the IE and Representation level sections.") java.lang.String getIEByDVS(java.lang.String dvs) throws java.lang.Exception
dvs
- The Delivery session keyjava.lang.Exception
- when the dvs is invalid@Deprecated @WSDLDocumentation(value="Returns the IE METS document which is associated to the given dvs, including the IE, Representation and File level sections.") java.lang.String getFullIEByDVS(java.lang.String dvs) throws java.lang.Exception
dvs
- The Delivery session keyjava.lang.Exception
- when the dvs is invalid@WSDLDocumentation(value="Returns the IE METS document which is associated to the given dvs, including all data defined by the flags.") java.lang.String getExtendedIEByDVS(java.lang.String dvs, long flags) throws java.lang.Exception
dvs
- The Delivery session keyflags
- The flag that defines what to include in retrieved Mets. java.lang.Exception
- when the dvs is invalid@WSDLDocumentation(value="Returns the path to a file which is associated to the given dvs. File path is given by the StoragePlugin#getFullFilePath(String)") java.lang.String getFilePathByDvs(java.lang.String dvs, java.lang.String pid) throws java.lang.Exception
StoragePlugin.getFullFilePath(String)
.dvs
- The Delivery session keypid
- file PIDjava.lang.Exception
@WSDLDocumentation(value="Returns the DNX document XML of the entity (IE/REP/FILE) that its PID is associated to the given dvs.") java.lang.String getDnxDocument(java.lang.String dvs, java.lang.String pid) throws java.lang.Exception
dvs
- The Delivery session keypid
- IE/REP/FILE PIDjava.lang.Exception
@WSDLDocumentation(value="Returns the Metadata XML of the entity (IE/REP/FILE) that its PID is associated to the given dvs.") java.lang.String getMetadata(java.lang.String dvs, java.lang.String pid, java.lang.String mdType, java.lang.String mdSubType) throws java.lang.Exception
dvs
- The Delivery session keypid
- IE/REP/FILE PIDmdType
- Metadata type (e.g. descriptive)mdSubType
- Metadata sub type (e.g. dc)java.lang.Exception
@WSDLDocumentation(value="Returns the CMS DC XML of the IE.") java.lang.String getCMSRecord(java.lang.String dvs, java.lang.String iePID) throws java.lang.Exception
dvs
- The Delivery session keyiePID
- IE PIDjava.lang.Exception
@WSDLDocumentation(value="Returns the base file URL for the given dvs. External viewers should append the file PID to the baseFileUrl in order to get the file\'s stream from Rosetta.") java.lang.String getBaseFileUrl(java.lang.String dvs) throws java.lang.Exception
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.dvs
- The Delivery session keyjava.lang.Exception