org.wandora.piccolo

Class Application

java.lang.Object

org.wandora.piccolo.Application

All Implemented Interfaces:

XMLParamAware

public class Application
extends java.lang.Object
implements XMLParamAware

A generic Piccolo application. Application should be initialized with XMLParamProcessor from PiccoloServlet. This class is XMLParamAware and has special handling for xml parameters. service elements are used to register services to application (parsed according to normal XMLParamProcessor rules). actionmap element contains the action map for the application. It can contain any number of mapentry elements which each contain a key element and an action element. Key element should contain the string used as the action key and action element is parsed with KMLParamProcessor and should produce the action object. Depending on the used action, you might need to pass some parameters to the action. templates element is used to specify the used templates. It can contain any number of template elements. Each of these are parsed with XMLParamProcessor. Usually these will be VelocityTemplates (an XMLParamAware class) in which case each template element should contain the following elements (each having a plain string value): key, version, mimetype, encoding, template, caching. Of these, the value of caching should be either true or false. You can use other kinds of templates too, they just need to implement the Template interface. properties element is used to specify the application properties (retrieved with getProperty). It is parsed with MapParser, so it may contain any number of property elements each containing key and value elements. Both of these are parsed with XMLParamProcessor, so they may be any objects. Finally, the application element may contain any number of contextobject elements. Each is parsed with XMLParamProcessor. Context objects are returned by getDefaultContext which is usually called to initialize Velocity contexts. Thus these objects are usable in Velocity templates. The key for the object in the contexct is taken from key attribute (note that this is without namespace) in the contextobject element. Some special actions may be specified in the action map. Action with key "invaliduser" is executed when the request does not specify a valid user (e.g. wrong password). However, note that the current getUser implementation (which is used to get the user specified by the request) always returns a user so unless you override getUser, this action will never be called. Action with key "invalidaction" is executed when an invalid action key is specified in the request. If these actions are not specified but the event arises where they would be used, a log entry for the event is created and nothing is returned to the client who made the request. Some of the properties are also specifically used by Application. "defaultlang" property can be used to specify the language returned by getDefaultLang, which in turn is used by getUser, when no language is specified in the request parameters.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap	actionMap
protected java.util.HashMap	context
protected Logger	logger
protected java.util.HashMap	properties
protected java.util.HashMap	services
protected java.util.HashMap	templates
protected UserManager	userManager

Constructor Summary

Constructors

Constructor and Description
Application()

Method Summary

Modifier and Type	Method and Description
protected Action	getAction(User user, javax.servlet.ServletRequest request)
java.util.HashMap	getDefaultContext(User user) Returns a default context that should be used as the base for most Velocity templates.
protected java.lang.String	getDefaultLanguage()
protected Logger	getDefaultLogger()
protected java.lang.String	getDefaultTemplateVersion()
java.lang.Object	getProperty(java.lang.Object key) Returns a property defined in the XML params file used to initialize this application.
Service	getService(java.lang.String serviceType)
Template	getTemplate(java.lang.String key, User user) Gets the template with the specified key and version according to user preferences.
protected java.lang.String	getTemplateVersion(User user)
protected User	getUser(javax.servlet.ServletRequest request)
void	handleRequest(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
protected void	invalidAction(User user, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
protected void	invalidUser(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
protected void	processParamElement(org.w3c.dom.Element element, XMLParamProcessor processor)
protected void	updateUser(User user)
void	xmlParamInitialize(org.w3c.dom.Element element, XMLParamProcessor processor) XMLParamAware implementation.

Methods inherited from class java.lang.Object

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

Field Detail

actionMap

protected java.util.HashMap actionMap

services

protected java.util.HashMap services

templates

protected java.util.HashMap templates

properties

protected java.util.HashMap properties

context

protected java.util.HashMap context

logger

protected Logger logger

userManager

protected UserManager userManager

Constructor Detail

Application

public Application()

Method Detail

getUser

protected User getUser(javax.servlet.ServletRequest request)

updateUser

protected void updateUser(User user)

getAction

protected Action getAction(User user,
                           javax.servlet.ServletRequest request)

invalidUser

protected void invalidUser(javax.servlet.ServletRequest request,
                           javax.servlet.ServletResponse response)

invalidAction

protected void invalidAction(User user,
                             javax.servlet.ServletRequest request,
                             javax.servlet.ServletResponse response)

handleRequest

public void handleRequest(javax.servlet.ServletRequest request,
                          javax.servlet.ServletResponse response)

getDefaultLanguage

protected java.lang.String getDefaultLanguage()

getDefaultTemplateVersion

protected java.lang.String getDefaultTemplateVersion()

getTemplateVersion

protected java.lang.String getTemplateVersion(User user)

getTemplate

public Template getTemplate(java.lang.String key,
                            User user)

Gets the template with the specified key and version according to user preferences. If no template is found with the preferred user version, then a template with default version is returned.

getProperty

public java.lang.Object getProperty(java.lang.Object key)

Returns a property defined in the XML params file used to initialize this application.

getDefaultLogger

protected Logger getDefaultLogger()

getService

public Service getService(java.lang.String serviceType)

processParamElement

protected void processParamElement(org.w3c.dom.Element element,
                                   XMLParamProcessor processor)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultContext

public java.util.HashMap getDefaultContext(User user)

Returns a default context that should be used as the base for most Velocity templates. The returned context will contain all context objects specified in the XML parameters and this Application with key "application", the user provided in the parametrs with key "user" and the language of the user with key "lang".

xmlParamInitialize

public void xmlParamInitialize(org.w3c.dom.Element element,
                               XMLParamProcessor processor)

XMLParamAware implementation. Handles initialization from XML parameters.

Specified by:

xmlParamInitialize in interface XMLParamAware