org.directwebremoting.impl
Class DefaultCreatorManager

java.lang.Object
  org.directwebremoting.impl.DefaultCreatorManager

All Implemented Interfaces:

CreatorManager, UninitializingBean

public class DefaultCreatorManager
extends java.lang.Object
implements CreatorManager, UninitializingBean

A class to manage the types of creators and the instantiated creators.

Author:

Joe Walker [joe at getahead dot ltd dot uk]

Constructor Summary

DefaultCreatorManager()

Method Summary

void	addCreator(Creator creator) Add a new creator.
void	addCreator(java.lang.String typeName, java.util.Map<java.lang.String,java.lang.String> params) Add a new creator
void	addCreatorType(java.lang.String typeName, java.lang.String className) In init mode, add a new type of creator
void	contextDestroyed() Called when a ServletContext is being destroyed.
Creator	getCreator(java.lang.String scriptName, boolean includeHidden) Find an Creator by name
java.util.Collection<java.lang.String>	getCreatorNames(boolean includeHidden) Get a list of the javascript names of the allowed creators.
boolean	isDebug() Debug mode allows access to the list of creator names
boolean	isInitApplicationScopeCreatorsAtStartup() Do we do full-create on startup?
void	servletDestroyed() Called when GenericServlet.destroy() is called.
void	setCreators(java.util.Map<java.lang.String,Creator> creators) Sets the creators for this creator manager.
void	setDebug(boolean debug) Set the debug status
void	setInitApplicationScopeCreatorsAtStartup(boolean initApplicationScopeCreatorsAtStartup) Do we do full-create on startup?
void	setServletContext(javax.servlet.ServletContext servletContext) When initApplicationScopeCreatorsAtStartup = true we need somewhere to store the objects

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCreatorManager

public DefaultCreatorManager()

Method Detail

addCreatorType

public void addCreatorType(java.lang.String typeName,
                           java.lang.String className)

Description copied from interface: CreatorManager

In init mode, add a new type of creator

Specified by:

addCreatorType in interface CreatorManager

Parameters:

typeName - The name of the new creator type

className - The class that we create

addCreator

public void addCreator(java.lang.String typeName,
                       java.util.Map<java.lang.String,java.lang.String> params)
                throws java.lang.InstantiationException,
                       java.lang.IllegalAccessException,
                       java.lang.IllegalArgumentException

Description copied from interface: CreatorManager

Add a new creator

Specified by:

addCreator in interface CreatorManager

Parameters:

typeName - The class to use as a creator

params - The extra parameters to allow the creator to configure itself

Throws:

java.lang.InstantiationException - If reflection based creation fails

java.lang.IllegalAccessException - If reflection based creation fails

java.lang.IllegalArgumentException - If we have a duplicate name

addCreator

public void addCreator(Creator creator)
                throws java.lang.IllegalArgumentException

Description copied from interface: CreatorManager

Add a new creator. read the value from the creator

Specified by:

addCreator in interface CreatorManager

Parameters:

creator - The creator to add

Throws:

java.lang.IllegalArgumentException - If we have a duplicate name

getCreatorNames

public java.util.Collection<java.lang.String> getCreatorNames(boolean includeHidden)
                                                       throws java.lang.SecurityException

Description copied from interface: CreatorManager

Get a list of the javascript names of the allowed creators. This method could be seen as a security risk because it could allow an attacker to find out extra information about your system so it is only available if debug is turned on.

Specified by:

getCreatorNames in interface CreatorManager

Parameters:

includeHidden - Should we include hidden classes in the list?

Returns:

Loop over all the known allowed classes

Throws:

java.lang.SecurityException - If we are not in debug mode

getCreator

public Creator getCreator(java.lang.String scriptName,
                          boolean includeHidden)
                   throws java.lang.SecurityException

Description copied from interface: CreatorManager

Find an Creator by name

Specified by:

getCreator in interface CreatorManager

Parameters:

scriptName - The name of the creator to Javascript

includeHidden - Should we include hidden classes?

Returns:

The found Creator instance, or null if none was found.

Throws:

java.lang.SecurityException - If the Creator is not known

contextDestroyed

public void contextDestroyed()

Description copied from interface: UninitializingBean

Called when a ServletContext is being destroyed. DWR finds out about this destruction if (and only if) in web.xml there is a DwrListener registered. This happens before the GenericServlet.destroy() is called.

If DwrListener is not registered, this will not happen

This method should only be used when we need to take action to enable the servlet to stop cleanly. Typically this will be restricted to stopping reverse ajax threads.

Specified by:

contextDestroyed in interface UninitializingBean

servletDestroyed

public void servletDestroyed()

Description copied from interface: UninitializingBean

Called when GenericServlet.destroy() is called. This event is the preferred time to close resources that don't require all connections to be closed. The servletDestroy method is far more likely to be called.

Specified by:

servletDestroyed in interface UninitializingBean

setCreators

public void setCreators(java.util.Map<java.lang.String,Creator> creators)

Description copied from interface: CreatorManager

Sets the creators for this creator manager.

Specified by:

setCreators in interface CreatorManager

Parameters:

creators - the map of managed beans and their creator instances

isDebug

public boolean isDebug()

Description copied from interface: CreatorManager

Debug mode allows access to the list of creator names

Specified by:

isDebug in interface CreatorManager

Returns:

Are we in debug mode

setDebug

public void setDebug(boolean debug)

Set the debug status

Parameters:

debug - The new debug setting

isInitApplicationScopeCreatorsAtStartup

public boolean isInitApplicationScopeCreatorsAtStartup()

Do we do full-create on startup?

Returns:

true if we are doing full-create

setInitApplicationScopeCreatorsAtStartup

public void setInitApplicationScopeCreatorsAtStartup(boolean initApplicationScopeCreatorsAtStartup)

Do we do full-create on startup?

Parameters:

initApplicationScopeCreatorsAtStartup - true for full create

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

When initApplicationScopeCreatorsAtStartup = true we need somewhere to store the objects