com.exlibris.dps.sdk.delivery

Interface ViewerPreProcessor

All Known Implementing Classes:

AbstractViewerPreProcessor

public interface ViewerPreProcessor

Interface for a VPPPlugin type plugin. This plugin processes a Delivery request. It prepares a URL for a specific file viewer based on the parameters given. An implementation of ViewerPreProcessor should use the Access API in order to prepare the metadata/files for the viewer

Author:

lear

Method Summary

Modifier and Type	Method and Description
void	execute() Performs the pre-viewer processing tasks.
java.lang.String	getAdditionalParameters()
java.lang.String	getDvs()
java.lang.String	getPid()
void	init(DnxDocument dnx, java.util.Map<java.lang.String,java.lang.String> viewContext, javax.servlet.http.HttpServletRequest request, java.lang.String dvs, java.lang.String ieParentId, java.lang.String repDirName) This method is called by the Delivery framework before the call for the execute method
boolean	runASync()

Method Detail

init

void init(DnxDocument dnx,
          java.util.Map<java.lang.String,java.lang.String> viewContext,
          javax.servlet.http.HttpServletRequest request,
          java.lang.String dvs,
          java.lang.String ieParentId,
          java.lang.String repDirName)
   throws com.exlibris.dps.sdk.access.AccessException

This method is called by the Delivery framework before the call for the execute method

Parameters:

dnx - The dnx of the requested PID (IE/REP/FILE)

viewContext - Holds the viewer parameters list

request - The HTTP request object

dvs - The Delivery session key

Throws:

com.exlibris.dps.sdk.access.AccessException

execute

void execute()
      throws java.lang.Exception

Performs the pre-viewer processing tasks. For example: 1. Copies the stream to the viewer directory. 2. Runs XSLT

Throws:

java.lang.Exception

runASync

boolean runASync()

Returns:

true for Asyncronized pre-processing, meaning the vpp will be run in a separate thread while the viewer displays a progress bar. otherwise return false.

getPid

java.lang.String getPid()

Returns:

the requested pid

getDvs

java.lang.String getDvs()

Returns:

dvs- the delivery session key

getAdditionalParameters

java.lang.String getAdditionalParameters()

Returns:

additional parameters needed for the viewer