com.adobe.service.ddxm.client
Class Environment

java.lang.Object
  com.adobe.service.ddxm.client.Environment

All Implemented Interfaces:

java.io.Serializable

public class Environment
extends java.lang.Object
implements java.io.Serializable

Environment is the container for the "environment" options for a DDX job. Current environment parameters include the job log level, the default font, and flags to indicate if the DDX job is a validation-only test or if it should fail at the first sign of trouble.

See Also:

Serialized Form

Constructor Summary

Environment()

Method Summary

java.lang.String	getDefaultFontStyle() Retrieves the default font style.
java.util.Locale	getDefaultLocale() Retrieves the default locale.
java.util.logging.Level	getLogLevel() Retrieves the log level.
boolean	isFailOnError() Determines whether the DDX job should exit immediately when an Exception or other error occurs.
boolean	isFipsCompliant() Specifies whether FIPS 140-2 should be followed.
boolean	isValidateOnly() Determines whether the DDX job is a validation-only test.
void	setDefaultFontStyle(java.lang.String defaultFontStyle) Sets the default font.
void	setDefaultLocale(java.util.Locale defaultLocale) Specifies the locale to use if no TargetLocale is specified in the DDX.
void	setFailOnError(boolean failOnError) Sets whether the DDX job should exit immediately when an Exception or other error occurs.
void	setFipsCompliant(boolean fipsCompliant) Specifies whether FIPS 140-2 should be followed.
void	setLogLevel(java.util.logging.Level logLevel) Sets the log level.
void	setValidateOnly(boolean validateOnly) Sets whether the DDX job is a validation-only test, which means that Assembler should validate the DDX but not execute it.

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment()

Method Detail

getDefaultFontStyle

public java.lang.String getDefaultFontStyle()

Retrieves the default font style.

Returns:

A java.lang.String containing the default font style.

setDefaultFontStyle

public void setDefaultFontStyle(java.lang.String defaultFontStyle)

Sets the default font.

Parameters:

defaultFontStyle - The default font style to be set.

getLogLevel

public java.util.logging.Level getLogLevel()

Retrieves the log level.

Returns:

A java.lang.String containing the log level.

setLogLevel

public void setLogLevel(java.util.logging.Level logLevel)

Sets the log level.

Parameters:

logLevel - The log level to be set.

isValidateOnly

public boolean isValidateOnly()

Determines whether the DDX job is a validation-only test.

Returns:

true if the DDX job is a validation-only test, false otherwise.

setValidateOnly

public void setValidateOnly(boolean validateOnly)

Sets whether the DDX job is a validation-only test, which means that Assembler should validate the DDX but not execute it.

Parameters:

validateOnly - A value of true halts processing of the DDX after the DDX has been parsed and verified to be in compliance with the schema and application validation rules. In this case the result map will be null, and the input map is allowed to be empty or null since the input data streams are not evaluated until actually used during job execution. The default is false, meaning that normal processing will be performed.

isFailOnError

public boolean isFailOnError()

Determines whether the DDX job should exit immediately when an Exception or other error occurs.

Returns:

true if the DDX job should exit immediately when an Exception or other error occurs, false otherwise.

setFailOnError

public void setFailOnError(boolean failOnError)

Sets whether the DDX job should exit immediately when an Exception or other error occurs.

Parameters:

failOnError - A value of true means that the job will terminate upon an error or exception condition and throw the corresponding Throwable exception. A value of false means that the job will terminate the current DDX result block, store the Throwable exception in the output map, and attempt to execute any remaining result blocks. The default is true, meaning that the first error will terminate the DDX job immediately.

getDefaultLocale

public java.util.Locale getDefaultLocale()

Retrieves the default locale.

Returns:

The default locale.

setDefaultLocale

public void setDefaultLocale(java.util.Locale defaultLocale)

Specifies the locale to use if no TargetLocale is specified in the DDX. Initially the default locale is java.util.Locale.ENGLISH.

Parameters:

defaultLocale - the defaultLocale to set

isFipsCompliant

public boolean isFipsCompliant()

Specifies whether FIPS 140-2 should be followed.

Returns:

true if FIPS 140-2 should be followed, false otherwise.

setFipsCompliant

public void setFipsCompliant(boolean fipsCompliant)

Specifies whether FIPS 140-2 should be followed.

Parameters:

fipsCompliant - true if FIPS 140-2 should be followed, false otherwise.