Java Doc for Configuration.java in  » Ajax » zk » org » zkoss » zk » ui » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

To retrieve the current configuration, use org.zkoss.zk.ui.WebApp.getConfiguration .

Note: A Configuration instance can be assigned to at most one WebApp instance.
author:
   tomyeh

If there was a richlet associated with the same name, the the old richlet will be replaced.
Parameters:
  name - the richlet name
Parameters:
  params - the initial parameters, or null if no initial parameter at all.Once called, the caller cannot access params any more.

If there was a richlet associated with the same name, the the old servlet will be replaced.
Parameters:
  name - the richlet name
Parameters:
  richletClassName - the class name.

Preference is application specific.

Default: null.

Note: if specified, the final theme URIs is decided by the provider.

Used only internally.

An instance of DesktopInit is constructed first, and then invoke DesktopInit.init .
Parameters:
  desktop - the desktop that is created
Parameters:
  request - the original request.

Used only internally.

An instance of SessionInit is constructed first, and then invoke SessionInit.init .
Parameters:
  sess - the session that is created
Parameters:
  request - the original request.

Used only internally.

An instance of EventThreadCleanup is constructed first, and then invoke EventThreadCleanup.cleanup .

It never throws an exception but logs and adds it to the errs argument, if not null.
Parameters:
  comp - the component which the event is targeting
Parameters:
  evt - the event to process
Parameters:
  errs - a list of exceptions (java.lang.Throwable) if any exceptionoccured before this method is called, or null if no exeption at all.Note: you can manipulate the list directly to add or clean up exceptions.For example, if exceptions are fixed correctly, you can call errs.clear()such that no error message will be displayed at the client.

Default: null.

There is at most one monitor for each Web application. The previous monitor will be replaced when this method is called.

In addition to call this method, you could specify a monitor in zk.xml
Parameters:
  monitor - the performance meter.

Default: null.

There is at most one performance meter for each Web application. The previous meter will be replaced when this method is called.

In addition to call this method, you could specify a performance meter in zk.xml
Parameters:
  meter - the performance meter.

Default: -1 (i.e., disabled). However, if zkmax.jar was installed (or with ZK 3.0.1 and 3.0.2), the default is 9000.

There are many reasons an Ajax request is not received by the server.

Note: if ThemeProvider is specified ( Configuration.setThemeProvider ), the final theme URIs generated depend on ThemeProvider.getThemeURIs .
Parameters:
  uri - the theme URI to disable
since:
   3.0.0

If there was a richlet associated with the same name, the the old richlet will be replaced.
Parameters:
  name - the richlet name
Parameters:
  params - the initial parameters, or null if no initial parameter at all.Once called, the caller cannot access params any more. the previous richlet class or class-name with the specified name,or null if no previous richlet.

If there was a richlet associated with the same name, the the old servlet will be replaced.
Parameters:
  name - the richlet name
Parameters:
  richletClassName - the class name. The class will be loadedonly when the richlet is loaded.
Parameters:
  params - the initial parameters, or null if no initial parameter at all.Once called, the caller cannot access params any more. the previous richlet class or class-name with the specified name,or null if no previous richlet.

Note: if ThemeProvider is specified ( Configuration.setThemeProvider ), the final theme URIs generated depend on ThemeProvider.getThemeURIs .

Used only internally.
since:
   3.0.0

Used only internally.
since:
   3.0.0

Used only internally.
since:
   3.0.0

Used only internally.
since:
   3.0.0

Default: true.
since:
   2.4.1

Default: enabled.
exception:
  IllegalStateException - if there is suspended threadand use is false.

Default: 302, 401 and 403 are associated with an empty URI.
since:
   3.0.0

A negative value indicates the desktop should never timeout.

It is ignored if the use of the event processing thread is disable ( Configuration.isEventThreadEnabled .
See Also:   Configuration.isEventThreadEnabled

Preference is application specific. You can specify whatever you want as you specifying context-param for a Web application.
Parameters:
  defaultValue - the default value that is used if the specifiedpreference is not found.

Default: UTF-8.

A negative value indicates there is no limit.
since:
   3.0.1

Default: 0 (means the system default).

A negative value indicates that there is no limit. Zero means to use the system default (usually defined in web.xml).
See Also:   Configuration.isTimerKeepAlive
See Also:   Session.getMaxInactiveInterval

A negative value indicates there is no limit, but it is not recommended due to the possibility of the DoS attacks.
since:
   3.0.1

Default: null.

Note: if specified, the final theme URIs is decided by the provider. The URIs specified in Configuration.getThemeURIs are passed to provider, and it has no effect if the provider decides to ignore them.
since:
   3.0.0
See Also:   Configuration.getThemeURIs
See Also:   Configuration.getDisabledThemeURIs

Default: an array with zero length.

Default: UTF-8.
See Also:   Configuration.getUploadCharsetFinder

Default: null
since:
   3.0.0
See Also:   Configuration.getUploadCharset

Used only internally.

An instance of DesktopCleanup is constructed first, and then invoke DesktopCleanup.cleanup .

It never throws an exception.
Parameters:
  desktop - the desktop that is being destroyed

Used only internally.

An instance of DesktopInit is constructed first, and then invoke DesktopInit.init .
Parameters:
  desktop - the desktop that is created
Parameters:
  request - the original request. If HTTP, it isjavax.servlet.http.HttlServletRequest.
exception:
  UiException - to prevent a desktop from being created
since:
   3.0.1

Used only internally.

It never throws an exception but logs and adds it to the errs argument, if not null.
Parameters:
  cleanups - a list of EventThreadCleanup instances returned fromConfiguration.newEventThreadCleanups, or null if no instance at all.
Parameters:
  errs - used to hold the exceptions that are thrown byEventThreadCleanup.complete.If null, all exceptions are ignored (but logged).

Used only internally.
Parameters:
  inits - a list of EventThreadInit instances returned fromConfiguration.newEventThreadInits, or null if no instance at all.
Parameters:
  comp - the component which the event is targeting
Parameters:
  evt - the event to process
exception:
  UiException - to prevent a thread from being processedif EventThreadInit.prepare throws an exception false if you want to ignore the event, i.e., not to proceedany event processing for the specified event (evt).

Used only internally.

An instance of EventThreadResume is constructed first, and then invoke EventThreadResume.abortResume .

It never throws an exception but logging.
Parameters:
  comp - the component which the event is targeting
Parameters:
  evt - the event to process

Used only internally.

It never throws an exception but logs and adds it to the errs argument, if not null.
Parameters:
  resumes - a list of EventThreadResume instances returned fromConfiguration.newEventThreadResumes, or null if no instance at all.
Parameters:
  comp - the component which the event is targeting
Parameters:
  evt - the event to processIf null, all exceptions are ignored (but logged)

Used only internally.

Unlike Configuration.invokeEventThreadSuspends , exceptions are logged and ignored.
Parameters:
  suspends - a list of EventThreadSuspend instances returnedfrom Configuration.newEventThreadSuspends, or null if no instance at all.
Parameters:
  comp - the component which the event is targeting
Parameters:
  evt - the event to process

Used only internally.

An instance of ExecutionCleanup is constructed first, and then invoke ExecutionCleanup.cleanup .

It never throws an exception but logs and adds it to the errs argument, if not null.
Parameters:
  exec - the execution that is being destroyed
Parameters:
  parent - the previous execution, or null if no previous at all
Parameters:
  errs - a list of exceptions (java.lang.Throwable) if any exceptionoccured before this method is called, or null if no exeption at all.Note: you can manipulate the list directly to add or clean up exceptions.For example, if exceptions are fixed correctly, you can call errs.clear()such that no error message will be displayed at the client.

Used only internally.

An instance of ExecutionInit is constructed first, and then invoke ExecutionInit.init .
Parameters:
  exec - the execution that is created
Parameters:
  parent - the previous execution, or null if no previous at all
exception:
  UiException - to prevent an execution from being created

Used only internally.

If any of them throws an exception, the exception is propogated to the caller.
exception:
  UiException - if it is rejected by the interceptor.Use UiException.getCause to retrieve the cause.

Used only internally.

An instance of SessionCleanup is constructed first, and then invoke SessionCleanup.cleanup .

It never throws an exception.
Parameters:
  sess - the session that is being destroyed

Used only internally.

An instance of SessionInit is constructed first, and then invoke SessionInit.init .
Parameters:
  sess - the session that is created
Parameters:
  request - the original request. If HTTP, it isjavax.servlet.http.HttlServletRequest.
exception:
  UiException - to prevent a session from being created
since:
   3.0.1

Used only internally.

If any of them throws an exception, the exception is propogated to the caller.
exception:
  UiException - if it is rejected by the interceptor.Use UiException.getCause to retrieve the cause.

Used only internally.

An instance of WebAppCleanup is constructed first, and then invoke WebAppCleanup.cleanup .

It never throws an exception.

Used only internally.

An instance of WebAppInit is constructed first, and then invoke WebAppInit.init .

Unlike Configuration.invokeWebAppInits , it doesn't throw any exceptions. Rather, it only logs them.

Default: true.
since:
   2.4.1

Used only internally.

An instance of EventThreadCleanup is constructed first, and then invoke EventThreadCleanup.cleanup .

It never throws an exception but logs and adds it to the errs argument, if not null.
Parameters:
  comp - the component which the event is targeting
Parameters:
  evt - the event to process
Parameters:
  errs - a list of exceptions (java.lang.Throwable) if any exceptionoccured before this method is called, or null if no exeption at all.Note: you can manipulate the list directly to add or clean up exceptions.For example, if exceptions are fixed correctly, you can call errs.clear()such that no error message will be displayed at the client. a list of EventThreadCleanup, or null

Used only internally (by UiEngine before starting an event processing thread).
exception:
  UiException - to prevent a thread from being processedif EventThreadInit.prepare throws an exception a list of EventThreadInit instances that areconstructed in this method (and their EventThreadInit.prepareare called successfully), or null.

Used only internally (by UiEngine when resuming a suspended event thread). Notice: it executes in the main thread (i.e., the servlet thread).
Parameters:
  comp - the component which the event is targeting
Parameters:
  evt - the event to process
exception:
  UiException - to prevent a thread from being resumedif EventThreadResume.beforeResume throws an exception a list of EventThreadResume instances that are constructedin this method (and their EventThreadResume.beforeResumeare called successfully), or null.

Used only internally.

Note: caller shall execute in the event processing thread.
Parameters:
  comp - the component which the event is targeting
Parameters:
  evt - the event to process
Parameters:
  obj - which object that Executions.waitis called with.
exception:
  UiException - to prevent a thread from suspending a list of EventThreadSuspend, or null

Note: you have to set the class before WebApp is created. Otherwise, it won't have any effect.

Default: 3600 (1 hour).

A negative value indicates the desktop should never timeout.

Default: null -- it means the org.zkoss.xel.el.ELFactory class (it requires zcommons-el.jar).

Note: you can only specify an implementation that is compatible with JSP EL here, since ZK's builtin pages depend on it. However, you can use any factory you like in an individual page, as long as all expressions in the page follow the syntax of the evaluator you are using.
Parameters:
  expfcls - the implemtation class, or null to use the default.Note: expfcls must implement ExpressionFactory.
since:
   3.0.0

Note: you have to set the class before WebApp is created. Otherwise, it won't have any effect.

Note: you have to set the class before WebApp is created. Otherwise, it won't have any effect.
since:
   2.4.1

Default: false.

Default: 3000.

Note: since 3.0.0, this setting has no effect on Ajax devices. Ajax devices send the requests synchronously.
Parameters:
  time - the maximal allowed time to process events.It must be positive.

Default: 100.

A negative value indicates there is no limit.

ZK uses a thread pool to keep the idle event processing threads. It speeds up the service of an event by reusing the thread queued in this pool.
See Also:   Configuration.setMaxSuspendedThreads
See Also:   Configuration.isEventThreadEnabled

Default: -1 (no limit).

A negative value indicates there is no limit.

It is ignored if the use of the event processing thread is disable ( Configuration.isEventThreadEnabled .

Default: 5120.
Parameters:
  sz - the maximal allowed upload size.A negative value indicates therre is no limit.

Default: null.

There is at most one monitor for each Web application. The previous monitor will be replaced when this method is called.

In addition to call this method, you could specify a monitor in zk.xml
Parameters:
  monitor - the performance meter. If null, the meter functionis disabled. the previous monitor, or null if not available.

Default: null.

There is at most one performance meter for each Web application. The previous meter will be replaced when this method is called.

In addition to call this method, you could specify a performance meter in zk.xml
Parameters:
  meter - the performance meter. If null, the meter functionis disabled. the previous performance meter, or null if not available.
since:
   3.0.0

Default: 900

Default: -1 (i.e., disabled). However, if zkmax.jar was installed (or with ZK 3.0.1 and 3.0.2), the default is 9000.

There are many reasons an Ajax request is not received by the server. With the resending mechanism, ZK ensures the reliable connection between the client and the server.

See also Bug 1839246
since:
   3.0.1
Parameters:
  minisecs - the timeout in milliseconds.Since 3.0.3, you can specify a nonpositive number to disable the resend.

Defafult: 15.

A negative value indicates there is no limit.
since:
   3.0.1

Default: 0 (means the system default).
See Also:   Configuration.setTimerKeepAlive
See Also:   Session.setMaxInactiveInterval

Defafult: 5.

A negative value indicates there is no limit, but it is not recommended due to the possibility of the DoS attacks.
since:
   3.0.1

Default: false.

A session is expired (and then invalidated), if it didn't receive any client request in the specified timeout interval ( Configuration.getSessionMaxInactiveInterval ). By setting this option to true, the session timeout will be reset when onTimer is received (just like any other event).

Note: if true and the timer is shorter than the session timeout ( Configuration.getSessionMaxInactiveInterval ), the session is never expired.
Parameters:
  alive - whether to keep the session alive when receivingonTimer
since:
   3.0.0

Default: 800

Note: you have to set the class before WebApp is created. Otherwise, it won't have any effect.

Note: Configuration.setUploadCharsetFinder has the higher priority.
Parameters:
  charset - the charset to use.If null or empty, UTF-8 is assumed.
See Also:   Configuration.setUploadCharsetFinder

It has the higher priority than Configuration.setUploadCharset . In other words, Configuration.getUploadCharset is used only if this method returns null or CharsetFinder.getCharset returns null.
since:
   3.0.0
See Also:   Configuration.setUploadCharset

Note: you have to set the class before WebApp is created. Otherwise, it won't have any effect.