org.mmbase.framework.basic

Class BasicFramework

java.lang.Object

org.mmbase.framework.Framework

org.mmbase.framework.basic.BasicFramework

public class BasicFramework
extends Framework

The Basic Framework is based on a list of UrlConverters. It is configured in 'config/framework.xml'. The order in which the UrlConverters are configured is the order in which they are processed.

Since:

MMBase-1.9

Version:

$Id$

Author:

Michiel Meeuwissen

Field Summary

Fields

Modifier and Type	Field and Description
static Parameter<String>	ACTION
protected LocalizedString	description
protected UrlConverter	fallbackConverter
static String	NAMESPACE
protected Map<Setting<?>,Object>	settingValues
static String	XSD

Fields inherited from class org.mmbase.framework.Framework

BLOCK, COMPONENT, COMPONENT_CLASS_KEY, COMPONENT_CURRENTUSER_KEY, COMPONENT_ID_KEY, COMPONENT_INCLUDEPATH_KEY, N

Constructor Summary

Constructors

Constructor and Description
BasicFramework()
BasicFramework(Element el)

Method Summary

Modifier and Type	Method and Description
protected void	configure(Element el) Configures the framework by reading its config file 'config/framework.xml' containing a list with UrlConverters.
Parameters	createParameters() Return a Parameters object that needs to be passed on to the getUrl() call.
Parameters	createSettingValueParameters()
protected String	getComponentClass()
String	getInternalUrl(String page, Map<String,?> params, Parameters frameworkParameters) Generates an URL to a resource to be called and included by a renderer.
protected String	getKey(Setting<?> setting)
protected Map<String,Object>	getMap(State state, Map<String,Object> params)
String	getName() Return the name of the framework
Parameter<?>[]	getParameterDefinition()
protected String	getPrefix(State state)
String	getProcessUrl(String path, Map<String,?> parameters, Parameters frameworkParameters, boolean escapeAmps)
Block	getRenderingBlock(Parameters frameworkParameters) Returns the block, which is currently rendering, or null
<C> C	getSettingValue(Setting<C> setting, Parameters parameters) Retrieves the value as configured by this framework for a certain Setting (which is always associated with a certain Component.
String	getUrl(String path, Map<String,?> parameters, Parameters frameworkParameters, boolean escapeAmps) Return a (possibly modified) URL for a given path.
String	getUserBuilder() Return the builder name that is used to store users.
Node	getUserNode(Parameters frameworkParameters) Return an MMBase Node for the user currently using the framework.
<C> C	loadSettingValue(Setting<C> setting)
boolean	makeRelativeUrl()
Map<String,Object>	prefix(State state, Map<String,Object> params)
void	process(Processor processor, Parameters blockParameters, Parameters frameworkParameters) I think in the basic framework this method is never called explicitely, because processing is done implicitely by the render
void	render(Renderer renderer, Parameters blockParameters, Parameters frameworkParameters, Writer w, WindowState windowState) Basic Framework implicitely also processes, i'm not sure if we should require any framework to do that (perhaps we could say, that the render method must process, if that is necessary, and not yet done).
<C> void	saveSettingValue(Setting<C> setting, C value)
protected void	setBlockParametersForProcess(State state, Parameters blockParameters)
protected void	setBlockParametersForRender(State state, Parameters blockParameters)
<C> C	setSettingValue(Setting<C> setting, Parameters parameters, C value) See Framework.getSettingValue(org.mmbase.framework.Setting<C>, org.mmbase.util.functions.Parameters).
String	toString()

Methods inherited from class org.mmbase.framework.Framework

getInstance

Methods inherited from class java.lang.Object

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

Field Detail

XSD

public static final String XSD

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

ACTION

public static final Parameter<String> ACTION

fallbackConverter

protected final UrlConverter fallbackConverter

description

protected final LocalizedString description

settingValues

protected final Map<Setting<?>,Object> settingValues

Constructor Detail

BasicFramework

public BasicFramework(Element el)

BasicFramework

public BasicFramework()

Method Detail

getUrl

public String getUrl(String path,
                     Map<String,?> parameters,
                     Parameters frameworkParameters,
                     boolean escapeAmps)
              throws FrameworkException

Description copied from class: Framework

Return a (possibly modified) URL for a given path. This method is called (for example) from within the mm:url tag, and can be exposed to the outside world. I.e. when within a components's head you use
<mm:url page="/css/style.css" />,
this method is called to determine the proper url (i.e., relative to the framework or component base). If you need treefile/leaffile type of functionality in your framework, you can implement that here in your code.

Specified by:

getUrl in class Framework

Parameters:

path - The path (generally a relative URL) to create an URL for.

parameters - Parameters The parameters to be passed to the page

frameworkParameters - The parameters that are required by the framework

escapeAmps - true if parameters should be added with an escaped & (&amp;). You should escape & when a URL is exposed (i.e. in HTML), but not if the url is for some reason called directly.

Returns:

An URL relative to the root of this web application (i.e. without a context path), Never null.

Throws:

FrameworkException - thrown when something goes wrong in the Framework

getProcessUrl

public String getProcessUrl(String path,
                            Map<String,?> parameters,
                            Parameters frameworkParameters,
                            boolean escapeAmps)
                     throws FrameworkException

Specified by:

getProcessUrl in class Framework

Throws:

FrameworkException

getInternalUrl

public String getInternalUrl(String page,
                             Map<String,?> params,
                             Parameters frameworkParameters)
                      throws FrameworkException

Description copied from class: Framework

Generates an URL to a resource to be called and included by a renderer. Typically, this generates a URL to a jsp, called by a renderer such as the JspRenderer, who calls the resource using the RequestDispatcher. This method allows for frameworks to do some filtering on URLs (such as pretty URLs). You should generally not call this method unless you write a Renderer that depends on code or data from external resources.

Specified by:

getInternalUrl in class Framework

Parameters:

page - The page (e.g. image/css) provided by the component to create an URL for

params - Extra parameters for that path

frameworkParameters - The parameters that are required by the framework, such as the 'request' and 'cloud' objects

Returns:

A valid internal URL, or null if nothing framework specific could be determined (this would make it possible to 'chain' frameworks).

Throws:

FrameworkException - thrown when something goes wrong in the Framework

getName

public String getName()

Description copied from class: Framework

Return the name of the framework

Specified by:

getName in class Framework

Returns:

Name

configure

protected void configure(Element el)

Configures the framework by reading its config file 'config/framework.xml' containing a list with UrlConverters.

getRenderingBlock

public Block getRenderingBlock(Parameters frameworkParameters)

Description copied from class: Framework

Returns the block, which is currently rendering, or null

Specified by:

getRenderingBlock in class Framework

getParameterDefinition

public Parameter<?>[] getParameterDefinition()

Specified by:

getParameterDefinition in class Framework

createParameters

public Parameters createParameters()

Description copied from class: Framework

Return a Parameters object that needs to be passed on to the getUrl() call. Many components will be implemented as servlets, so will not work if the framework does not at least include Parameter.REQUEST and Parameter.RESPONSE. So it is recommended that those parameters are supported by the framework. The MMBase taglib component tag will e.g. auto-fill those parameters. Other parameters can be added using 'mm:frameworkparameter' A framework may create a different or expanded list of parameters, but is responsible for filling them properly. If the framework does not use the MMBase taglib for rendering of components, it needs to provide it's own mechanism to fill the above parameters with default values (such as through a servlet or portlet).

Specified by:

createParameters in class Framework

Returns:

Parameters

makeRelativeUrl

public boolean makeRelativeUrl()

setBlockParametersForRender

protected void setBlockParametersForRender(State state,
                                           Parameters blockParameters)

setBlockParametersForProcess

protected void setBlockParametersForProcess(State state,
                                            Parameters blockParameters)

To Do:

getComponentClass

protected String getComponentClass()

render

public void render(Renderer renderer,
                   Parameters blockParameters,
                   Parameters frameworkParameters,
                   Writer w,
                   WindowState windowState)
            throws FrameworkException

Basic Framework implicitely also processes, i'm not sure if we should require any framework to do that (perhaps we could say, that the render method must process, if that is necessary, and not yet done).

Specified by:

render in class Framework

Parameters:

renderer - the Renderer used to produce the content. This parameter is obtained using Block.getRenderer(org.mmbase.framework.Renderer.Type)

blockParameters - The parameters specific for the call of this renderer's block

frameworkParameters - The parameters that are required by the framework, such as the 'request' and 'cloud' objects

w - The writer where the code generated by the renderer is to be written (such as the jspWriter)

windowState - the window state in which the content should be rendered

Throws:

FrameworkException - when the renderer failed to create content or could not write data to the writer

process

public void process(Processor processor,
                    Parameters blockParameters,
                    Parameters frameworkParameters)
             throws FrameworkException

I think in the basic framework this method is never called explicitely, because processing is done implicitely by the render

Specified by:

process in class Framework

Parameters:

processor - the Processor used to produce the content. This parameter is obtained using Block.getProcessor()

blockParameters - The parameters specific for the call of this renderer's block.

frameworkParameters - The parameters that are required by the framework, such as the 'request' and 'cloud' objects.

Throws:

FrameworkException - when the process failed to run

getUserNode

public Node getUserNode(Parameters frameworkParameters)

Description copied from class: Framework

Return an MMBase Node for the user currently using the framework. It is recommended that this is implemented as is done in BasicFramework, so based on MMBase security only, and using a Parameter.CLOUD as a framework parameter. It can be implemented differently, if the framework chooses not to use MMBase security to distinguish between users.

Specified by:

getUserNode in class Framework

Parameters:

frameworkParameters - The parameters that are required by the framework, such as the 'request' and 'cloud' objects.

getUserBuilder

public String getUserBuilder()

Description copied from class: Framework

Return the builder name that is used to store users. This will return the name of the nodemanager that returns the nodes from the getUserNode() method.

Specified by:

getUserBuilder in class Framework

prefix

public Map<String,Object> prefix(State state,
                                 Map<String,Object> params)

getPrefix

protected String getPrefix(State state)

getMap

protected Map<String,Object> getMap(State state,
                                    Map<String,Object> params)

toString

public String toString()

Overrides:

toString in class Object

createSettingValueParameters

public Parameters createSettingValueParameters()

Specified by:

createSettingValueParameters in class Framework

See Also:

Framework.getSettingValue(Setting, Parameters), Framework.setSettingValue(Setting, Parameters, Object)

getKey

protected String getKey(Setting<?> setting)

getSettingValue

public <C> C getSettingValue(Setting<C> setting,
                             Parameters parameters)

Description copied from class: Framework

Retrieves the value as configured by this framework for a certain Setting (which is always associated with a certain Component. The framework can (and should) return the default values of the Setting if it does not know what to do. It can also administrate overridden values, e.g. in its own configuration file. Using the 'parameters' (created with Framework.createSettingValueParameters(), the Framework can also implement context specific values for a setting. It can e.g. use a request object, and store user specific value as cookies.

Specified by:

getSettingValue in class Framework

setSettingValue

public <C> C setSettingValue(Setting<C> setting,
                             Parameters parameters,
                             C value)

Description copied from class: Framework

See Framework.getSettingValue(org.mmbase.framework.Setting<C>, org.mmbase.util.functions.Parameters). Depending on the framework, the set value may not necessarily be persistent.

Specified by:

setSettingValue in class Framework

loadSettingValue

public <C> C loadSettingValue(Setting<C> setting)

saveSettingValue

public <C> void saveSettingValue(Setting<C> setting,
                                 C value)