wicket
Class Application

java.lang.Object
  wicket.Application

Direct Known Subclasses:

WebApplication

public abstract class Application

extends java.lang.Object

Base class for all Wicket applications. To create a Wicket application, you generally should not directly subclass this class. Instead, you will want to subclass some subclass of Application, like WebApplication, which is appropriate for the protocol and markup type you are working with. Application has the following interesting features / attributes:

• Name - The application's name, which is the same as its class name.
• Application Settings - A variety of settings that control the behavior of the Wicket framework for a given application. It is not necessary to learn all the settings. Good defaults can be set for deployment and development by calling ApplicationSettings.configure("deployment") or ApplicationSettings.configure("development").
• Application Pages - A particular set of required pages. The required pages returned by getPages() include a home page and pages for handling common error conditions. The only page you must supply to create a Wicket application is the application home page.
• Shared Resources - Resources added to an application with any of the Application.addResource() methods have application-wide scope and can be referenced using a logical scope and a name with the ResourceReference class. resourceReferences can then be used by multiple components in the same application without additional overhead (beyond the ResourceReference instance held by each referee) and will yield a stable URL, permitting efficient browser caching of the resource (even if the resource is dynamically generated). Resources shared in this manner may also be localized. See ResourceReference for more details.
• A Converter Factory - By overriding getConverterFactory(), you can provide your own factory which creates locale sensitive Converter instances.
• A ResourceStreamLocator - An Application's ResourceStreamLocator is used to find resources such as images or markup files. You can supply your own ResourceStreamLocator if your prefer to store your application's resources in a non-standard location (such as a different filesystem location, a particular JAR file or even a database) by overriding the getResourceLocator() method.
• Resource Factories - Resource factories can be used to create resources dynamically from specially formatted HTML tag attribute values. For more details, see IResourceFactory, DefaultButtonImageResourceFactory and especially LocalizedImageResource.
• A Localizer - The getLocalizer() method returns an object encapsulating all of the functionality required to access localized resources. For many localization problems, even this will not be required, as there are convenience methods available to all components: Component.getString(String key) and Component.getString(String key, IModel model).
• A Session Factory - The Application subclass WebApplication supplies an implementation of getSessionFactory() which returns an implementation of ISessionFactory that creates WebSession Session objects appropriate for web applications. You can (and probably will want to) override getSessionFactory() to provide your own session factory that creates Session instances of your own application-specific subclass of WebSession.

Author:

Jonathan Locke

See Also:

WebApplication

Constructor Summary

Application()
Constructor

Method Summary

void	addResourceFactory(java.lang.String name, IResourceFactory resourceFactory) Adds a resource factory to the list of factories to consult when generating resources automatically
ApplicationSettings	createApplicationSettings() Subclasses could override this to give there own implementation of ApplicationSettings.
static Application	get() Get application for current session.
java.util.List	getComponentResolvers() Get the (modifiable) list of IComponentResolvers.
IConverterFactory	getConverterFactory() Gets the converter factory.
Localizer	getLocalizer()
MarkupCache	getMarkupCache() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
java.lang.String	getName() Gets the name of this application.
ApplicationPages	getPages()
java.util.Iterator	getPageSets(Page page) THIS FEATURE IS CURRENTLY EXPERIMENTAL.
IResourceFactory	getResourceFactory(java.lang.String name)
ResourceStreamLocator	getResourceStreamLocator()
ModificationWatcher	getResourceWatcher()
protected abstract ISessionFactory	getSessionFactory()
ApplicationSettings	getSettings()
SharedResources	getSharedResources()
protected void	init() Allows for initialization of the application by a subclass.
protected void	internalInit() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
ICrypt	newCrypt() Factory method that creates an instance of de-/encryption class.
MarkupParser	newMarkupParser(MarkupContainer container) Factory method that creates a markup parser.
protected Page	onRuntimeException(Page page, java.lang.RuntimeException e) Template method that is called when a runtime exception is thrown, just before the actual handling of the runtime exception.
(package private) void	resourceFinderChanged() Called by ApplicationSettings when source path property is changed.
static void	set(Application application) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
void	setLocalizer(Localizer localizer) Users may provide there own implementation of a localizer, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Application

public Application()

Constructor

Method Detail

get

public static Application get()

Get application for current session.

Returns:

The current application

set

public static void set(Application application)

THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT.

Parameters:

application - The current application or null for this thread

addResourceFactory

public final void addResourceFactory(java.lang.String name,
                                     IResourceFactory resourceFactory)

Adds a resource factory to the list of factories to consult when generating resources automatically

Parameters:

name - The name to give to the factory

resourceFactory - The resource factory to add

getComponentResolvers

public final java.util.List getComponentResolvers()

Get the (modifiable) list of IComponentResolvers.

Returns:

List of ComponentResolvers

See Also:

for an example

getConverterFactory

public IConverterFactory getConverterFactory()

Gets the converter factory.

Returns:

the converter factory

getLocalizer

public final Localizer getLocalizer()

Returns:

The application wide localizer instance

setLocalizer

public final void setLocalizer(Localizer localizer)

Users may provide there own implementation of a localizer, e.g. one which uses Spring's MessageSource.

Parameters:

localizer -

getMarkupCache

public final MarkupCache getMarkupCache()

THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT.

Returns:

Returns the markup cache associated with the application

getName

public final java.lang.String getName()

Gets the name of this application.

Returns:

The application name.

getPages

public final ApplicationPages getPages()

Returns:

Application's common pages

getPageSets

public final java.util.Iterator getPageSets(Page page)

THIS FEATURE IS CURRENTLY EXPERIMENTAL. DO NOT USE THIS METHOD.

Parameters:

page - The Page for which a list of PageSets should be retrieved

Returns:

Sequence of PageSets for a given Page

getResourceFactory

public final IResourceFactory getResourceFactory(java.lang.String name)

Parameters:

name - Name of the factory to get

Returns:

The IResourceFactory with the given name.

getResourceStreamLocator

public ResourceStreamLocator getResourceStreamLocator()

Returns:

Resource locator for this application

getResourceWatcher

public final ModificationWatcher getResourceWatcher()

Returns:

Resource watcher with polling frequency determined by setting, or null if no polling frequency has been set.

getSettings

public ApplicationSettings getSettings()

Returns:

Application settings

createApplicationSettings

public ApplicationSettings createApplicationSettings()

Subclasses could override this to give there own implementation of ApplicationSettings. DO NOT CALL THIS METHOD YOURSELF. Use getSettings instead.

Returns:

An instanceof an ApplicationSettings class.

getSharedResources

public final SharedResources getSharedResources()

Returns:

Returns the sharedResources.

newCrypt

public ICrypt newCrypt()

Factory method that creates an instance of de-/encryption class. NOTE: this implementation caches the crypt instance, so it has to be Threadsafe. If you want other behaviour, or want to provide a custom crypt class, you should override this method.

Returns:

Instance of de-/encryption class

newMarkupParser

public MarkupParser newMarkupParser(MarkupContainer container)

Factory method that creates a markup parser.

Parameters:

container - The wicket container requesting the markup

Returns:

A new MarkupParser

getSessionFactory

protected abstract ISessionFactory getSessionFactory()

Returns:

Factory for creating sessions

init

protected void init()

Allows for initialization of the application by a subclass.

onRuntimeException

protected Page onRuntimeException(Page page,
                                  java.lang.RuntimeException e)

Template method that is called when a runtime exception is thrown, just before the actual handling of the runtime exception.

Parameters:

page - Any page context where the exception was thrown

e - The exception

Returns:

Any error page to redirect to

internalInit

protected void internalInit()

THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT OVERRIDE OR CALL. Internal intialization.

resourceFinderChanged

final void resourceFinderChanged()

Called by ApplicationSettings when source path property is changed. This method sets the resourceStreamLocator to null so it will get recreated the next time it is accessed using the new source path.