blob: 8a9b187ea56f7104d78bdc49e4b7452d17cb53f3 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>The Design Time Application Manager</title>
<meta http-equiv="Content-Style-Type" content="text/css">
<meta http-equiv="Content-Script-Type" content="text/javascript">
<link rel="stylesheet" href="../../book.css" type="text/css">
<link rel="stylesheet" href="../tutorials/default_style.css">
<table summary="" cellpadding="0" cellspacing="0" width="100%">
<tr valign="bottom">
<td align="left" width="86%">
<h1>The Design Time Application Manager</h1>
The Design Time Application Manager (DTAppMgr), defines the early stages
of a mechanism to simulate JSF runtime state conditions at design
time.&nbsp; While it is not intended to replace a runtime simulator, it
provides an extensible framework to allow adopters to provide end-user
features that depend on simulating certain specific runtime
behavior.&nbsp; These features include validation and content assist for
EL expressions.
<p>The DTAppMgr is comprised of the following main components:</p>
<li>a simulated FacesContext, called DTFacesContext, used to
simulates part of this key runtime context object.</li>
<li>a pluggable ExternalContext, called DTExternalContext to
support different behaviors in different containers (i.e. JSP).</li>
<li>pluggable resolvers for EL variables, properties and methods
including default implementations.</li>
<li>a JSP processor that can update simulated design time state
based on a JSP page and tag-based meta-data.</li>
<h3><span style="font-weight: bold;">The simulated
The simulated FacesContext, called DTFacesContext, currently supports a
very limited subset of the runtime FacesContext object.&nbsp; Its main
function is to allow for a pluggable external context.&nbsp; At
design-time, one FacesContext is created per IFile.
<h3>Pluggable ExternalContext</h3>
The ExternalContext is used to separate container-dependent context
information from the rest of the FacesContext.&nbsp; At design time, we
support a DTExternalContext with much the same function.&nbsp; This
external context can be configured by adopters by implementing a factory
extension point.&nbsp; The extension point is
org.eclipse.jst.jsf.designtime.externalcontext.&nbsp; You extension will
define an id and class.&nbsp; The id uniquely identifies you factory
class, which must extend
.&nbsp; To set your external context factory as the current one, use
.&nbsp; Note that by changing the current ExternalContextProvider on a
project, you will significantly change the behavior of how variables are
resolved in EL expressions.
<h3>Pluggable resolvers</h3>
JSF EL expressions may contain variable and method bindings that
reference external objects.&nbsp; At runtime, this is accomplished
through several mechanisms that convert different types of identifier
symbols into objects and methods.&nbsp; At design-time the JSF tooling
tries to parallel these as closely as possible.&nbsp; These mechanisms
<p>All identifier symbol resolution in EL starts with the
VariableResolver.&nbsp; An expression like "" is resolved
by first extracting the symbol "myBean" and requesting the
VariableResolver to return a matching runtime object.&nbsp; At design
time, we parallel this exactly but constructing a design-time
description of the object rather than its actual value (since the actual
value cannot be fully computed until runtime in most cases).&nbsp; The
concept of a "DTVariableResolver" is introduced.&nbsp; A default
implementation is automatically provided which closely mirrors the
default runtime resolver.&nbsp; New variable resolvers can be
contributed through the Eclipse extension point mechanism to support
custom runtime counterparts.&nbsp; To learn more about contributing new
variables, see <a href="contributing_el_variables.html">Contributing
EL Variables</a>.</p>
<p>Once a variable is resolved, the next step in resolving a value
binding is to resolve its properties.&nbsp; To return to our simple
example, "", the JSF runtime will pass the object
returned for 'myBean' to the property resolver along with the name
'property' and ask it to resolve it to an object.&nbsp; At design time,
we parallel this by introducing the "DTPropertyResolver".</p>
<p>The method binding mechanism implemented by the JSF runtime,
differs from the way variables and properties are resolved.&nbsp; At
design time however, we support them in the same way by providing a
"DTMethodResolver".&nbsp; The main reason for this divergence is that at
runtime, the method binding need know only enough to invoke a
method.&nbsp; However at design time, we want to be able resolve a
method binding in such a way that we can provide the same kinds of
features we provide for properties such as signature validation and
content assist.</p>
<h3><a id="jsp_document_processor">JSP document processor</a></h3>
The JSP document processor parses JSP document models looking for
information to update in the simulated design time.&nbsp; The primary
objective of the processor is to allow component writers to add support
for tags that contribute EL variables.&nbsp; They can accomplish this by
contributing JSF tooling meta-data for a particular
uri/element/attribute that defines such a variable.&nbsp; The meta-data
properties that are supported are as follows:
<table style="width: 100%; text-align: left;" border="1" cellpadding="2"
<td style="vertical-align: top; font-weight: bold">Meta-data
<td style="vertical-align: top; font-weight: bold">Valid Values<br>
<td style="vertical-align: top; font-weight: bold">Description<br>
<td style="vertical-align: top;">contributes-value-binding<br>
<td style="vertical-align: top;">true or false<br>
<td style="vertical-align: top;">This property alerts the model
processor that this attribute contributes a variable to the EL name
space at runtime.&nbsp; If no further meta-data is provided, this
will cause a default variable using the text of the attribute as the
name to be added to the name space for this document at 'request'
scope.&nbsp; The variable will have&nbsp; no properties or
methods.&nbsp; More information about the variable can be provided
using the extra meta-data defined below.<br>
<td style="vertical-align: top;">value-binding-scope<br>
<td style="vertical-align: top;">'request', 'session',
<td style="vertical-align: top;">This property will set the
runtime scope for the contribute variable. The default is 'request'
if not provided.<br>
<td style="vertical-align: top;">value-binding-symbol-factory<br>
<td style="vertical-align: top;">An corresponding to a
'factoryId' field on a valid extension of '<a
<td style="vertical-align: top;">If you wish to customize the
variable created for this attribute, you can specify this factory
extension.&nbsp; Your factory will be passed all available context,
including DOM context, with which you can decide how to create a
custom symbol for your variable.&nbsp;&nbsp; See <a
href="./contributing_el_variables.html">Contributing EL
Variables</a> for more details.<br>
<p><b>From 3.0</b></p></td>
<td>Must be of the form &quot;Ljava.lang.String;&quot;. See the
JDT Signature class for more information</td>
<td>A java signature that suggests a static type for the
resulting symbol. <b>Optional.</b></td>
<td><p>optional-value-binding-valueexpr-attr</p><p><b>From 3.0</b></p></td><td>Must be the name of an attribute on the same element.</td><td>The name of the attribute on the same element that will hold a value expression whose type will be used as the type of the resulting symbol. <b>Optional.</b></td>
<h4>Loadbundle example</h4>
Below is the meta-data markup for the built-in core loadBundle variable
contributor meta-data:
<div class="code"><pre>
&lt;entity id="loadBundle"&gt;
&lt;entity id="var"&gt;
&lt;trait id="contributes-value-binding"&gt;
&lt;trait id="value-binding-scope"&gt;
&lt;trait id="value-binding-symbol-factory"&gt;
<p>This fragment defines meta-data for the attribute 'var' of tag
element 'loadBundle' (the uri for the tag library is declared in the
extension point).&nbsp; The meta-data tells the processor to add a
variable with scope 'request' using the factory defined by the extension
factory id 'org.eclipse.jst.jsf.designtime.core.loadBundle'.</p>
<h4>Other Information</h4>
<li><a href="./metadata_framework.html">Design-time Meta-data
Variable Contributor Tutorial</a></li>
Meta-data for Apache Tomahawk Component Tutorial</a></li>