Package org.joinfaces.autoconfigure.javaxfaces

Class JavaxFaces2_2Properties

java.lang.Object

org.joinfaces.autoconfigure.javaxfaces.JavaxFaces2_2Properties

All Implemented Interfaces:

ServletContextInitParameterProperties

@ConfigurationProperties(prefix="joinfaces.jsf")
public class JavaxFaces2_2Properties
extends Object
implements ServletContextInitParameterProperties

Configuration properties for JSF 2.0. JavaxFaces standard properties. Taken from https://javaserverfaces.java.net/docs/2.2/javadocs/constant-values.html

See Also:

JSR-344

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaxFaces2_2Properties.Flow	Flow class for nullFlow parameter.
static class	JavaxFaces2_2Properties.Partial	Partial class for execute, render and resetValues parameters.

Constructor Summary

Constructors

Constructor	Description
JavaxFaces2_2Properties()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getClientWindowMode()	The context-param that controls the operation of the ClientWindow feature.
JavaxFaces2_2Properties.Flow	getFlow()
JavaxFaces2_2Properties.Partial	getPartial()
Boolean	getSerializeServerState()	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable.
String	getWebappContractsDirectory()	If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resource library contracts are to be located.
String	getWebappResourcesDirectory()	If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resources are to be located.
int	hashCode()
void	setClientWindowMode(String clientWindowMode)	The context-param that controls the operation of the ClientWindow feature.
void	setSerializeServerState(Boolean serializeServerState)	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable.
void	setWebappContractsDirectory(String webappContractsDirectory)	If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resource library contracts are to be located.
void	setWebappResourcesDirectory(String webappResourcesDirectory)	If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resources are to be located.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JavaxFaces2_2Properties

public JavaxFaces2_2Properties()

Method Detail

getWebappContractsDirectory

public String getWebappContractsDirectory()

If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resource library contracts are to be located. This param value must not start with a "/", though it may contain "/" characters. If no such <context-param> exists, or its value is invalid, the value "contracts", without the quotes, must be used by the runtime as the value.

Since:

2.2

getWebappResourcesDirectory

public String getWebappResourcesDirectory()

If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resources are to be located. This param value must not start with a "/", though it may contain "/" characters. If no such <context-param> exists, or its value is invalid, the value "resources", without the quotes, must be used by the runtime as the value.

Since:

2.2

getSerializeServerState

public Boolean getSerializeServerState()

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable. The intent of this parameter is to ensure that the act of writing out the state to an ObjectOutputStream would not throw a NotSerializableException, but the runtime is not required verify this before saving the state.

getPartial

public JavaxFaces2_2Properties.Partial getPartial()

getFlow

public JavaxFaces2_2Properties.Flow getFlow()

getClientWindowMode

public String getClientWindowMode()

The context-param that controls the operation of the ClientWindow feature. The runtime must support the values "none" and "url", without the quotes, but other values are possible. If not specified, or the value is not understood by the implementation, "none" is assumed.

Since:

2.2

setWebappContractsDirectory

public void setWebappContractsDirectory(String webappContractsDirectory)

If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resource library contracts are to be located. This param value must not start with a "/", though it may contain "/" characters. If no such <context-param> exists, or its value is invalid, the value "contracts", without the quotes, must be used by the runtime as the value.

Since:

2.2

setWebappResourcesDirectory

public void setWebappResourcesDirectory(String webappResourcesDirectory)

If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resources are to be located. This param value must not start with a "/", though it may contain "/" characters. If no such <context-param> exists, or its value is invalid, the value "resources", without the quotes, must be used by the runtime as the value.

Since:

2.2

setSerializeServerState

public void setSerializeServerState(Boolean serializeServerState)

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable. The intent of this parameter is to ensure that the act of writing out the state to an ObjectOutputStream would not throw a NotSerializableException, but the runtime is not required verify this before saving the state.

setClientWindowMode

public void setClientWindowMode(String clientWindowMode)

The context-param that controls the operation of the ClientWindow feature. The runtime must support the values "none" and "url", without the quotes, but other values are possible. If not specified, or the value is not understood by the implementation, "none" is assumed.

Since:

2.2

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object