Class Configuration
public class Configuration
extends java.lang.Object
This class holds the configuration for JWt, controlling general features of the interaction between the browser and the web application.
- See Also:
WtServlet.getConfiguration()
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Configuration.ErrorReporting
An enumeration for the level of error reporting in case of client-side (JavaScript) errors.static class
Configuration.SessionTracking
-
Constructor Summary
Constructors Constructor Description Configuration()
Creates a default configuration.Configuration(java.io.File configurationFile)
Reads a configuration from an XML file. -
Method Summary
Modifier and Type Method Description boolean
agentIsBot(java.lang.String userAgent)
Returns whether the user agent is a bot.boolean
agentSupportsAjax(java.lang.String userAgent)
Returns whether the user agent should be considered as one with Ajax support.boolean
debug()
Deprecated.java.util.ArrayList<java.lang.String>
getAjaxAgentList()
Returns the list of user agents that are (not) considered for AJAX sessions.long
getAsyncContextTimeout()
Get async context timeout for WtServlet requestsint
getBootstrapTimeout()
java.util.ArrayList<java.lang.String>
getBotList()
Returns the list of user agents that are treated as bots.int
getDoubleClickTimeout()
Returns the double click timeout.Configuration.ErrorReporting
getErrorReporting()
Returns the error reporting mode.java.lang.String
getFavicon()
Returns the path for the faviconint
getIdleTimeout()
Returns the idle timeout (in seconds).int
getIndicatorTimeout()
Returns the loading indicator timeout.int
getKeepAlive()
long
getMaxRequestSize()
Returns the maximum request size.java.util.List<MetaHeader>
getMetaHeaders()
Returns configured meta headers.int
getMultiSessionCookieTimeout()
java.util.HashMap<java.lang.String,java.lang.String>
getProperties()
Returns configured properties.java.lang.String
getProperty(java.lang.String name)
Returns a property value.java.lang.String
getRedirectMessage()
Returns the plain-HTML redirect message.int
getSessionTimeout()
Returns the session timeout.java.lang.String
getUaCompatible()
Returns UA compatibility selectionint
internalDeploymentSize()
boolean
isAjaxAgentWhiteList()
Returns whether thegetAjaxAgentList()
is a white list or black list.boolean
isAllowedOrigin(java.lang.String origin)
boolean
isBehindReverseProxy()
Returns whether we are deployment behind a reverse proxy.boolean
isCookieChecks()
boolean
isInlineCss()
Returns whether inline CSS may be generated.boolean
isWebglDetect()
boolean
progressiveBootstrap(java.lang.String internalPath)
Returns whether the progressive bootstrap method is used.boolean
sendXHTMLMimeType()
Returns whether XHTML should be used (if supported by the client).void
setAjaxAgentList(java.util.ArrayList<java.lang.String> ajaxAgentList, boolean isWhiteList)
Configures agents that may be served an AJAX version of the application.void
setAllowedOrigins(java.util.Collection<java.lang.String> origins)
Sets the list of origins that are allowed for CORS (only supported for WidgetSet entry points) The default is empty (no origins are allowed).void
setAsyncContextTimeout(long asyncContextTimeout)
Set async context timeout for WtServlet requestsvoid
setBehindReverseProxy(boolean enabled)
Configures whether the application is hosted behind a reverse proxy.void
setBotList(java.util.ArrayList<java.lang.String> botList)
Sets the list of bots.void
setDebug(boolean how)
Deprecated.usesetErrorReporting(ErrorReporting)
instead.void
setDoubleClickTimeout(int doubleClickTimeout)
Sets the double click timeout.void
setErrorReporting(Configuration.ErrorReporting err)
Sets the error reporting mode.void
setFavicon(java.lang.String favicon)
Configures a path to a favicon.void
setIdleTimeout(int timeout)
Sets the idle timeout.void
setIndicatorTimeout(int timeout)
Sets the loading indicator timeout.void
setInlineCss(boolean inlineCss)
Sets whether inline CSS may be generated.void
setInternalDeploymentSize(int size)
void
setMaximumRequestSize(long requestSize)
Sets the maximum request size (in bytes).void
setMetaHeaders(java.util.List<MetaHeader> headers)
Sets (static) meta headers.void
setProgressiveBootstrap(boolean enable)
Sets whether the progressive bootstrap method is used.void
setProperties(java.util.HashMap<java.lang.String,java.lang.String> properties)
Sets properties.void
setRedirectMessage(java.lang.String redirectMessage)
Sets the plain-HTML redirect message.void
setSendXHTMLMimeType(boolean sendXHTMLMimeType)
Sets whether XHTML should be used (if supported by the client).void
setTinyMCEVersion(int version)
Sets the TinyMCE version to be used.void
setUaCompatible(java.lang.String uaCompatible)
Configures different rendering engines for certain browsers.void
setWebSocketsEnabled(boolean enabled)
Enables or disables the use of web socketsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Configuration
public Configuration()Creates a default configuration. -
Configuration
public Configuration(java.io.File configurationFile)Reads a configuration from an XML file.An example configuration file can be found in the JWt source distribution.
- Parameters:
configurationFile
-
-
-
Method Details
-
setProperties
public void setProperties(java.util.HashMap<java.lang.String,java.lang.String> properties)Sets properties.
Examples:- smtp.host: SMTP host used by JWt to send out emails
- smtp.port: SMTP port used by JWt to send out emails
- Parameters:
properties
-- See Also:
getProperties()
,getProperty(String)
-
getProperties
public java.util.HashMap<java.lang.String,java.lang.String> getProperties()Returns configured properties.Properties may be used to adapt applications to their deployment environment.
- Returns:
- a map of all properties.
-
getProperty
public java.lang.String getProperty(java.lang.String name)Returns a property value.Properties may be used to adapt applications to their deployment environment.
- Parameters:
name
-- Returns:
- the property value, or
null
if the property has not been defined.
-
setRedirectMessage
public void setRedirectMessage(java.lang.String redirectMessage)Sets the plain-HTML redirect message.By default, JWt will use an automatic redirect to start the application when the browser does not support JavaScript. However, browsers are not required to follow the redirection, and in some situations (when using XHTML), such automatic redirection is not supported.
This configures the text that is shown in the anchor which the user may click to be redirected to a basic HTML version of your application.
-
getRedirectMessage
public java.lang.String getRedirectMessage()Returns the plain-HTML redirect message.- Returns:
- the plain-HTML redirect message.
- See Also:
setRedirectMessage(String)
-
setSendXHTMLMimeType
public void setSendXHTMLMimeType(boolean sendXHTMLMimeType)Sets whether XHTML should be used (if supported by the client).JWt renders XHTML1 (XML variant of HTML) that is backward-compatible with HTML. Using XHTML, JWt is capable of supporting XHTML-only features such as embedded SVG or MathML.
When enabled, JWt sets an XHTML mime-type (application/xhtml+xml) when the browser reports support for it. Most notably, Internet Explorer does not support it. Because XHTML and HTML are slightly different with respect to default CSS rules, you may want to disable sending the XHTML mime-type all-together, at least if you are not using SVG (used by the
WPaintedWidget
). -
sendXHTMLMimeType
public boolean sendXHTMLMimeType()Returns whether XHTML should be used (if supported by the client).- Returns:
- whether XHTML should be used.
- See Also:
setSendXHTMLMimeType(boolean)
-
setDebug
public void setDebug(boolean how)Deprecated.usesetErrorReporting(ErrorReporting)
instead.Configures debugging.Currently, the only effect of debugging is that JavaScript exceptions are not caught but allowed to propagate so that you can inspect the stack trace.
Debugging is off by default.
-
debug
public boolean debug()Deprecated.usegetErrorReporting()
instead.Returns whether debugging is enabled.- Returns:
- whether debugging is enabled.
- See Also:
setDebug(boolean)
-
setInlineCss
public void setInlineCss(boolean inlineCss)Sets whether inline CSS may be generated.This option configures whether CSS rules added to the inline stylesheet
WApplication.getStyleSheet()
are rendered.Some pedantic accessibility guidelines may forbid inline CSS.
Note: some widgets, such as
WTreeView
, dynamically manipulate rules in this stylesheet, and will no longer work properly when inline CSS is disabled.- Parameters:
inlineCss
-
-
isInlineCss
public boolean isInlineCss()Returns whether inline CSS may be generated.- Returns:
- whether inline CSS may be generated.
- See Also:
setInlineCss(boolean)
-
isWebglDetect
public boolean isWebglDetect() -
setAjaxAgentList
public void setAjaxAgentList(java.util.ArrayList<java.lang.String> ajaxAgentList, boolean isWhiteList)Configures agents that may be served an AJAX version of the application.When isWhiteList is
true
, the given list exhaustively indicates all user agents that will be served an AJAX version of the application. When isWhiteList isfalse
, the given list excludes some user agents that may be served an AJAX version of the application.Each entry in ajaxAgentList is a regular expression against which the browser-reported user agent is compared.
By default, JWt will serve an AJAX version when JavaScript and AJAX support are detected.
- Parameters:
ajaxAgentList
- a list of regular expressions that identify user agentsisWhiteList
- whether the list is a white list or black list.
-
getAjaxAgentList
public java.util.ArrayList<java.lang.String> getAjaxAgentList()Returns the list of user agents that are (not) considered for AJAX sessions.Depending on the value of
isAjaxAgentWhiteList()
, the list is a white-list or a black-list.- Returns:
- the list of user agents that are (not) considered for AJAX sessions.
- See Also:
setAjaxAgentList(ArrayList, boolean)
,agentSupportsAjax(String)
-
isAjaxAgentWhiteList
public boolean isAjaxAgentWhiteList()Returns whether thegetAjaxAgentList()
is a white list or black list.- Returns:
- whether the
getAjaxAgentList()
is a white list or black list. - See Also:
setAjaxAgentList(ArrayList, boolean)
,agentSupportsAjax(String)
-
agentSupportsAjax
public boolean agentSupportsAjax(java.lang.String userAgent)Returns whether the user agent should be considered as one with Ajax support.- Returns:
- whether the user agent should be considered as one with Ajax support.
- See Also:
setAjaxAgentList(ArrayList, boolean)
-
setBotList
public void setBotList(java.util.ArrayList<java.lang.String> botList)Sets the list of bots.JWt considers three types of sessions:
- AJAX sessions: use AJAX and JavaScript
- plain HTML sessions: use plain old server GETs and POSTs
- bots: have clean internal paths (see
WApplication.setInternalPath(String)
) and no persistent sessions
Here, you can specify user agents that should be should be treated as bots.
The default configuration sets the following list:
- .*Googlebot.*
- .*msnbot.*
- .*Slurp.*
- .*Crawler.*
- .*Bot.*
- .*ia_archiver.*
- .*Twiceler.*
-
getBotList
public java.util.ArrayList<java.lang.String> getBotList()Returns the list of user agents that are treated as bots.- Returns:
- the list of user agents that are treated as bots.
- See Also:
setBotList(ArrayList)
-
agentIsBot
public boolean agentIsBot(java.lang.String userAgent)Returns whether the user agent is a bot.- See Also:
setBotList(ArrayList)
-
setFavicon
public void setFavicon(java.lang.String favicon)Configures a path to a favicon. By default, a browser will fetch a favicon from "/favicon.ico".
Using this setting, you may provide a custom path to the favicon.The default value is "".
-
getFavicon
public java.lang.String getFavicon()Returns the path for the favicon- Returns:
- the path for the favicon
- See Also:
setFavicon(String)
-
setProgressiveBootstrap
public void setProgressiveBootstrap(boolean enable)Sets whether the progressive bootstrap method is used.Since JWt 2.99.4, a new bootstrap method has been added (initially proposed by Anthony roger Buck). While the default bootstrap already honors the principle of graceful degradation, this bootstrap implements this using the principle of progressive enhancement (and quite literally so).
This bootstrap method will initially assume that the user agent is a plain HTML user-agent and immediately create the application (with
WEnvironment.hasAjax()
always returningfalse
). The initial response will contain the initial page suitable for a plain HTML user-agent.JavaScript embedded in this page will sense for AJAX support and trigger a second request which progresses the application to an AJAX application (without repainting the user interface). To that extent, it will change
WEnvironment.hasAjax()
to returntrue
, and invokeWApplication.enableAjax()
which in turn propagatesWWidget.enableAjax()
through the widget hierarchy. This upgrade happens in the back-ground, unnoticed to the user.This mitigates disadvantages associated with the default bootstrap, which implements a browser detection first after it starts the application:
- the redirection without JavaScript support may not be supported
by all user agents, leaving these with a link and a
getRedirectMessage()
. - there is an additional round-trip before any contents is rendered
- for an AJAX user interface, all contents will be loaded through JavaScript. This has a draw-back that IE may delay applying external stylesheets after the contents has been rendered, which might cause some confusion, and some 3rd party JavaScript libraries do not support being loaded on-demand (with as most notable example, Google ads).
- the redirection without JavaScript support may not be supported
by all user agents, leaving these with a link and a
-
progressiveBootstrap
public boolean progressiveBootstrap(java.lang.String internalPath)Returns whether the progressive bootstrap method is used. The method may take into account the internalPath to differentiate between certain deep links which display widgets that do not progress well (such as table views or tree views).- Parameters:
internalPath
- the initial internal path- Returns:
- whether the progressive bootstrap method is used.
-
getKeepAlive
public int getKeepAlive() -
getMultiSessionCookieTimeout
public int getMultiSessionCookieTimeout() -
getSessionTimeout
public int getSessionTimeout()Returns the session timeout.- Returns:
- the session timeout.
-
getIdleTimeout
public int getIdleTimeout()Returns the idle timeout (in seconds).- Returns:
- the idle timeout.
-
setIdleTimeout
public void setIdleTimeout(int timeout)Sets the idle timeout. When the user does not interact with the application for the set number of seconds, WApplication#idleTimeout() is called. By default, this method quits the application immediately, but it can be overridden if different behaviour is desired. This feature can be used to prevent others from taking over a session when the device that the Wt application is being used from is left behind, and is most effective in combination with a fairly short session timeout. The default is -1 (disabled) -
setMaximumRequestSize
public void setMaximumRequestSize(long requestSize)Sets the maximum request size (in bytes). The default value is 1MB -
getDoubleClickTimeout
public int getDoubleClickTimeout()Returns the double click timeout. -
setDoubleClickTimeout
public void setDoubleClickTimeout(int doubleClickTimeout)Sets the double click timeout. The default value is 200 (ms). -
getIndicatorTimeout
public int getIndicatorTimeout()Returns the loading indicator timeout. When a response time for an AJAX call exceeds this time, a loading indicator is shown.- Returns:
- the loading indicator timeout in milliseconds.
-
setIndicatorTimeout
public void setIndicatorTimeout(int timeout)Sets the loading indicator timeout. When a response time for an AJAX call exceeds this time, a loading indicator is shown.- Parameters:
timeout
- the timeout in milliseconds.
-
getBootstrapTimeout
public int getBootstrapTimeout() -
getErrorReporting
Returns the error reporting mode. -
setErrorReporting
Sets the error reporting mode. -
setUaCompatible
public void setUaCompatible(java.lang.String uaCompatible)Configures different rendering engines for certain browsers. Currently this is only used to select IE7 compatible rendering engine for IE8, which solves problems of unreliable and slow rendering performance for VML which Microsoft broke in IE8. Before 3.3.0, the default value was IE8=IE7, but since 3.3.0 this has been changed to an empty string (i.e. let IE8 use the standard IE8 rendering engine) to take advantage of IE8's improved CSS support. -
getUaCompatible
public java.lang.String getUaCompatible()Returns UA compatibility selection- See Also:
setUaCompatible(String)
-
setTinyMCEVersion
public void setTinyMCEVersion(int version)Sets the TinyMCE version to be used. The default version is 3.- Parameters:
version
- must be 3 or 4- See Also:
WTextEdit
-
setWebSocketsEnabled
public void setWebSocketsEnabled(boolean enabled)Enables or disables the use of web sockets -
getMaxRequestSize
public long getMaxRequestSize()Returns the maximum request size. -
setBehindReverseProxy
public void setBehindReverseProxy(boolean enabled)Configures whether the application is hosted behind a reverse proxy.- See Also:
isBehindReverseProxy()
-
isBehindReverseProxy
public boolean isBehindReverseProxy()Returns whether we are deployment behind a reverse proxy. When configured behind a reverse proxy, typical headers set by the reverse proxy are interpreted correctly: - X-Forwarded-Host - X-Forwarded-Proto -
isCookieChecks
public boolean isCookieChecks() -
internalDeploymentSize
public int internalDeploymentSize() -
setInternalDeploymentSize
public void setInternalDeploymentSize(int size) -
getMetaHeaders
Returns configured meta headers. -
setMetaHeaders
Sets (static) meta headers. This is an alternative to usingWApplication.addMetaHeader(String, CharSequence)
, but having the benefit that they are added to all sessions. -
isAllowedOrigin
public boolean isAllowedOrigin(java.lang.String origin) -
setAllowedOrigins
public void setAllowedOrigins(java.util.Collection<java.lang.String> origins)Sets the list of origins that are allowed for CORS (only supported for WidgetSet entry points) The default is empty (no origins are allowed). -
getAsyncContextTimeout
public long getAsyncContextTimeout()Get async context timeout for WtServlet requests -
setAsyncContextTimeout
public void setAsyncContextTimeout(long asyncContextTimeout)Set async context timeout for WtServlet requests
-
getErrorReporting()
instead.