org.apache.cocoon.servlet
Class ServletSettings

java.lang.Object
  org.apache.cocoon.servlet.ServletSettings

public class ServletSettings

extends Object

Helper class for managing Cocoon servlet specific settings.

Since:

2.2

Version:

$Id: ServletSettings.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary

static boolean	HIDE_SHOW_TIME Default value for KEY_HIDE_SHOWTIME parameter (false).
protected boolean	hideShowTime If true, processing time will be added as an HTML comment
static String	KEY_HIDE_SHOWTIME If true, processing time will be added as an HTML comment
static String	KEY_MANAGE_EXCEPTIONS If true or not set, this class will try to catch and handle all Cocoon exceptions.
static String	KEY_SHOW_VERSION If true, the X-Cocoon-Version response header will be included.
static String	KEY_SHOWTIME Allow adding processing time to the response
static boolean	MANAGE_EXCEPTIONS Default value for KEY_MANAGE_EXCEPTIONS parameter (true).
protected boolean	manageExceptions If true or not set, this class will try to catch and handle all Cocoon exceptions.
static boolean	SHOW_COCOON_VERSION Default value for KEY_SHOW_VERSION parameter (true).
static boolean	SHOW_TIME Default value for KEY_SHOWTIME parameter (false).
protected boolean	showCocoonVersion If true, the X-Cocoon-Version response header will be included.
protected boolean	showTime Allow adding processing time to the response

Constructor Summary

ServletSettings(org.apache.cocoon.configuration.Settings s)

Method Summary

boolean	isHideShowTime()
boolean	isManageExceptions()
boolean	isShowTime()
boolean	isShowVersion()
void	setHideShowTime(boolean hideShowTime)
void	setManageExceptions(boolean manageExceptions)
void	setShowCocoonVersion(boolean showCocoonVersion)
void	setShowTime(boolean showTime)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_SHOWTIME

public static String KEY_SHOWTIME

Allow adding processing time to the response

KEY_HIDE_SHOWTIME

public static String KEY_HIDE_SHOWTIME

If true, processing time will be added as an HTML comment

KEY_SHOW_VERSION

public static String KEY_SHOW_VERSION

If true, the X-Cocoon-Version response header will be included.

KEY_MANAGE_EXCEPTIONS

public static String KEY_MANAGE_EXCEPTIONS

If true or not set, this class will try to catch and handle all Cocoon exceptions. If false, it will rethrow them to the servlet container.

SHOW_TIME

public static final boolean SHOW_TIME

Default value for KEY_SHOWTIME parameter (false).

See Also:

Constant Field Values

HIDE_SHOW_TIME

public static final boolean HIDE_SHOW_TIME

Default value for KEY_HIDE_SHOWTIME parameter (false).

See Also:

Constant Field Values

SHOW_COCOON_VERSION

public static final boolean SHOW_COCOON_VERSION

Default value for KEY_SHOW_VERSION parameter (true).

See Also:

Constant Field Values

MANAGE_EXCEPTIONS

public static final boolean MANAGE_EXCEPTIONS

Default value for KEY_MANAGE_EXCEPTIONS parameter (true).

See Also:

Constant Field Values

showTime

protected boolean showTime

Allow adding processing time to the response

hideShowTime

protected boolean hideShowTime

If true, processing time will be added as an HTML comment

showCocoonVersion

protected boolean showCocoonVersion

If true, the X-Cocoon-Version response header will be included.

manageExceptions

protected boolean manageExceptions

If true or not set, this class will try to catch and handle all Cocoon exceptions. If false, it will rethrow them to the servlet container.

Constructor Detail

ServletSettings

public ServletSettings(org.apache.cocoon.configuration.Settings s)

Method Detail

isHideShowTime

public boolean isHideShowTime()

Returns:

Returns the hideShowTime.

See Also:

KEY_HIDE_SHOWTIME

isManageExceptions

public boolean isManageExceptions()

Returns:

Returns the manageExceptions.

See Also:

KEY_MANAGE_EXCEPTIONS

isShowTime

public boolean isShowTime()

Returns:

Returns the showTime.

See Also:

KEY_SHOWTIME

isShowVersion

public boolean isShowVersion()

Returns:

Returns the showCocoonVersion.

See Also:

KEY_SHOW_VERSION

setHideShowTime

public void setHideShowTime(boolean hideShowTime)

Parameters:

hideShowTime - The hideShowTime to set.

setManageExceptions

public void setManageExceptions(boolean manageExceptions)

Parameters:

manageExceptions - The manageExceptions to set.

setShowTime

public void setShowTime(boolean showTime)

Parameters:

showTime - The showTime to set.

setShowCocoonVersion

public void setShowCocoonVersion(boolean showCocoonVersion)

Parameters:

showCocoonVersion - The showCocoonVersion flag to set.