Google Git
Sign in
eclipse / gerrit / jsf / webtools.jsf.docs / 1ae5a9adf9583b386ce5c6efb7d814a11f398b24 / . / plugins / org.eclipse.jst.jsf.doc.dev / html / api_reference / org / eclipse / jst / jsf / core / jsfappconfig / package-summary.html
blob: 70d4d8de331474b1da320cd727f3b2627f313617 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_06) on Fri Jun 05 14:31:29 PDT 2009 -->
<TITLE>
org.eclipse.jst.jsf.core.jsfappconfig
</TITLE>
<META NAME="date" CONTENT="2009-06-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.eclipse.jst.jsf.core.jsfappconfig";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/core/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/core/jsflibraryconfiguration/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/jst/jsf/core/jsfappconfig/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package org.eclipse.jst.jsf.core.jsfappconfig
</H2>
Project-level support for JSF application configuration files.
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IFacesConfigChangeListener.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig">IFacesConfigChangeListener</A></B></TD>
<TD>IFacesConfigChangeListener is the interface that must be implemented by
objects interested in receiving notification of changes to application
configuration models.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig">IJSFAppConfigLocater</A></B></TD>
<TD>IJSFAppConfigLocater is the interface that Objects capable of locating
and providing JSF application configuration resources must implement.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvider.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig">IJSFAppConfigProvider</A></B></TD>
<TD>IJSFAppConfigProvider is the interface that Objects capable of providing
JSF application configuration models must implement.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvidersChangeListener.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig">IJSFAppConfigProvidersChangeListener</A></B></TD>
<TD>Interface that an Object wishing to be notified about changes to the Set of
IJSFAppConfigProvider instances implements.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/AbstractJSFAppConfigLocater.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">AbstractJSFAppConfigLocater</A></B></TD>
<TD>Abstract implementation of <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigLocater.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><CODE>IJSFAppConfigLocater</CODE></A> that provides common
locater functionality.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/AbstractJSFAppConfigProvider.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">AbstractJSFAppConfigProvider</A></B></TD>
<TD>Abstract implementation of <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvider.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><CODE>IJSFAppConfigProvider</CODE></A> that provides
common provider functionality.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/ArtifactEditJSFAppConfigProvider.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">ArtifactEditJSFAppConfigProvider</A></B></TD>
<TD>ArtifactEditJSFAppConfigProvider uses FacesConfigArtifactEdit to provide
the root element of an application configuration model.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/ContextParamSpecifiedJSFAppConfigLocater.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">ContextParamSpecifiedJSFAppConfigLocater</A></B></TD>
<TD>ContextParamSpecifiedJSFAppConfigLocater attempts to locate application
configuration files specified by the JSF CONFIG_FILES context parameter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/DefaultJSFAppConfigLocater.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">DefaultJSFAppConfigLocater</A></B></TD>
<TD>DefaultJSFAppConfigLocater attempts to locate the default application
configuration file, located at "/WEB-INF/faces-config.xml".</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/ImplicitRuntimeJSFAppConfigLocater.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">ImplicitRuntimeJSFAppConfigLocater</A></B></TD>
<TD>ImplicitRuntimeJSFAppConfigLocater creates an <A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/IJSFAppConfigProvider.html" title="interface in org.eclipse.jst.jsf.core.jsfappconfig"><CODE>IJSFAppConfigProvider</CODE></A>
instance that provides an application configuration model that contains
implicit configuration elements that are specified as required to be
provided by a JSF implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/ImplicitRuntimeJSFAppConfigProvider.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">ImplicitRuntimeJSFAppConfigProvider</A></B></TD>
<TD>ImplicitRuntimeJSFAppConfigProvider provides an application configuration
model that contains implicit configuration objects provided by a JSF
implementation at runtime.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/JARFileJSFAppConfigProvider.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">JARFileJSFAppConfigProvider</A></B></TD>
<TD>JARFileJSFAppConfigProvider provides the root element of an application
configuration model by loading the model from a /META-INF/faces-config.xml
entry in a JAR file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/JSFAppConfigManager.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">JSFAppConfigManager</A></B></TD>
<TD>JSFAppConfigManager provides an entry point to an entire JSF application
configuration, which is defined in one or more application configuration
resource files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/JSFAppConfigProvidersChangeEvent.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">JSFAppConfigProvidersChangeEvent</A></B></TD>
<TD>JSFAppConfigProvidersChangeEvent provides change information to instances of
IJSFAppConfigProvidersChangeListener.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/JSFAppConfigUtils.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">JSFAppConfigUtils</A></B></TD>
<TD>JSFAppConfigUtils provides utility methods useful in processing of a JSF
application configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/RuntimeClasspathJSFAppConfigLocater.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">RuntimeClasspathJSFAppConfigLocater</A></B></TD>
<TD>RuntimeClasspathJSFAppConfigLocater attempts to locate application
configuration files in JAR files on the runtime classpath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../../org/eclipse/jst/jsf/core/jsfappconfig/WebContentRelativeJSFAppConfigLocater.html" title="class in org.eclipse.jst.jsf.core.jsfappconfig">WebContentRelativeJSFAppConfigLocater</A></B></TD>
<TD>WebContentRelativeJSFAppConfigLocater is an abstract base class that
attempts to locate specified application configuration files relative to a
web content folder.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<A NAME="package_description"><!-- --></A><H2>
Package org.eclipse.jst.jsf.core.jsfappconfig Description
</H2>
<P>
Project-level support for JSF application configuration files.
<p><b>Provisional API - subject to change</b></p>
<P>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/core/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/core/jsflibraryconfiguration/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/jst/jsf/core/jsfappconfig/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>