Package com.jadice.web.export.server.serveroperation

Class AbstractExportServerOperation<P extends ServerOperationParameters<M>,M extends ServerOperationMessage,T extends Exporter>

java.lang.Object

com.jadice.web.export.server.serveroperation.AbstractExportServerOperation<P,M,T>

Type Parameters:

P - the type of the expected parameter object

M - the type of the allowed message objects

T - the type of Exporter to be used.

All Implemented Interfaces:

ServerOperation<P,M>

Direct Known Subclasses:

AbstractPDFExportServerOperation, AbstractPostscriptExportServerOperation, AbstractTIFFExportServerOperation, ExportServerOperation

public abstract class AbstractExportServerOperation<P extends ServerOperationParameters<M>,M extends ServerOperationMessage,T extends Exporter>
extends Object
implements ServerOperation<P,M>

Common base class for generating exports by implementing ServerOperation and using a specific Exporter.

In most cases this class should not be extended directly. Instead extend one of the following classes:

• AbstractPostscriptExportServerOperation
• AbstractTIFFExportServerOperation
• AbstractPDFExportServerOperation

Usage

Extensions of this class are intended to be used as a ServerOperation. As such, the jadice web toolkit will take care of synchronizing the document from the client to the server to ensure a consistent state when the export is to be executed.

Registration

An implementation of a AbstractExportServerOperation shall be registered using the standard mechanism for ServerOperations using ServerOperationRegistry.

Nested Class Summary

Nested classes/interfaces inherited from interface com.levigo.jadice.web.server.ServerOperation

ServerOperation.Request<P>, ServerOperation.ResponseChannel<M>

Constructor Summary

Constructors

Constructor	Description
AbstractExportServerOperation()

Method Summary

Modifier and Type	Method	Description
protected abstract T	createExporter(ServerOperation.Request<P> request)	Create the appropriate Exporter instance.
protected abstract void	doExport(ServerOperation.Request<P> request, ServerOperation.ResponseChannel<M> responseChannel, T exporter)	Perform the actual export process.
void	invoke(ServerOperation.Request<P> request, ServerOperation.ResponseChannel<M> responseChannel)	Executes the operation asynchronously on the server side.
protected void	onExportFailed(ServerOperation.Request<P> request, ServerOperation.ResponseChannel<M> responseChannel, T exporter)	A method that can be overridden if an export-fail should be handled

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractExportServerOperation

public AbstractExportServerOperation()

Method Details

invoke

public void invoke(ServerOperation.Request<P> request,
 ServerOperation.ResponseChannel<M> responseChannel)
            throws Exception

Description copied from interface: ServerOperation

Executes the operation asynchronously on the server side.

Specified by:

invoke in interface ServerOperation<P extends ServerOperationParameters<M>,M extends ServerOperationMessage>

Parameters:

request - The client request containing the configuration for the execution

responseChannel - The channel which the server uses to notify the client

Throws:

Exception - In the case of a server side error during the execution of the operation an exception is thrown. Catching this exception on the client side can be used to implement error handling.

doExport

protected abstract void doExport(ServerOperation.Request<P> request,
 ServerOperation.ResponseChannel<M> responseChannel,
 T exporter)
                          throws Exception

Perform the actual export process.

Parameters:

request - the associated ServerOperation.Request. For Details see ServerOperation.Request

responseChannel - the associated ServerOperation.ResponseChannel. For details see ServerOperation.ResponseChannel

exporter - the Exporter instance that shall be configured to perform the export.

Throws:

Exception

createExporter

protected abstract T createExporter(ServerOperation.Request<P> request)

Create the appropriate Exporter instance. The instance shall not be shared and will be used exclusively by a single export task.

Parameters:

request -

Returns:

an Exporter instance.

onExportFailed

protected void onExportFailed(ServerOperation.Request<P> request,
 ServerOperation.ResponseChannel<M> responseChannel,
 T exporter)

A method that can be overridden if an export-fail should be handled

Parameters:

request - the associated ServerOperation.Request. For Details see ServerOperation.Request

responseChannel - the associated ServerOperation.ResponseChannel. For details see ServerOperation.ResponseChannel

exporter - the Exporter instance that shall be configured to perform the export.