com.liferay.faces.bridge.config.internal
Enum PortletConfigParam

java.lang.Object
  java.lang.Enum<PortletConfigParam>
      com.liferay.faces.bridge.config.internal.PortletConfigParam

All Implemented Interfaces:

ConfigParam<javax.portlet.PortletConfig>, Serializable, Comparable<PortletConfigParam>

public enum PortletConfigParam
extends Enum<PortletConfigParam>
implements ConfigParam<javax.portlet.PortletConfig>

This enumeration contains constant names for various implementation-specific contex-param entries that portlet developers can use in the WEB-INF/web.xml descriptor.

Author:

Neil Griffin

Enum Constant Summary

BridgeRequestScopeAjaxEnabled
Flag indicating whether or not the bridge should manage BridgeRequestScope during the RESOURCE_PHASE of the portlet lifecycle.

BridgeRequestScopePreserved
Flag indicating whether or not the bridge request scope is preserved after the RENDER_PHASE completes.

ContainerAbleToSetHttpStatusCode
Flag indicating whether or not the portlet container has the ability to set the HTTP status code for resources.

DistinctRequestScopedManagedBeans
Flag indicating whether or not JSF ManagedBean classes annotated with RequestScoped should be distinct for each portlet.

ManageIncongruities
Flag indicating whether or not the bridge should manage incongruities between the JSF lifecycle and the Portlet lifecycle.

PreferPreDestroy
Flag indicating whether or not methods annotated with the @PreDestroy annotation are preferably invoked over the @BridgePreDestroy annotation.

RenderRedirectEnabled
Flag indicating whether or not the render-redirect standard feature is enabled.

ResourceBufferSize
Size in bytes for the buffer that is used to deliver resources back to the browser.

UploadedFileMaxSize
Maximum file size for an uploaded file.

UploadedFilesDir
Absolute path to a directory (folder) in which the uploaded file data should be written to.

ViewIdRenderParameterName
Name of the render parameter used to encode the viewId.

ViewIdResourceParameterName
Name of the resource request parameter used to encode the viewId Default value is "_facesViewIdResource"

ViewParametersEnabled
Flag indicating whether or not the JSF 2 "View Parameters" feature is enabled.

Method Summary

String	getAlternateName()
boolean	getBooleanValue(javax.portlet.PortletConfig portletConfig)
String	getConfiguredValue(javax.portlet.PortletConfig portletConfig)
boolean	getDefaultBooleanValue()
int	getDefaultIntegerValue()
long	getDefaultLongValue()
String	getDefaultStringValue()
int	getIntegerValue(javax.portlet.PortletConfig portletConfig)
long	getLongValue(javax.portlet.PortletConfig portletConfig)
String	getName()
String	getStringValue(javax.portlet.PortletConfig portletConfig)
boolean	isConfigured(javax.portlet.PortletConfig portletConfig)
static PortletConfigParam	valueOf(String name) Returns the enum constant of this type with the specified name.
static PortletConfigParam[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BridgeRequestScopeAjaxEnabled

public static final PortletConfigParam BridgeRequestScopeAjaxEnabled

Flag indicating whether or not the bridge should manage BridgeRequestScope during the RESOURCE_PHASE of the portlet lifecycle. Default value is false. Set value to true in order to enable JSR 329 default behavior.

BridgeRequestScopePreserved

public static final PortletConfigParam BridgeRequestScopePreserved

Flag indicating whether or not the bridge request scope is preserved after the RENDER_PHASE completes. Default value is false. Set value to true in order to enable JSR 329 default behavior.

ContainerAbleToSetHttpStatusCode

public static final PortletConfigParam ContainerAbleToSetHttpStatusCode

Flag indicating whether or not the portlet container has the ability to set the HTTP status code for resources. Default value is false.

DistinctRequestScopedManagedBeans

public static final PortletConfigParam DistinctRequestScopedManagedBeans

Flag indicating whether or not JSF ManagedBean classes annotated with RequestScoped should be distinct for each portlet. Default value is false.

ManageIncongruities

public static final PortletConfigParam ManageIncongruities

Flag indicating whether or not the bridge should manage incongruities between the JSF lifecycle and the Portlet lifecycle. The default is true.

PreferPreDestroy

public static final PortletConfigParam PreferPreDestroy

Flag indicating whether or not methods annotated with the @PreDestroy annotation are preferably invoked over the @BridgePreDestroy annotation. Default value is true.For more info, see: http://issues.liferay.com/browse/FACES-146

RenderRedirectEnabled

public static final PortletConfigParam RenderRedirectEnabled

Flag indicating whether or not the render-redirect standard feature is enabled. Default value is false for the sake of performance.

ResourceBufferSize

public static final PortletConfigParam ResourceBufferSize

Size in bytes for the buffer that is used to deliver resources back to the browser. Default value is 1024.

UploadedFilesDir

public static final PortletConfigParam UploadedFilesDir

Absolute path to a directory (folder) in which the uploaded file data should be written to. Default value is the value of the system property "java.io.tmpdir".

UploadedFileMaxSize

public static final PortletConfigParam UploadedFileMaxSize

Maximum file size for an uploaded file. Default is 104857600 bytes (100MB)

ViewIdRenderParameterName

public static final PortletConfigParam ViewIdRenderParameterName

Name of the render parameter used to encode the viewId. Default value is "_facesViewIdRender".

ViewIdResourceParameterName

public static final PortletConfigParam ViewIdResourceParameterName

Name of the resource request parameter used to encode the viewId Default value is "_facesViewIdResource"

ViewParametersEnabled

public static final PortletConfigParam ViewParametersEnabled

Flag indicating whether or not the JSF 2 "View Parameters" feature is enabled. Default value is true.

Method Detail

values

public static PortletConfigParam[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PortletConfigParam c : PortletConfigParam.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PortletConfigParam valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getAlternateName

public String getAlternateName()

Specified by:

getAlternateName in interface ConfigParam<javax.portlet.PortletConfig>

getBooleanValue

public boolean getBooleanValue(javax.portlet.PortletConfig portletConfig)

Specified by:

getBooleanValue in interface ConfigParam<javax.portlet.PortletConfig>

getConfiguredValue

public String getConfiguredValue(javax.portlet.PortletConfig portletConfig)

Specified by:

getConfiguredValue in interface ConfigParam<javax.portlet.PortletConfig>

isConfigured

public boolean isConfigured(javax.portlet.PortletConfig portletConfig)

Specified by:

isConfigured in interface ConfigParam<javax.portlet.PortletConfig>

getDefaultBooleanValue

public boolean getDefaultBooleanValue()

Specified by:

getDefaultBooleanValue in interface ConfigParam<javax.portlet.PortletConfig>

getDefaultIntegerValue

public int getDefaultIntegerValue()

Specified by:

getDefaultIntegerValue in interface ConfigParam<javax.portlet.PortletConfig>

getDefaultLongValue

public long getDefaultLongValue()

Specified by:

getDefaultLongValue in interface ConfigParam<javax.portlet.PortletConfig>

getDefaultStringValue

public String getDefaultStringValue()

Specified by:

getDefaultStringValue in interface ConfigParam<javax.portlet.PortletConfig>

getIntegerValue

public int getIntegerValue(javax.portlet.PortletConfig portletConfig)

Specified by:

getIntegerValue in interface ConfigParam<javax.portlet.PortletConfig>

getLongValue

public long getLongValue(javax.portlet.PortletConfig portletConfig)

Specified by:

getLongValue in interface ConfigParam<javax.portlet.PortletConfig>

getName

public String getName()

Specified by:

getName in interface ConfigParam<javax.portlet.PortletConfig>

getStringValue

public String getStringValue(javax.portlet.PortletConfig portletConfig)

Specified by:

getStringValue in interface ConfigParam<javax.portlet.PortletConfig>