net.bitform.api.secure

Class SecureRequest

java.lang.Object

net.bitform.api.options.OptionSet

net.bitform.api.BasicRequest

net.bitform.api.secure.SecureRequest

public final class SecureRequest
extends BasicRequest

Represents a request to perform an analysis, extraction and/or scrub of a document. This class is an application's primary interface to Clean Content. See the Developer's Guide for exception, object life-cycle, threading, general information and examples of using this class.

Constructor Summary

Constructors

Constructor and Description
SecureRequest() Creates a new SecureRequest object with all options set to their default values.
SecureRequest(java.io.File file) Creates a new SecureRequest object with option values initialized by reading the File provided.
SecureRequest(OptionSet optionset) Creates a new SecureRequest object with all options set to the values in optionset.

Method Summary

Modifier and Type	Method and Description
void	callPDFBox(net.bitform.core.scrubutils.ScrubContext scrubContext)
void	execute() Executes the scrub request.
java.io.File[]	getNamespaceBlacklistFile()
SecureResponse	getResponse() Gets the response to the most recently executed request.
java.io.File[]	getWhitelistNamespacePrefixFiles()
static void	interruptAll() Interrupts all threads that are currently running the execute method of a SecureRequest.
static void	interruptMonitor() Shuts down all running SecureRequests (just like calling interruptAll) plus the monitor thread and all child processes.
void	setNamespaceBlacklistFile(java.io.File[] namespaceBlacklistFile)
void	setWhitelistNamespacePrefixFiles(java.io.File[] whitelistNamespacePrefixFiles)
java.util.logging.Handler	updateXMLFileHandler(java.util.logging.Logger logger)

Methods inherited from class net.bitform.api.options.OptionSet

addTo, clearAllOptions, clearOption, compare, copyTo, copyTo, createBasedOn, equals, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOption, getOptionEnumAsInt, getOptionFileFormatAsInt, getOptionFileFormatListAsIntArray, getXMLHandler, isSet, newEmptyOptionSet, readXML, registerOptions, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption, writeXML, writeXML, writeXML

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecureRequest

public SecureRequest()

Creates a new SecureRequest object with all options set to their default values.

SecureRequest

public SecureRequest(OptionSet optionset)

Creates a new SecureRequest object with all options set to the values in optionset. Note that the optionset's values are copied. Subsiquent changes to the OptionSet argument will not change the options for the request.

Since SecureRequest is itself an OptionSet single SecureRequest can be initialized with a set of options and then more SecureRequest objects with identical options can be created using this constructor with first SecureRequest as the parameter. This patten is espcially useful for creating a series of SecureRequest objects for use in a series of worker threads.

Parameters:

optionset - the options values used to initialize the new request

SecureRequest

public SecureRequest(java.io.File file)

Creates a new SecureRequest object with option values initialized by reading the File provided.

Parameters:

file - An XML file previously written using the writeXML method. If the file cannot be found or is malformed, the request will still be created but all options will have their default values.

Method Detail

getWhitelistNamespacePrefixFiles

public java.io.File[] getWhitelistNamespacePrefixFiles()

setWhitelistNamespacePrefixFiles

public void setWhitelistNamespacePrefixFiles(java.io.File[] whitelistNamespacePrefixFiles)

getNamespaceBlacklistFile

public java.io.File[] getNamespaceBlacklistFile()

setNamespaceBlacklistFile

public void setNamespaceBlacklistFile(java.io.File[] namespaceBlacklistFile)

interruptAll

public static void interruptAll()

Interrupts all threads that are currently running the execute method of a SecureRequest. All such requests will throw a TransformException indicating they have been interrupted. This facility should only be used with due consideration. It is preferable to wait for all requests to finish or timeout.

interruptMonitor

public static void interruptMonitor()

Shuts down all running SecureRequests (just like calling interruptAll) plus the monitor thread and all child processes. A new montior thread will be started the next time a request is executed. The monitor thread's job is to monitor all currently active requests for timeout conditions. Use this method only in cases all threads and child processes in use by Clean Content must be stopped.

updateXMLFileHandler

public java.util.logging.Handler updateXMLFileHandler(java.util.logging.Logger logger)
                                               throws java.lang.SecurityException,
                                                      java.io.IOException

Throws:

java.lang.SecurityException

java.io.IOException

callPDFBox

public void callPDFBox(net.bitform.core.scrubutils.ScrubContext scrubContext)
                throws java.io.IOException

Throws:

java.io.IOException

execute

public void execute()
             throws java.io.IOException

Executes the scrub request. This method will not return until the analysis/scrub has been completed. Results can be retrieved by calling the getResponse method.

Specified by:

execute in class BasicRequest

Throws:

java.io.IOException

getResponse

public SecureResponse getResponse()

Gets the response to the most recently executed request.

Returns:

The response