org.opencms.main
Class CmsServletContainerSettings

java.lang.Object
  extended byorg.opencms.main.CmsServletContainerSettings

public class CmsServletContainerSettings
extends java.lang.Object

Stores specific servlet container options, that might influence OpenCms behavior.

Since:
7.0.5
Version:
$Revision: 1.2 $
Author:
Michael Moossen

Nested Class Summary
static class CmsServletContainerSettings.CmsServletContainerCfgMode
          Enumeration class for the configuration mode.
 
Field Summary
static CmsServletContainerSettings.CmsServletContainerCfgMode CFG_MODE_AUTO
          String remote command execution return type.
static CmsServletContainerSettings.CmsServletContainerCfgMode CFG_MODE_MANUAL
          Map remote command execution return type.
static CmsServletContainerSettings.CmsServletContainerCfgMode CFG_MODE_NONE
          List remote command execution return type.
 
Constructor Summary
CmsServletContainerSettings(java.lang.String servletContainerName)
          Creates a new object.
 
Method Summary
 CmsServletContainerSettings.CmsServletContainerCfgMode getMode()
          Returns the mode.
 java.lang.String getRequestErrorPageAttribute()
          Returns the request error page attribute.
 java.lang.String getServletContainerName()
          Returns the name of the servlet container running OpenCms.
 boolean isPreventResponseFlush()
          Checks if the flex response has to prevent buffer flushing.
 boolean isReleaseTagsAfterEnd()
          Checks if the tags need to be released after ending.
 boolean isServletThrowsException()
          Checks if the servlet can throw an exception if initialization fails.
 void setMode(java.lang.String configValue)
          Sets the mode from the configuration.
 void setPreventResponseFlush(boolean preventResponseFlush)
          Sets if the flex response has to prevent buffer flushing.
 void setReleaseTagsAfterEnd(boolean releaseTagsAfterEnd)
          Sets if the tags need to be released after ending.
 void setRequestErrorPageAttribute(java.lang.String requestErrorPageAttribute)
          Sets the request error page attribute.
 void setServletThrowsException(boolean servletThrowsException)
          Sets if the servlet can throw an exception if initialization fails.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CFG_MODE_AUTO

public static final CmsServletContainerSettings.CmsServletContainerCfgMode CFG_MODE_AUTO
String remote command execution return type.


CFG_MODE_MANUAL

public static final CmsServletContainerSettings.CmsServletContainerCfgMode CFG_MODE_MANUAL
Map remote command execution return type.


CFG_MODE_NONE

public static final CmsServletContainerSettings.CmsServletContainerCfgMode CFG_MODE_NONE
List remote command execution return type.

Constructor Detail

CmsServletContainerSettings

public CmsServletContainerSettings(java.lang.String servletContainerName)
Creates a new object.

Parameters:
servletContainerName - the name of the current running servlet container
Method Detail

getMode

public CmsServletContainerSettings.CmsServletContainerCfgMode getMode()
Returns the mode.

Returns:
the mode

getRequestErrorPageAttribute

public java.lang.String getRequestErrorPageAttribute()
Returns the request error page attribute.

Returns:
the request error page attribute

getServletContainerName

public java.lang.String getServletContainerName()
Returns the name of the servlet container running OpenCms.

Returns:
the name of the servlet container running OpenCms

isPreventResponseFlush

public boolean isPreventResponseFlush()
Checks if the flex response has to prevent buffer flushing.

Returns:
true if the flex response has to prevent buffer flushing

isReleaseTagsAfterEnd

public boolean isReleaseTagsAfterEnd()
Checks if the tags need to be released after ending.

Returns:
true if the tags need to be released after ending

isServletThrowsException

public boolean isServletThrowsException()
Checks if the servlet can throw an exception if initialization fails.

Returns:
true if the servlet can throw an exception if initialization fails

setMode

public void setMode(java.lang.String configValue)
Sets the mode from the configuration.

Parameters:
configValue - the mode to set

setPreventResponseFlush

public void setPreventResponseFlush(boolean preventResponseFlush)
Sets if the flex response has to prevent buffer flushing.

Parameters:
preventResponseFlush - the flag to set

setReleaseTagsAfterEnd

public void setReleaseTagsAfterEnd(boolean releaseTagsAfterEnd)
Sets if the tags need to be released after ending.

Parameters:
releaseTagsAfterEnd - the flag to set

setRequestErrorPageAttribute

public void setRequestErrorPageAttribute(java.lang.String requestErrorPageAttribute)
Sets the request error page attribute.

Parameters:
requestErrorPageAttribute - the request error page attribute to set

setServletThrowsException

public void setServletThrowsException(boolean servletThrowsException)
Sets if the servlet can throw an exception if initialization fails.

Parameters:
servletThrowsException - the flag to set