com.endeca.infront.assembler

Class AssemblerSettings

java.lang.Object

com.endeca.infront.assembler.AssemblerSettings

public class AssemblerSettings
extends Object

Used to configure an Assembler.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREVIEW_MODULE_URL Key for storing preview URL on content items output by the Assembler.

Constructor Summary

Constructors

Constructor and Description
AssemblerSettings()

Method Summary

Modifier and Type	Method and Description
List<com.endeca.infront.assembler.support.AssemblerResponseDecorator>	getAssemblerResponseDecorators()
String	getPreviewModuleUrl() Returns the preview module URL, for use when preview is enabled.
boolean	isAuditEnabled() Returns whether or not audit contents should be retrieved.
boolean	isPreviewEnabled()
void	setPreviewEnabled(boolean previewEnabled) Sets whether or not preview should be enabled.
void	setPreviewModuleUrl(String previewUrl) Sets the preview module URL.

Methods inherited from class java.lang.Object

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

Field Detail

PREVIEW_MODULE_URL

public static final String PREVIEW_MODULE_URL

Key for storing preview URL on content items output by the Assembler.

See Also:

Constant Field Values

Constructor Detail

AssemblerSettings

public AssemblerSettings()

Method Detail

isPreviewEnabled

public boolean isPreviewEnabled()

Returns:

true if preview functionality has been enabled, false otherwise.

setPreviewEnabled

public void setPreviewEnabled(boolean previewEnabled)

Sets whether or not preview should be enabled.

Parameters:

previewEnabled - whether preview should be enabled

getPreviewModuleUrl

public String getPreviewModuleUrl()

Returns the preview module URL, for use when preview is enabled. Note that this method should not be called if isPreviewEnabled() returns false.

Returns:

the URL to the preview servlet. Always check isPreviewEnabled() before calling this method.

Throws:

IllegalStateException - if this method is called when preview is disabled.

setPreviewModuleUrl

public void setPreviewModuleUrl(String previewUrl)

Sets the preview module URL.

Parameters:

previewUrl - the new preview module URL

isAuditEnabled

public boolean isAuditEnabled()

Returns whether or not audit contents should be retrieved. Currently this is linked to the value of isPreviewEnabled() (audit contents are enabled when and only when preview is enabled). In the future, this property may be separately configurable.

Returns:

whether or not audit is enabled

getAssemblerResponseDecorators

public List<com.endeca.infront.assembler.support.AssemblerResponseDecorator> getAssemblerResponseDecorators()

Returns:

a list of decorators that may modify the results of Assembler.assemble(ContentItem).