dk.brics.jwig

Class WebApp

java.lang.Object

dk.brics.jwig.WebContext

dk.brics.jwig.WebApp

public abstract class WebApp
extends WebContext

Abstract base class for JWIG web applications.

All public non-static methods with return type String, XML, URL, or void in a deployed WebApp become accessible using HTTP GET requests. For deployment and configuration, see WebSite.

See Also:

URLPattern, Priority

Field Summary

Fields inherited from class dk.brics.jwig.WebContext

CACHE_PRIORITY, context, HANDLERS, JWIG_DEFUNCT_SESSION, log, MAX_PRIORITY, PRE_CACHE

Constructor Summary

Constructors

Constructor and Description
WebApp() Constructs a new web application object.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Called on each web app when the website is closed.
static WebApp	get() Returns the WebApp object for the current thread.
protected XML	getPageName(String annotatedName) Returns the name of the web method with the given annotated name.
Map<String,Object>	getProperties() Returns the combined web app and web site configuration properties.
<T> T	getProperty(String name) Returns the web app configuration property value for the given name.
<T> T	getProperty(String name, T defaultValue) Returns the configuration property value for the given name, with a default value.
DirectObjectSecurityManager	getSecurityManager() Returns the security manager for this web app.
protected <T> void	setProperty(String name, T value) Sets a web app configuration property.

Methods inherited from class dk.brics.jwig.WebContext

addCookie, addResponseInvalidator, augment, cache, getCacheAugmentedString, getCookies, getRequestURL, getResponse, getServletContext, getServletRequest, getServletResponse, getUser, getWebAppParam, getWebAppParam, getWebAppURL, getWebSite, getWebSiteURL, getWebSiteURL, handlers, handleUpdatedObjects, isSecure, jwigJS, main, makeURL, makeURL, makeURL, makeURL, makeURL, makeURL, makeURL, next, punish, sendEmail, sendEmails, sendEmailsAsynchronously, sendResponse, touchSessions, transportSessionHandlers, update

Methods inherited from class java.lang.Object

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

Constructor Detail

WebApp

public WebApp()

Constructs a new web application object.

Method Detail

destroy

public void destroy()

Called on each web app when the website is closed. Default implementation does nothing

get

public static WebApp get()

Returns the WebApp object for the current thread. This method makes it easy get access to the current WebApp object from outside the WebApp subclass.

getPageName

protected XML getPageName(String annotatedName)

Returns the name of the web method with the given annotated name. The annotated name is the string set on the web method using the PageName annotation or the name of the web method itself if such an annotation is missing. Web applications may use the method to for instance translate the names of web application pages.

Parameters:

annotatedName - The annotated name of the page

Returns:

A representation of the actual name of the web method

See Also:

PageName

getProperties

public final Map<String,Object> getProperties()

Returns the combined web app and web site configuration properties.

getProperty

public final <T> T getProperty(String name)

Returns the web app configuration property value for the given name. If not set for the web app, a lookup is performed in the web site configuration.

See Also:

WebSite.getProperty(String)

getProperty

public final <T> T getProperty(String name,
                T defaultValue)

Returns the configuration property value for the given name, with a default value. If not set for the web app, a lookup is performed in the web site configuration.

Throws:

ClassCastException - if the actual type cannot be converted to the type of the default value

getSecurityManager

public DirectObjectSecurityManager getSecurityManager()

Returns the security manager for this web app.

setProperty

protected final <T> void setProperty(String name,
                   T value)

Sets a web app configuration property. Typically invoked from the web app constructor.

See Also:

WebSite.setProperty(String, Object)