uk.ltd.getahead.dwr
Interface Creator

All Known Implementing Classes:

AbstractCreator, JsfCreator, NewCreator, NullCreator, PageFlowCreator, ScriptedCreator, SpringCreator, StrutsCreator

public interface Creator

A base class for all AllowedClasses

Author:

Joe Walker [joe at getahead dot ltd dot uk]

Field Summary

static java.lang.String	APPLICATION Application scope: named reference remains available in the ServletContext until it is reclaimed.
static java.lang.String	PAGE Page scope: (this is the default) the named reference remains available in this PageContext until the return from the current Servlet.service() invocation.
static java.lang.String	REQUEST This type of scope is not currently supported by DWR Request scope: the named reference remains available from the ServletRequest associated with the Servlet until the current request is completed.
static java.lang.String	SESSION Session scope (only valid if this page participates in a session): the named reference remains available from the HttpSession (if any) associated with the Servlet until the HttpSession is invalidated.

Method Summary

java.lang.Object	getInstance() Accessor for the/an instance of this Creator.
java.lang.String	getScope() Each Creator creates objects with a given scope.
java.lang.Class	getType() Accessor for the java.lang.Class that this Creator allows access to.
void	setProperties(java.util.Map params) DefaultConfiguration is done via access to the DOM Element.

Field Detail

APPLICATION

static final java.lang.String APPLICATION

Application scope: named reference remains available in the ServletContext until it is reclaimed.

See Also:

Constant Field Values

SESSION

static final java.lang.String SESSION

Session scope (only valid if this page participates in a session): the named reference remains available from the HttpSession (if any) associated with the Servlet until the HttpSession is invalidated.

See Also:

Constant Field Values

REQUEST

static final java.lang.String REQUEST

This type of scope is not currently supported by DWR Request scope: the named reference remains available from the ServletRequest associated with the Servlet until the current request is completed.

See Also:

Constant Field Values

PAGE

static final java.lang.String PAGE

Page scope: (this is the default) the named reference remains available in this PageContext until the return from the current Servlet.service() invocation.

See Also:

Constant Field Values

Method Detail

setProperties

void setProperties(java.util.Map params)
                   throws java.lang.IllegalArgumentException

DefaultConfiguration is done via access to the DOM Element. This is not at all ideal, but it will do for the moment.

Parameters:

params - The map of paramters to configure the creator

Throws:

java.lang.IllegalArgumentException - If the config data in the Element is invalid

getType

java.lang.Class getType()

Accessor for the java.lang.Class that this Creator allows access to.

Returns:

The type of this allowed class

getInstance

java.lang.Object getInstance()
                             throws java.lang.InstantiationException

Accessor for the/an instance of this Creator.

Returns:

the instance to use

Throws:

java.lang.InstantiationException - If for some reason the object can not be created

getScope

java.lang.String getScope()

Each Creator creates objects with a given scope.

Returns:

How long do we hold onto instances created by this Creator