net.bitform.api

Class SharedOptions

java.lang.Object

net.bitform.api.options.OptionContainer

net.bitform.api.SharedOptions

public class SharedOptions
extends OptionContainer

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectListOption	CheckboxActions List of actions to perform on named checkboxes in the document while scrubbing.
static ObjectOption	DebugInfoCollector Oracle internal option.
static EnumOption	DecryptionStatus Provides information on if and how decryption took place.
static BooleanOption	JustIdentify Ignore all other settings and just identify the file format of the source document.
static BooleanOption	LoggedError An error occured and was logged while processing the document.
static BooleanOption	LoggedWarning A warning occured and was logged while processing the document.
static EnumOption	ProcessingStatus Describes why the document could not be processed.
static IntegerOption	RequestTimeout Amount of time in milliseconds a request can execute before being timed out.
static FileOption	SourceDocument The document to process.
static FileFormatOption	SourceFormat The file format of the source document.
static BooleanOption	TimeoutUsingThreadStop If set to 'true', requests in tight infinite loops will be stopped using the depricated Thread.stop method.
static BooleanOption	WasException An exception occured while processing the document.
static BooleanOption	WasIdentified The source document was identified.
static BooleanOption	WasProcessed The source document was scrubbed, analyzed or extracted.
static BooleanOption	WasSupported The source document's file format is supported.
static BooleanOption	WasTimeout Document took long than the request's RequestTimeout value to process.

Method Summary

Modifier and Type	Method and Description
OptionContainer[]	getAllContainers() Get all the option containers in this container
Option[]	getAllOptions() Gets all the options in this container
Option	mapOptionId(int id) Maps an integer id of an option in this list to the option itself.
Option	mapOptionId(java.lang.String id) Maps an string id of an option in this list to the option itself.

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

getId, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

SourceDocument

public static final FileOption SourceDocument

The document to process.

This option gives the developer a number of ways to provide the document to analyze, scrub or extract.

SourceFormat

public static final FileFormatOption SourceFormat

The file format of the source document.

This result provides the file format of the source document.

WasIdentified

public static final BooleanOption WasIdentified

The source document was identified.

The source document was identified.

Default value is false

WasSupported

public static final BooleanOption WasSupported

The source document's file format is supported.

The source document's file format is supported and processing was attempted.

Default value is false

WasProcessed

public static final BooleanOption WasProcessed

The source document was scrubbed, analyzed or extracted.

The source document was scrubbed, analyzed or extracted. Will be set to false if no component could be found to process the source document.

Default value is false

WasException

public static final BooleanOption WasException

An exception occured while processing the document.

An exception occured while processing the document. This is somewhat redundant since the developer will receive the exception itself but is included so the SecureResult can stand alone to completely describe the result of processing a document.

Default value is false

WasTimeout

public static final BooleanOption WasTimeout

Document took long than the request's RequestTimeout value to process.

The document took long than the request's RequestTimeout value to process or was interrupted.

Default value is false

ProcessingStatus

public static final EnumOption ProcessingStatus

Describes why the document could not be processed.

An enumeration of the possible reasons the document could not be processed.

Only the following values are allowed:

ProcessingStatusOption.Processed
The document was processed successfully

ProcessingStatusOption.NotIdentified
The document could not be indetified

ProcessingStatusOption.NotSupported
The document's file format is not supported

ProcessingStatusOption.CausedException
Processing the document caused an exception

ProcessingStatusOption.Timeout
Processing the document timed out before it could complete

Default value is PROCESSINGSTATUS_Processed

DecryptionStatus

public static final EnumOption DecryptionStatus

Provides information on if and how decryption took place.

An enumeration of the possible outcomes of decryption.

Only the following values are allowed:

DecryptionStatusOption.NotEncrypted
The document contained no encryption

DecryptionStatusOption.DecryptedWithDefaultPassword
Parts of the document were encrypted and were successfully decrypted with the default password

DecryptionStatusOption.DecryptedWithPasswordList
Parts of the document were encrypted and were successfully decrypted with a password from the list provided

DecryptionStatusOption.DecryptionFailed
Parts of the document were encrypted but could not be decrypted with any of the default or provided passwords

DecryptionStatusOption.DecryptionNotSupported
Parts of the document were encrypted using an unsupported encryption method

Default value is DECRYPTIONSTATUS_NotEncrypted

LoggedError

public static final BooleanOption LoggedError

An error occured and was logged while processing the document.

An error occured and was logged while processing the document. Errors include exceptions that end processing (WasException will also be true) and other conditions that don't cause exceptions but may lead major loss of functionallity. See the log for details.

Default value is false

LoggedWarning

public static final BooleanOption LoggedWarning

A warning occured and was logged while processing the document.

A warning occured and was logged while processing the document. Warnings include conditions that may lead to small losses of functionallity. See log for details.

Default value is false

RequestTimeout

public static final IntegerOption RequestTimeout

Amount of time in milliseconds a request can execute before being timed out.

The amount of time in milliseconds a request can execute before being timed out. Timeouts are useful for the extreemly rare cases where malformed documents cause infinite loops within the Clean Content code. While it is tempting to set this number low since most documents process in much less than 100 ms, very large or complex documents can take a significant amount of time to process hence the 2 minute default for this option. A value of zero may be used to disable timeout for the request but this is not recommended.

Default value is 120000

TimeoutUsingThreadStop

public static final BooleanOption TimeoutUsingThreadStop

If set to 'true', requests in tight infinite loops will be stopped using the depricated Thread.stop method.

When a malformed document pushes Clean Content into an infinite loop, a monitoring thread attempts to interrupt the thread after a certain timeout period given by the RequestTimeout option. One of two things will then occur: 1) if the request is in a loop that can be interrupted then the request will be stopped and the SecureRequest execute method will return, 2) if in the very rare case the request is in a tight loop and this option is set to 'true' the monitoring thread will use the depricate Thread.stop method to kill the thread. Anyone setting this option to 'true' must understand the implications of having the Java thread running the request destroyed. See the Java API documentation for java.lang.Thread for details.

Default value is false

JustIdentify

public static final BooleanOption JustIdentify

Ignore all other settings and just identify the file format of the source document.

When this option is true the only action that will be taken is to identify the file format of the source document.

Default value is false

CheckboxActions

public static final ObjectListOption CheckboxActions

List of actions to perform on named checkboxes in the document while scrubbing.

A List of actions to perform on named checkboxes in the document while scrubbing.

DebugInfoCollector

public static final ObjectOption DebugInfoCollector

Oracle internal option.

Oracle internal option

Method Detail

mapOptionId

public Option mapOptionId(int id)

Description copied from class: OptionContainer

Maps an integer id of an option in this list to the option itself. This is likely faster than getting all the options and enumerating/testing them.

Specified by:

mapOptionId in class OptionContainer

Parameters:

id - The unique string identifier for an option

Returns:

The option if it exists in this list or null if it cannot be found

getAllOptions

public final Option[] getAllOptions()

Description copied from class: OptionContainer

Gets all the options in this container

Specified by:

getAllOptions in class OptionContainer

Returns:

an array containing all the requested options

mapOptionId

public final Option mapOptionId(java.lang.String id)

Description copied from class: OptionContainer

Maps an string id of an option in this list to the option itself. This is likely faster than getting all the options and enumerating/testing them.

Specified by:

mapOptionId in class OptionContainer

Parameters:

id - The unique string identifier for an option

Returns:

The option if it exists in this list or null if it cannot be found

getAllContainers

public final OptionContainer[] getAllContainers()

Description copied from class: OptionContainer

Get all the option containers in this container

Specified by:

getAllContainers in class OptionContainer

Returns:

an array containing all the containers