Package org.ghost4j.modifier

Class AbstractRemoteModifier

java.lang.Object

org.ghost4j.AbstractComponent

org.ghost4j.AbstractRemoteComponent

org.ghost4j.modifier.AbstractRemoteModifier

All Implemented Interfaces:

Component, Modifier, RemoteModifier

Direct Known Subclasses:

SafeAppenderModifier

public abstract class AbstractRemoteModifier
extends AbstractRemoteComponent
implements RemoteModifier

Abstract remote modifier implementation. Used as base class for remote modifiers.

Field Summary

Fields inherited from class org.ghost4j.AbstractRemoteComponent

maxProcessCount, processCount

Fields inherited from class org.ghost4j.AbstractComponent

supportedDocumentClasses

Constructor Summary

Constructors

Constructor	Description
AbstractRemoteModifier()

Method Summary

Modifier and Type	Method	Description
Document	modify(Document source, java.util.Map<java.lang.String,java.io.Serializable> parameters)	Modify a document with optional parameters
Document	remoteModify(Document source, java.util.Map<java.lang.String,java.io.Serializable> parameters)
protected abstract Document	run(Document source, java.util.Map<java.lang.String,java.io.Serializable> parameters)
protected static void	startRemoteModifier(RemoteModifier remoteModifier)	Starts a remote modifier server.

Methods inherited from class org.ghost4j.AbstractRemoteComponent

buildJavaFork, getMaxProcessCount, getProcessCount, getRemoteComponent, isStandAloneModeSupported, setMaxProcessCount, startRemoteServer, waitForFreeProcess

Methods inherited from class org.ghost4j.AbstractComponent

assertDeviceSupported, assertDocumentSupported, copySettings, extractSettings, isDeviceSupported

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ghost4j.modifier.RemoteModifier

setMaxProcessCount

Constructor Detail

AbstractRemoteModifier

public AbstractRemoteModifier()

Method Detail

run

protected abstract Document run(Document source,
                                java.util.Map<java.lang.String,java.io.Serializable> parameters)
                         throws ModifierException,
                                DocumentException,
                                java.io.IOException

Throws:

ModifierException

DocumentException

java.io.IOException

startRemoteModifier

protected static void startRemoteModifier(RemoteModifier remoteModifier)
                                   throws ModifierException

Starts a remote modifier server.

Parameters:

remoteModifier -

Throws:

ModifierException

remoteModify

public Document remoteModify(Document source,
                             java.util.Map<java.lang.String,java.io.Serializable> parameters)
                      throws ModifierException,
                             DocumentException,
                             java.io.IOException

Throws:

ModifierException

DocumentException

java.io.IOException

modify

public Document modify(Document source,
                       java.util.Map<java.lang.String,java.io.Serializable> parameters)
                throws ModifierException,
                       DocumentException,
                       java.io.IOException

Description copied from interface: Modifier

Modify a document with optional parameters

Specified by:

modify in interface Modifier

Parameters:

source - Document to modify

parameters - Modifier parameters

Returns:

Modifier version of the document

Throws:

ModifierException

DocumentException

java.io.IOException