com.qoppa.pas.api.flow

Interface PASContext

public interface PASContext

The PASContext contains information about the running process as well as access to the services provided by PDF Automation Server.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
Payload	createPayload(File file) Creates a new Payload with a File as the content.
Payload	createPayload(InputStream inStream, String mimeType) Creates a new Payload with an InputStream as the content with the given MIME type.
File	createTempFile(String prefix, String suffix) Creates an empty file in the default temporary-file directory, using the given prefix and suffix to generate its name.
void	log(Level level, String message) Logs a message to the PDF Server console.
void	log(Level level, String message, Throwable t)

Method Detail

createTempFile

File createTempFile(String prefix,
                    String suffix)
             throws IOException

Creates an empty file in the default temporary-file directory, using the given prefix and suffix to generate its name. Creating a temporary file with this method allows the PDF Automation Server Flow to discard temporary files related to the Message after it has finished processing.

Parameters:

prefix - The prefix string to be used in generating the file's name; must be at least three characters long

suffix - The suffix string to be used in generating the file's name; may be null, in which case the suffix ".tmp" will be used

Returns:

An abstract pathname denoting a newly-created empty file

Throws:

IllegalArgumentException - If the prefix argument contains fewer than three characters

IOException - If a file could not be created

SecurityException - If a security manager exists and its SecurityManager.checkWrite(java.lang.String) method does not allow a file to be created

See Also:

createPayload(java.io.File), Message.deriveMessage(Payload)

createPayload

Payload createPayload(File file)

Creates a new Payload with a File as the content. Use this Payload to derive a new Message.

Parameters:

file -

Returns:

a new Payload

See Also:

Message.deriveMessage(Payload)

createPayload

Payload createPayload(InputStream inStream,
                      String mimeType)
               throws IOException

Creates a new Payload with an InputStream as the content with the given MIME type. Use this Payload to derive a new Message.

Parameters:

inStream -

mimeType -

Returns:

Throws:

IOException

log

void log(Level level,
         String message)

Logs a message to the PDF Server console.

Parameters:

level - The level for the log message

message - The content of the log message

log

void log(Level level,
         String message,
         Throwable t)

Parameters:

level - The level for the log message

message - The content of the log message

t - The cause for the log message