com.qoppa.pas.api.flow

Interface JavaNode

public interface JavaNode

This interface allows executing Java code inside of a Flow in the PDF Automation Server.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
Message[]	process(PASContext pasContext, Message message) This method is called during the Flow execution in the PDF Automation Server.

Method Detail

process

Message[] process(PASContext pasContext,
                  Message message)
           throws FlowException

This method is called during the Flow execution in the PDF Automation Server. If no modification needs to be done to the Payload content, the return Message array can just contain the same Message passed to this method. Otherwise, if the implementation will modify the Payload content (ie. create new data to be processed in the Flow), a new Message along with a new Payload needs to be returned instead.

In order to create a new Payload, a File is required. If the File should be deleted when the Flow completes processing of the Message, the File should be created using PASContext.createTempFile(String, String).

 File output = pasContext.createTempFile("prefix", ".ext");
 
 // TODO - write new data to the output
 
 Payload payload = pasContext.createPayload(output);
 
 Message newMessage = message.deriveMessage(payload);
 
 return new Message[]{ newMessage };
 

Parameters:

pasContext - the pasContext

message - the Message for the current process.

Returns:

an array of Messages to continue processing through the Flow.

Throws:

FlowException

See Also:

Message.getPayload(), PASContext.createPayload(File), Message.deriveMessage(Payload)