|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wicket.Application
public abstract class Application
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:
ResourceReference
for more details.
Session
subclass you
must override ApplicationnewSession(Request, Response)
. For subclasses of
WebApplication
you will want to subclass WebSession
.
WebApplication
Field Summary | |
---|---|
static String |
CONFIGURATION
Configuration constant for the 2 types |
Constructor Summary | |
---|---|
Application()
Constructor. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CONFIGURATION
Constructor Detail |
---|
public Application()
init()
for any configuration of your application instead of
overriding the constructor.
Method Detail |
---|
public static boolean exists()
Application
threadlocal is set in this thread
get()
can return the instance of application, false
otherwisepublic static Application get()
public static Application get(String applicationKey)
applicationKey
- The unique key of the application within a certain context (e.g. a web
application)
null
if application has not been foundpublic static Set<String> getApplicationKeys()
getApplicationKey()
. Never
null, but possibly emptypublic final void configure()
public abstract String getApplicationKey()
public abstract RuntimeConfigurationType getConfigurationType()
RuntimeConfigurationType.DEVELOPMENT
or RuntimeConfigurationType.DEPLOYMENT
.
The configuration type. Must currently be either DEVELOPMENT or DEPLOYMENT. Currently, if the configuration type is DEVELOPMENT, resources are polled for changes, component usage is checked, wicket tags are not stripped from output and a detailed exception page is used. If the type is DEPLOYMENT, component usage is not checked, wicket tags are stripped from output and a non-detailed exception page is used to display errors.
Note that you should not run Wicket in DEVELOPMENT mode on production servers - the various debugging checks and resource polling is inefficient and may leak resources, particularly on webapp redeploy.
To change the deployment mode, add the following to your web.xml, inside your
You can alternatively set this as a <context-param> on the whole context.
Another option is to set the "wicket.configuration" system property to either "deployment" or
"development". The value is not case-sensitive.
The system property is checked first, allowing you to add a web.xml param for deployment, and
a command-line override when you want to run in development mode during development.
You may also override Application.getConfigurationType() to provide your own custom switch,
in which case none of the above logic is used.
<init-param>
<param-name>configuration</param-name>
<param-value>deployment</param-value>
</init-param>
IMPORTANT NOTE
THIS METHOD IS CALLED OFTEN FROM MANY DIFFERENT POINTS IN CODE, INCLUDING DURING THE RENDER PROCESS, THEREFORE THE IMPLEMENTATION SHOULD BE FAST - PREFERRABLY USING A FAST-TO-RETRIEVE CACHED VALUE
public abstract Class<? extends Page> getHomePage()
public final IConverterLocator getConverterLocator()
public final <T> T getMetaData(MetaDataKey<T> key)
T
- key
- The key for the data
MetaDataKey
public final String getName()
public final IRequestLogger getRequestLogger()
IRequestLogger
.
public final ISessionStore getSessionStore()
public void sessionUnbound(String sessionId)
ISessionStore.UnboundListener
sessionUnbound
in interface ISessionStore.UnboundListener
ISessionStore.UnboundListener.sessionUnbound(java.lang.String)
public final void initializeComponents()
public void logEventTarget(IRequestHandler target)
target
- public void logResponseTarget(IRequestHandler requestTarget)
requestTarget
- public abstract Session newSession(Request request, Response response)
request
- The request that will create this session.response
- The response to initialize, for example with cookies. This is important to use
cases involving unit testing because those use cases might want to be able to sign
a user in automatically when the session is created.
public final <T> void setMetaData(MetaDataKey<T> key, Object object)
MetaDataKey
.
T
- key
- The singleton key for the metadataobject
- The metadata object
IllegalArgumentException
MetaDataKey
protected void onDestroy()
protected void init()
public void internalDestroy()
protected void internalInit()
public IProvider<IExceptionMapper> getExceptionMapperProvider()
public final IProvider<ISessionStore> getSessionStoreProvider()
public final void setSessionStoreProvider(IProvider<ISessionStore> sessionStoreProvider)
sessionStoreProvider
- protected IConverterLocator newConverterLocator()
IConverterLocator
.
IConverterLocator
instanceprotected IRequestLogger newRequestLogger()
public final ICompoundRequestMapper getRootRequestMapperAsCompound()
ICompoundRequestMapper
if necessary and returns the
converted instance.
public final IRequestMapper getRootRequestMapper()
public final void setRootRequestMapper(IRequestMapper rootRequestMapper)
rootRequestMapper
- public final void initApplication()
protected void validateInit()
public final void setName(String name)
name
- unique application namepublic String getMimeType(String fileName)
fileName
-
public void onEvent(IEvent<?> event)
onEvent
in interface IEventSink
public final HeaderContributorListenerCollection getHeaderContributorListenerCollection()
HeaderContributorListenerCollection
public final List<IInitializer> getInitializers()
public final ApplicationListenerCollection getApplicationListeners()
public final SessionListenerCollection getSessionListeners()
public final BehaviorInstantiationListenerCollection getBehaviorInstantiationListeners()
public final ComponentInstantiationListenerCollection getComponentInstantiationListeners()
public final ComponentInitializationListenerCollection getComponentInitializationListeners()
public final ComponentOnConfigureListenerCollection getComponentOnConfigureListeners()
public final ComponentOnBeforeRenderListenerCollection getComponentPreOnBeforeRenderListeners()
public final ComponentOnBeforeRenderListenerCollection getComponentPostOnBeforeRenderListeners()
public final ComponentOnAfterRenderListenerCollection getComponentOnAfterRenderListeners()
public RequestCycleListenerCollection getRequestCycleListeners()
IRequestCycleListener
s in this applicationpublic final IApplicationSettings getApplicationSettings()
public final void setApplicationSettings(IApplicationSettings applicationSettings)
applicationSettings
- public final IJavaScriptLibrarySettings getJavaScriptLibrarySettings()
public final void setJavaScriptLibrarySettings(IJavaScriptLibrarySettings javaScriptLibrarySettings)
javaScriptLibrarySettings
- public final IDebugSettings getDebugSettings()
public final void setDebugSettings(IDebugSettings debugSettings)
debugSettings
- public final IExceptionSettings getExceptionSettings()
public final void setExceptionSettings(IExceptionSettings exceptionSettings)
exceptionSettings
- public final IFrameworkSettings getFrameworkSettings()
public final void setFrameworkSettings(IFrameworkSettings frameworkSettings)
frameworkSettings
- public final IPageSettings getPageSettings()
public final void setPageSettings(IPageSettings pageSettings)
pageSettings
- public final IRequestCycleSettings getRequestCycleSettings()
public final void setRequestCycleSettings(IRequestCycleSettings requestCycleSettings)
requestCycleSettings
- public IMarkupSettings getMarkupSettings()
public final void setMarkupSettings(IMarkupSettings markupSettings)
markupSettings
- public final IRequestLoggerSettings getRequestLoggerSettings()
public final void setRequestLoggerSettings(IRequestLoggerSettings requestLoggerSettings)
requestLoggerSettings
- public final IResourceSettings getResourceSettings()
public final void setResourceSettings(IResourceSettings resourceSettings)
resourceSettings
- public final ISecuritySettings getSecuritySettings()
public final void setSecuritySettings(ISecuritySettings securitySettings)
securitySettings
- public final IStoreSettings getStoreSettings()
public final void setStoreSettings(IStoreSettings storeSettings)
storeSettings
- public final IPageManagerProvider getPageManagerProvider()
public final void setPageManagerProvider(IPageManagerProvider provider)
provider
- protected IPageManagerContext getPageManagerContext()
public final IPageRendererProvider getPageRendererProvider()
public final void setPageRendererProvider(IPageRendererProvider pageRendererProvider)
pageRendererProvider
- protected ResourceReferenceRegistry newResourceReferenceRegistry()
ResourceReferenceRegistry
.
ResourceReferenceRegistry
instance.public final ResourceReferenceRegistry getResourceReferenceRegistry()
ResourceReferenceRegistry
for this application.
protected SharedResources newSharedResources(ResourceReferenceRegistry registry)
registry
-
public SharedResources getSharedResources()
protected ResourceBundles newResourceBundles(ResourceReferenceRegistry registry)
public ResourceBundles getResourceBundles()
protected IPageFactory newPageFactory()
IPageFactory
IPageFactory
instance.public final IPageFactory getPageFactory()
IPageFactory
for this application.
public final IMapperContext getMapperContext()
protected IMapperContext newMapperContext()
IMapperContext
implementations. DefaultMapperContext
may
be a good starting point for custom implementations.
public Session fetchCreateAndSetSession(RequestCycle requestCycle)
requestCycle
-
public final IRequestCycleProvider getRequestCycleProvider()
public final void setRequestCycleProvider(IRequestCycleProvider requestCycleProvider)
requestCycleProvider
- @Deprecated public IMarkupIdGenerator getMarkupIdGenerator()
MarkupSettings
@Deprecated public void setMarkupIdGenerator(IMarkupIdGenerator markupIdGenerator)
MarkupSettings
public final RequestCycle createRequestCycle(Request request, Response response)
request
- response
-
public final void setHeaderResponseDecorator(IHeaderResponseDecorator headerResponseDecorator)
IHeaderResponseDecorator
that you want your application to use to decorate
header responses.
headerResponseDecorator
- your custom decoratorpublic final IHeaderResponse decorateHeaderResponse(IHeaderResponse response)
IHeaderResponseDecorator
on the application.
response
- the response Wicket created
IHeaderResponseDecorator
public final boolean usesDevelopmentConfig()
public final boolean usesDeploymentConfig()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |