|
||||||||||
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 java.lang.String |
CONFIGURATION
Configuration constant for the 2 types |
static java.lang.String |
CONTEXTPATH
Configuration type constant for getting the context path out of the web.xml |
static java.lang.String |
DEPLOYMENT
Configuration type constant for deployment |
static java.lang.String |
DEVELOPMENT
Configuration type constant for development |
Constructor Summary | |
---|---|
Application()
Constructor. |
Method Summary | |
---|---|
void |
addComponentInstantiationListener(IComponentInstantiationListener listener)
Adds a component instantiation listener. |
void |
addComponentOnAfterRenderListener(IComponentOnAfterRenderListener listener)
Adds an IComponentOnAfterRenderListener . |
void |
addComponentOnBeforeRenderListener(IComponentOnBeforeRenderListener listener)
Adds an IComponentOnBeforeRenderListener . |
void |
addRenderHeadListener(IHeaderContributor listener)
Adds a listener that will be invoked for every header response |
void |
configure()
Configures application settings to good defaults. |
protected void |
destroy()
Deprecated. use onDestroy() instead |
static boolean |
exists()
Checks if the Application threadlocal is set in this thread |
static Application |
get()
Get Application for current thread. |
static Application |
get(java.lang.String applicationKey)
Gets the Application based on the application key of that application. |
abstract java.lang.String |
getApplicationKey()
Gets the unique key of this application within a given context (like a web application). |
static java.util.Set |
getApplicationKeys()
Gets the keys of the currently registered Wicket applications for this web application. |
IApplicationSettings |
getApplicationSettings()
|
abstract java.lang.String |
getConfigurationType()
Gets the configuration mode to use for configuring the app, either DEVELOPMENT or
DEPLOYMENT . |
IConverterLocator |
getConverterLocator()
|
IDebugSettings |
getDebugSettings()
|
IExceptionSettings |
getExceptionSettings()
|
IFrameworkSettings |
getFrameworkSettings()
|
abstract java.lang.Class |
getHomePage()
Application subclasses must specify a home page class by implementing this abstract method. |
IMarkupCache |
getMarkupCache()
Deprecated. please use IMarkupSettings.getMarkupCache() instead |
IMarkupSettings |
getMarkupSettings()
|
java.io.Serializable |
getMetaData(MetaDataKey key)
Gets metadata for this application using the given key. |
java.lang.String |
getName()
Gets the name of this application. |
IPageSettings |
getPageSettings()
|
protected java.lang.Object |
getRequestCycleFactory()
Deprecated. replaced by newRequestCycle(Request, Response) |
IRequestCycleSettings |
getRequestCycleSettings()
|
IRequestLogger |
getRequestLogger()
Gets the RequestLogger . |
IRequestLoggerSettings |
getRequestLoggerSettings()
|
IResourceSettings |
getResourceSettings()
|
ISecuritySettings |
getSecuritySettings()
|
protected java.lang.Object |
getSessionFactory()
Deprecated. replaced by newSession(Request, Response) |
ISessionSettings |
getSessionSettings()
|
ISessionStore |
getSessionStore()
Gets the facade object for working getting/ storing session instances. |
SharedResources |
getSharedResources()
Gets the shared resources. |
protected void |
init()
Allows for initialization of the application by a subclass. |
void |
initializeComponents()
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. |
protected void |
internalDestroy()
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. |
protected void |
internalInit()
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. |
void |
logEventTarget(IRequestTarget target)
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. |
void |
logResponseTarget(IRequestTarget requestTarget)
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. |
protected IConverterLocator |
newConverterLocator()
Creates and returns a new instance of IConverterLocator . |
RequestCycle |
newRequestCycle(Application application,
Request request,
Response response)
Deprecated. Applications wishing to provide custom request cycles should override method newRequestCycle(Request, Response) |
abstract RequestCycle |
newRequestCycle(Request request,
Response response)
Creates a new RequestCycle object. |
protected IRequestLogger |
newRequestLogger()
creates a new request logger when requests logging is enabled. |
abstract Session |
newSession(Request request,
Response response)
Creates a new session. |
protected abstract ISessionStore |
newSessionStore()
Creates a new session facade. |
void |
notifyRenderHeadListener(IHeaderResponse response)
INTERNAL |
protected void |
onDestroy()
Called when wicket servlet is destroyed. |
void |
removeComponentInstantiationListener(IComponentInstantiationListener listener)
Removes a component instantiation listener. |
void |
removeComponentOnAfterRenderListener(IComponentOnAfterRenderListener listener)
Removes an IComponentOnAfterRenderListener . |
void |
removeComponentOnBeforeRenderListener(IComponentOnBeforeRenderListener listener)
Removes an IComponentOnBeforeRenderListener . |
void |
removeRenderHeadListener(IHeaderContributor listener)
|
static void |
set(Application application)
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. |
void |
setMetaData(MetaDataKey key,
java.io.Serializable object)
Sets the metadata for this application using the given key. |
static void |
unset()
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CONFIGURATION
public static final java.lang.String CONTEXTPATH
public static final java.lang.String DEPLOYMENT
public static final java.lang.String DEVELOPMENT
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(java.lang.String applicationKey)
applicationKey
- The unique key of the application within a certain context (e.g. a web
application)
java.lang.IllegalArgumentException
- When no application was found with the provided keypublic static java.util.Set getApplicationKeys()
getApplicationKey()
. Never
null, but possibly emptypublic static void set(Application application)
application
- The current application or null for this threadpublic static void unset()
public final void addComponentInstantiationListener(IComponentInstantiationListener listener)
Note: wicket does not guarantee the execution order of added listeners
listener
- the listener to addpublic final void configure()
public abstract java.lang.String getApplicationKey()
public IApplicationSettings getApplicationSettings()
IApplicationSettings
public abstract java.lang.String getConfigurationType()
DEVELOPMENT
or
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.
public final IConverterLocator getConverterLocator()
public IDebugSettings getDebugSettings()
IDebugSettings
public IExceptionSettings getExceptionSettings()
IExceptionSettings
public IFrameworkSettings getFrameworkSettings()
IFrameworkSettings
public abstract java.lang.Class getHomePage()
public final IMarkupCache getMarkupCache()
IMarkupSettings.getMarkupCache()
instead
public IMarkupSettings getMarkupSettings()
IMarkupSettings
public final java.io.Serializable getMetaData(MetaDataKey key)
key
- The key for the data
MetaDataKey
public final java.lang.String getName()
public IPageSettings getPageSettings()
IPageSettings
public IRequestCycleSettings getRequestCycleSettings()
IDebugSettings
public final IRequestLogger getRequestLogger()
RequestLogger
.
public IRequestLoggerSettings getRequestLoggerSettings()
IResourceSettings
public IResourceSettings getResourceSettings()
IResourceSettings
public ISecuritySettings getSecuritySettings()
ISecuritySettings
public ISessionSettings getSessionSettings()
ISessionSettings
public final ISessionStore getSessionStore()
public final SharedResources getSharedResources()
public final void initializeComponents()
public void logEventTarget(IRequestTarget target)
target
- public void logResponseTarget(IRequestTarget requestTarget)
requestTarget
- public abstract RequestCycle newRequestCycle(Request request, Response response)
request
- The requestresponse
- The response
public final RequestCycle newRequestCycle(Application application, Request request, Response response)
newRequestCycle(Request, Response)
application
- request
- response
-
java.lang.UnsupportedOperationException
- alwayspublic 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 void removeComponentInstantiationListener(IComponentInstantiationListener listener)
listener
- the listener to removepublic final void setMetaData(MetaDataKey key, java.io.Serializable object)
MetaDataKey
.
key
- The singleton key for the metadataobject
- The metadata object
java.lang.IllegalArgumentException
MetaDataKey
protected final void destroy()
onDestroy()
instead
protected void onDestroy()
protected final java.lang.Object getRequestCycleFactory()
newRequestCycle(Request, Response)
protected final java.lang.Object getSessionFactory()
newSession(Request, Response)
protected void init()
protected void internalDestroy()
protected void internalInit()
protected IConverterLocator newConverterLocator()
IConverterLocator
.
IConverterLocator
instanceprotected IRequestLogger newRequestLogger()
protected abstract ISessionStore newSessionStore()
public final void addComponentOnBeforeRenderListener(IComponentOnBeforeRenderListener listener)
IComponentOnBeforeRenderListener
. This method should typically only be
called during application startup; it is not thread safe.
listener
- public final void removeComponentOnBeforeRenderListener(IComponentOnBeforeRenderListener listener)
IComponentOnBeforeRenderListener
.
listener
- public final void addComponentOnAfterRenderListener(IComponentOnAfterRenderListener listener)
IComponentOnAfterRenderListener
. This method should typically only be called
during application startup; it is not thread safe.
listener
- public final void removeComponentOnAfterRenderListener(IComponentOnAfterRenderListener listener)
IComponentOnAfterRenderListener
.
listener
- public final void addRenderHeadListener(IHeaderContributor listener)
listener
- public void removeRenderHeadListener(IHeaderContributor listener)
listener
- public void notifyRenderHeadListener(IHeaderResponse response)
response
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |