Package com.aquima.web.config

Class DefaultWebConfiguration

java.lang.Object

com.aquima.web.config.DefaultWebConfiguration

All Implemented Interfaces:

IWebConfiguration

public class DefaultWebConfiguration
extends Object
implements IWebConfiguration

Default implementation for the web configuration. Used for specifying advanced options for the Aquima PortalEngine. It uses the DefaultApplicationConfiguration for default settings.

Extend this class and annotate with @AquimaWebConfiguration to configure Aquima applications.

Since:

8.0

Author:

Danny Roest

Constructor Summary

Constructors

Constructor	Description
DefaultWebConfiguration()	Constructs a default web configuration.

Method Summary

Modifier and Type	Method	Description
protected void	init()
void	setCachingEnabled(boolean cachingEnabled)	This method allows for enabling or disabling of the application cache.
void	setClearEventOnRefresh(boolean clearEventOnRefresh)	This method configures whether the system event is cleared when a page refresh is executed.
void	setContextMutableFor(List<String> containerTypes)	This method can be used to configure if the context should not be read only during the expand of a container.
void	setContinueOnFailedDocument(boolean value)	This method may be used to set whether failed elements in a document should be wrapped.
void	setFormatDefinitionStore(IFormatDefinitionStore formatDefinitionStore)
void	setOutputFailedMasks(boolean value)	This method may be used to set whether failed masks should be outputted.
void	setParserVersion(String parserVersion)	This method may be used to specify the version of the expression parser that should be used.
void	setRules(List<com.aquima.interactions.ds.RuleDefinition> ruleDefinitions)	This method may be used to specify additional rule definitions.
void	setTargetDownCastingEnabled(boolean enable)	This method can be used to configure if the targets of a rule may be down casted automatically when needed to the correct type of the rule's target.
void	setWrapFailedElements(boolean value)	This method may be used to set whether failed elements should be wrapped.
com.aquima.interactions.ds.IApplicationConfiguration	toApplicationConfiguration(AnnotatedConfigContext context, com.aquima.interactions.portal.ApplicationMode applicationMode)	This method returns an application configuration based on the set properties and with the specified factory manager.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultWebConfiguration

public DefaultWebConfiguration()

Constructs a default web configuration.

Method Details

init

protected void init()

setFormatDefinitionStore

public void setFormatDefinitionStore(IFormatDefinitionStore formatDefinitionStore)

toApplicationConfiguration

public com.aquima.interactions.ds.IApplicationConfiguration toApplicationConfiguration(AnnotatedConfigContext context,
 com.aquima.interactions.portal.ApplicationMode applicationMode)

Description copied from interface: IWebConfiguration

This method returns an application configuration based on the set properties and with the specified factory manager.

Specified by:

toApplicationConfiguration in interface IWebConfiguration

Parameters:

context - the context containing the classes found using annotations

applicationMode - the application mode

Returns:

an application configuration.

setCachingEnabled

public void setCachingEnabled(boolean cachingEnabled)

This method allows for enabling or disabling of the application cache. A caching solution is more efficient when creating a session since it will use a load-once use-frequent system.

Parameters:

cachingEnabled - A boolean indicating caching is enabled.

setClearEventOnRefresh

public void setClearEventOnRefresh(boolean clearEventOnRefresh)

This method configures whether the system event is cleared when a page refresh is executed. The default for this setting is false; meaning the even will not be cleared on a refresh.

Parameters:

clearEventOnRefresh - A boolean indicating the system even should be cleared during a page-refresh.

setContextMutableFor

public void setContextMutableFor(List<String> containerTypes)

This method can be used to configure if the context should not be read only during the expand of a container. By default the context will be read-only for all containers.

Parameters:

containerTypes - boolean List containing the container type names for which the context should not be read-only.

setTargetDownCastingEnabled

public void setTargetDownCastingEnabled(boolean enable)

This method can be used to configure if the targets of a rule may be down casted automatically when needed to the correct type of the rule's target. The default for this option is false.

Parameters:

enable - Boolean indicating if targets may be automatically down casted to the correct type.

setParserVersion

public void setParserVersion(String parserVersion)

This method may be used to specify the version of the expression parser that should be used. The default for this option is equal to the version of the runtime (for instance 6.4).

Parameters:

parserVersion - the version of the expression parser that should be used.

setRules

public void setRules(List<com.aquima.interactions.ds.RuleDefinition> ruleDefinitions)

This method may be used to specify additional rule definitions. The list passed to this method should contain objects of the RuleDefinition class (or that extend it).

Parameters:

ruleDefinitions - List containing additional rule definitions.

See Also:

• RuleDefinition

setOutputFailedMasks

public void setOutputFailedMasks(boolean value)

This method may be used to set whether failed masks should be outputted.

Parameters:

value - whether failed masks should be outputted.

setWrapFailedElements

public void setWrapFailedElements(boolean value)

This method may be used to set whether failed elements should be wrapped.

Parameters:

value - whether elements masks should be wrapped.

setContinueOnFailedDocument

public void setContinueOnFailedDocument(boolean value)

This method may be used to set whether failed elements in a document should be wrapped.

Parameters:

value - whether elements in a document should be wrapped.