You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by lu...@apache.org on 2011/08/29 06:30:49 UTC
svn commit: r1162644 - in /myfaces/core/branches/2.0.x:
impl/src/main/java/org/apache/myfaces/application/
impl/src/main/java/org/apache/myfaces/config/
impl/src/main/java/org/apache/myfaces/config/annotation/
impl/src/main/java/org/apache/myfaces/el/u...
Author: lu4242
Date: Mon Aug 29 04:30:48 2011
New Revision: 1162644
URL: http://svn.apache.org/viewvc?rev=1162644&view=rev
Log:
update web config param documentation
Modified:
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/application/ApplicationImpl.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/FacesConfigValidator.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultLifecycleProviderFactory.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/renderkit/ErrorPageWriter.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/resource/InternalClassLoaderResourceLoader.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderFactory.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderWrapper.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProvider.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProviderFactory.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProvider.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProviderFactory.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProvider.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProviderWrapper.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/ServiceProviderFinderFactory.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/WebConfigProvider.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java
myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/webapp/FacesInitializerFactory.java
myfaces/core/branches/2.0.x/impl/src/main/resources/META-INF/xdoc-web-config.vm
myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java
myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java
myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/context/flash/FlashImpl.java
myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/BaseResourceHandlerSupport.java
myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/ResourceHandlerCache.java
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/application/ApplicationImpl.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/application/ApplicationImpl.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/application/ApplicationImpl.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/application/ApplicationImpl.java Mon Aug 29 04:30:48 2011
@@ -131,15 +131,26 @@ public class ApplicationImpl extends App
@Deprecated
public final static String MYFACES_PROJECT_STAGE_SYSTEM_PROPERTY_NAME = "org.apache.myfaces.PROJECT_STAGE";
+ /**
+ * Set the default timezone as system timezone when a converter extending from DateTimeConverter is created.
+ */
@JSFWebConfigParam(defaultValue="false", expectedValues="true, false", since="2.0")
public final static String DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE_PARAM_NAME
= "javax.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE";
+ /**
+ * Indicate the stage of the initialized application.
+ */
@JSFWebConfigParam(defaultValue="Production",
expectedValues="Development, Production, SystemTest, UnitTest",
since="2.0")
private static final String PROJECT_STAGE_PARAM_NAME = "javax.faces.PROJECT_STAGE";
+ /**
+ * Indicate if the classes associated to components, converters, validators or behaviors
+ * should be loaded as soon as they are added to the current application instance or instead
+ * loaded in a lazy way.
+ */
@JSFWebConfigParam(defaultValue="true",since="2.0")
private static final String LAZY_LOAD_CONFIG_OBJECTS_PARAM_NAME = "org.apache.myfaces.LAZY_LOAD_CONFIG_OBJECTS";
private static final boolean LAZY_LOAD_CONFIG_OBJECTS_DEFAULT_VALUE = true;
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/FacesConfigValidator.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/FacesConfigValidator.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/FacesConfigValidator.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/FacesConfigValidator.java Mon Aug 29 04:30:48 2011
@@ -35,6 +35,12 @@ import org.apache.myfaces.shared.util.Cl
public class FacesConfigValidator
{
+ /**
+ * Validate if the managed beans and navigations rules are correct.
+ *
+ * <p>For example, it checks if the managed bean classes really exists, or if the
+ * navigation rules points to existing view files.</p>
+ */
@JSFWebConfigParam(since="2.0", defaultValue="false", expectedValues="true, false")
public static final String VALIDATE_CONTEXT_PARAM = "org.apache.myfaces.VALIDATE";
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultLifecycleProviderFactory.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultLifecycleProviderFactory.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultLifecycleProviderFactory.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultLifecycleProviderFactory.java Mon Aug 29 04:30:48 2011
@@ -18,7 +18,6 @@
*/
package org.apache.myfaces.config.annotation;
-import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.security.AccessController;
import java.security.PrivilegedActionException;
@@ -45,6 +44,12 @@ public class DefaultLifecycleProviderFac
//private static Log log = LogFactory.getLog(DefaultLifecycleProviderFactory.class);
private static Logger log = Logger.getLogger(DefaultLifecycleProviderFactory.class.getName());
+ /**
+ * Define the class implementing LifecycleProvider2 interface to handle PostConstruct and PreDestroy annotations.
+ *
+ * <p>This also can be configured using a SPI entry (/META-INF/services/...).
+ * </p>
+ */
public static final String LIFECYCLE_PROVIDER_INSTANCE_KEY = LifecycleProvider.class.getName() + ".LIFECYCLE_PROVIDER_INSTANCE";
@JSFWebConfigParam(name="org.apache.myfaces.config.annotation.LifecycleProvider", since="1.1")
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java Mon Aug 29 04:30:48 2011
@@ -43,6 +43,13 @@ public class ResolverBuilderBase
private static final Logger log = Logger.getLogger(ResolverBuilderBase.class.getName());
+ /**
+ * Define a custom comparator class used to sort the ELResolvers.
+ *
+ * <p>This is useful when it is necessary to put an ELResolver on top of other resolvers. Note set
+ * this param override the default ordering described by JSF spec section 5.
+ * </p>
+ */
@JSFWebConfigParam(since = "1.2.10, 2.0.2",
desc = "The Class of an Comparator<ELResolver> implementation.")
public static final String EL_RESOLVER_COMPARATOR = "org.apache.myfaces.EL_RESOLVER_COMPARATOR";
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/renderkit/ErrorPageWriter.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/renderkit/ErrorPageWriter.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/renderkit/ErrorPageWriter.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/renderkit/ErrorPageWriter.java Mon Aug 29 04:30:48 2011
@@ -195,6 +195,13 @@ public final class ErrorPageWriter
private static final String ERROR_TEMPLATE = "META-INF/rsc/myfaces-dev-error.xml";
+ /**
+ * Indicate the template name used to render the default error page used by MyFaces specific
+ * error handler implementation.
+ *
+ * <p>See org.apache.myfaces.ERROR_HANDLING for details about
+ * how to enable/disable it.</p>
+ */
@JSFWebConfigParam(defaultValue="META-INF/rsc/myfaces-dev-error.xml", since="1.2.4")
private static final String ERROR_TEMPLATE_RESOURCE = "org.apache.myfaces.ERROR_TEMPLATE_RESOURCE";
@@ -202,6 +209,9 @@ public final class ErrorPageWriter
private static final String DEBUG_TEMPLATE = "META-INF/rsc/myfaces-dev-debug.xml";
+ /**
+ * Indicate the template name used to render the default debug page (see ui:debug tag).
+ */
@JSFWebConfigParam(defaultValue="META-INF/rsc/myfaces-dev-debug.xml", since="1.2.4")
private static final String DEBUG_TEMPLATE_RESOURCE = "org.apache.myfaces.DEBUG_TEMPLATE_RESOURCE";
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/resource/InternalClassLoaderResourceLoader.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/resource/InternalClassLoaderResourceLoader.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/resource/InternalClassLoaderResourceLoader.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/resource/InternalClassLoaderResourceLoader.java Mon Aug 29 04:30:48 2011
@@ -42,7 +42,7 @@ public class InternalClassLoaderResource
* If this param is true and the project stage is development mode,
* the source javascript files will be loaded separately instead have
* all in just one file, to preserve line numbers and make javascript
- * debugging of jsf.js more simple.
+ * debugging of the default jsf javascript file more simple.
*/
@JSFWebConfigParam(since="2.0.1",defaultValue="false",expectedValues="true,false")
public static final String USE_MULTIPLE_JS_FILES_FOR_JSF_UNCOMPRESSED_JS = "org.apache.myfaces.USE_MULTIPLE_JS_FILES_FOR_JSF_UNCOMPRESSED_JS";
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderFactory.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderFactory.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderFactory.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderFactory.java Mon Aug 29 04:30:48 2011
@@ -28,6 +28,7 @@ import org.apache.myfaces.spi.impl.Defau
import org.apache.myfaces.spi.impl.SpiUtils;
/**
+ * Factory that provide AnnotationProvider instances
*
* @since 2.0.2
* @author Leonardo Uribe
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderWrapper.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderWrapper.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderWrapper.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/AnnotationProviderWrapper.java Mon Aug 29 04:30:48 2011
@@ -29,6 +29,8 @@ import javax.faces.FacesWrapper;
import javax.faces.context.ExternalContext;
/**
+ * Wrapper class that all AnnotationProvider instances should extend. This is used
+ * to wrap the default algorithm and add some additional custom processing.
*
* @since 2.0.3
* @author Leonardo Uribe
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProvider.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProvider.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProvider.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProvider.java Mon Aug 29 04:30:48 2011
@@ -25,6 +25,11 @@ import java.util.Collection;
import javax.faces.context.ExternalContext;
/**
+ * Locate facelet taglib xml files through classpath. These
+ * files has definitions that are used by facelets algorithm to parse view files.
+ * <p>
+ * By default it locate all files inside META-INF folder, ending with .taglib.xml
+ * </p>
*
* @since 2.0.2
* @author Leonardo Uribe
@@ -33,6 +38,8 @@ public abstract class FaceletConfigResou
{
/**
+ * Return a list of urls pointing to valid facelet taglib xml files. These
+ * files will be parsed later and used by facelets algorithm.
*
* @param context
* @return
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProviderFactory.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProviderFactory.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProviderFactory.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FaceletConfigResourceProviderFactory.java Mon Aug 29 04:30:48 2011
@@ -28,6 +28,7 @@ import org.apache.myfaces.spi.impl.Defau
import org.apache.myfaces.spi.impl.SpiUtils;
/**
+ * Factory that provide FaceletConfigResourceProvider instances
*
* @since 2.0.2
* @author Leonardo Uribe
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProvider.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProvider.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProvider.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProvider.java Mon Aug 29 04:30:48 2011
@@ -25,6 +25,12 @@ import java.util.Collection;
import javax.faces.context.ExternalContext;
/**
+ * Locate faces-config xml files through classpath. These
+ * files has definitions that are used by initialize jsf environment.
+ * <p>
+ * By default it locate all files inside META-INF folder, named faces-config.xml
+ * or ending with .faces-config.xml
+ * </p>
*
* @since 2.0.2
* @author Leonardo Uribe
@@ -33,6 +39,8 @@ public abstract class FacesConfigResourc
{
/**
+ * Return a list of urls pointing to valid faces config-xml files. These
+ * files will be parsed later and used initialize jsf environment.
*
* @param context
* @return
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProviderFactory.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProviderFactory.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProviderFactory.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigResourceProviderFactory.java Mon Aug 29 04:30:48 2011
@@ -28,6 +28,7 @@ import org.apache.myfaces.spi.impl.Defau
import org.apache.myfaces.spi.impl.SpiUtils;
/**
+ * Factory that provide FacesConfigResourceProvider instances
*
* @since 2.0.2
* @author Leonardo Uribe
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProvider.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProvider.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProvider.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProvider.java Mon Aug 29 04:30:48 2011
@@ -33,7 +33,8 @@ import org.apache.myfaces.config.element
* is started.
*
* <p>To wrap the default FacesConfigurationProvider, use a constructor like
- * CustomFacesConfigurationProvider(FacesConfigurationProvider fcp)</p>
+ * CustomFacesConfigurationProvider(FacesConfigurationProvider fcp)
+ * and extend it from FacesConfigurationProviderWrapper</p>
*
* @author Leonardo Uribe
* @since 2.0.3
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProviderWrapper.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProviderWrapper.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProviderWrapper.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/FacesConfigurationProviderWrapper.java Mon Aug 29 04:30:48 2011
@@ -27,6 +27,9 @@ import org.apache.myfaces.config.element
import org.apache.myfaces.config.element.FacesConfigData;
/**
+ * To wrap the default FacesConfigurationProvider, use a constructor like
+ * CustomFacesConfigurationProvider(FacesConfigurationProvider fcp)
+ * and extend it from FacesConfigurationProviderWrapper
*
* @author Leonardo Uribe
* @since 2.0.3
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/ServiceProviderFinderFactory.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/ServiceProviderFinderFactory.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/ServiceProviderFinderFactory.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/ServiceProviderFinderFactory.java Mon Aug 29 04:30:48 2011
@@ -27,6 +27,8 @@ import org.apache.myfaces.shared.util.Cl
import org.apache.myfaces.spi.impl.DefaultServiceProviderFinder;
/**
+ * Factory that provide a ServiceProviderFinder instance, that is used to locate
+ * classes through SPI interface.
*
* @author Leonardo Uribe
* @since 2.0.3
@@ -37,6 +39,13 @@ public class ServiceProviderFinderFactor
private final static String SERVICE_PROVIDER_KEY = "org.apache.myfaces.spi.ServiceProviderFinder";
+ /**
+ * Define the class name of a custom ServiceProviderFinder implementation.
+ *
+ * <p>This class is used to override the default SPI scanning algorithm, that relies on the thread
+ * context class loader to locate entries under META-INF/services folder.
+ * </p>
+ */
@JSFWebConfigParam(since = "2.0.3", desc = "Class name of a custom ServiceProviderFinder implementation.")
private static final String SERVICE_PROVIDER_FINDER_PARAM = "org.apache.myfaces.SERVICE_PROVIDER_FINDER";
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/WebConfigProvider.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/WebConfigProvider.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/WebConfigProvider.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/spi/WebConfigProvider.java Mon Aug 29 04:30:48 2011
@@ -23,7 +23,7 @@ import java.util.List;
import javax.faces.context.ExternalContext;
/**
- * SPI to provide a custom WebXml implementation.
+ * SPI to provide a custom WebConfigProvider implementation.
*
* @author Leonardo Uribe
* @since 2.0.3
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/view/facelets/FaceletViewDeclarationLanguage.java Mon Aug 29 04:30:48 2011
@@ -153,9 +153,18 @@ public class FaceletViewDeclarationLangu
//public final static String PARAM_BUFFER_SIZE = "javax.faces.FACELETS_BUFFER_SIZE";
- @JSFWebConfigParam(since="2.0")
+ /**
+ * Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in a
+ * servlet environment to HttpServletResponse.setBufferSize().
+ */
+ @JSFWebConfigParam(since="2.0",
+ desc="Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in a servlet environment to HttpServletResponse.setBufferSize()")
public final static String PARAM_BUFFER_SIZE = "javax.faces.FACELETS_BUFFER_SIZE";
+ /**
+ * Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in a
+ * servlet environment to HttpServletResponse.setBufferSize().
+ */
@JSFWebConfigParam(since="2.0")
private final static String PARAM_BUFFER_SIZE_DEPRECATED = "facelets.BUFFER_SIZE";
@@ -163,9 +172,17 @@ public class FaceletViewDeclarationLangu
//private final static String PARAM_BUILD_BEFORE_RESTORE = "facelets.BUILD_BEFORE_RESTORE";
+ /**
+ * Set of class names, separated by ';', implementing TagDecorator interface, used to transform
+ * a view definition in a facelet abstract syntax tree, that is used later to generate a component tree.
+ */
@JSFWebConfigParam(since="2.0")
public final static String PARAM_DECORATORS = "javax.faces.FACELETS_DECORATORS";
+ /**
+ * Set of class names, separated by ';', implementing TagDecorator interface, used to transform
+ * a view definition in a facelet abstract syntax tree, that is used later to generate a component tree.
+ */
@JSFWebConfigParam(since="2.0")
private final static String PARAM_DECORATORS_DEPRECATED = "facelets.DECORATORS";
@@ -177,33 +194,61 @@ public class FaceletViewDeclarationLangu
*/
public final static String PARAM_ENCODING = "facelets.Encoding";
- @JSFWebConfigParam(since="2.0")
+ /**
+ * Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.
+ */
+ @JSFWebConfigParam(since="2.0", desc="Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.")
public final static String PARAM_LIBRARIES = "javax.faces.FACELETS_LIBRARIES";
- @JSFWebConfigParam(since="2.0")
+ /**
+ * Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.
+ */
+ @JSFWebConfigParam(since="2.0", desc="Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.")
private final static String PARAM_LIBRARIES_DEPRECATED = "facelets.LIBRARIES";
private final static String[] PARAMS_LIBRARIES = {PARAM_LIBRARIES, PARAM_LIBRARIES_DEPRECATED};
- @JSFWebConfigParam(since="2.0")
+ /**
+ * Define the period used to refresh the facelet abstract syntax tree from the view definition file.
+ *
+ * <p>By default is infinite (no active).</p>
+ */
+ @JSFWebConfigParam(since="2.0", defaultValue="-1")
public final static String PARAM_REFRESH_PERIOD = "javax.faces.FACELETS_REFRESH_PERIOD";
- @JSFWebConfigParam(since="2.0")
+ /**
+ * Define the period used to refresh the facelet abstract syntax tree from the view definition file.
+ *
+ * <p>By default is infinite (no active).</p>
+ */
+ @JSFWebConfigParam(since="2.0", defaultValue="-1")
private final static String PARAM_REFRESH_PERIOD_DEPRECATED = "facelets.REFRESH_PERIOD";
private final static String[] PARAMS_REFRESH_PERIOD = {PARAM_REFRESH_PERIOD, PARAM_REFRESH_PERIOD_DEPRECATED};
+ /**
+ * Class implementing ResourceResolver interface used to locate facelet resources.
+ */
@JSFWebConfigParam(since="2.0")
public final static String PARAM_RESOURCE_RESOLVER = "javax.faces.FACELETS_RESOURCE_RESOLVER";
+ /**
+ * Class implementing ResourceResolver interface used to locate facelet resources.
+ */
@JSFWebConfigParam(since="2.0")
private final static String PARAM_RESOURCE_RESOLVER_DEPRECATED = "facelets.RESOURCE_RESOLVER";
private final static String[] PARAMS_RESOURCE_RESOLVER = {PARAM_RESOURCE_RESOLVER, PARAM_RESOURCE_RESOLVER_DEPRECATED};
+ /**
+ * Skip comments found on a facelet file.
+ */
@JSFWebConfigParam(since="2.0")
public final static String PARAM_SKIP_COMMENTS = "javax.faces.FACELETS_SKIP_COMMENTS";
+ /**
+ * Skip comments found on a facelet file.
+ */
@JSFWebConfigParam(since="2.0")
private final static String PARAM_SKIP_COMMENTS_DEPRECATED = "facelets.SKIP_COMMENTS";
Modified: myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/webapp/FacesInitializerFactory.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/webapp/FacesInitializerFactory.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/webapp/FacesInitializerFactory.java (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/java/org/apache/myfaces/webapp/FacesInitializerFactory.java Mon Aug 29 04:30:48 2011
@@ -34,7 +34,15 @@ import org.apache.myfaces.util.Container
*/
public class FacesInitializerFactory
{
-
+
+ /**
+ * Indicate the class implementing FacesInitializer interface that will
+ * be used to setup MyFaces Core contexts.
+ * <p>This is used when some custom task must be done specifically when
+ * a myfaces web context is initialized or destroyed, or when MyFaces should
+ * be initialized in some custom environment.
+ * </p>
+ */
@JSFWebConfigParam(since = "2.0.1", desc = "Class name of a custom FacesInitializer implementation.")
private static final String FACES_INITIALIZER_PARAM = "org.apache.myfaces.FACES_INITIALIZER";
Modified: myfaces/core/branches/2.0.x/impl/src/main/resources/META-INF/xdoc-web-config.vm
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/impl/src/main/resources/META-INF/xdoc-web-config.vm?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/impl/src/main/resources/META-INF/xdoc-web-config.vm (original)
+++ myfaces/core/branches/2.0.x/impl/src/main/resources/META-INF/xdoc-web-config.vm Mon Aug 29 04:30:48 2011
@@ -63,6 +63,8 @@ $baseContent
#end
#if ($webConfigParam.description)
<td>$webConfigParam.description</td>
+#elseif ($webConfigParam.longDescription)
+ <td>$webConfigParam.longDescription</td>
#else
<td></td>
#end
@@ -141,11 +143,11 @@ $baseContent
<br/>
#end
#if ($webConfigParam.sourceClassName.startsWith("javax.faces."))
-#set ($javadocPath = "../../myfaces-api/apidocs/" + $webConfigParam.sourceClassName.replace('.', '/') )
+#set ($javadocPath = "../myfaces-api/xref/" + $webConfigParam.sourceClassName.replace('.', '/') )
#elseif ($webConfigParam.sourceClassName.startsWith("org.apache.myfaces.shared."))
-#set ($javadocPath = "../../myfaces-impl-shared/apidocs/" + $webConfigParam.sourceClassName.replace('.', '/') )
+#set ($javadocPath = "../myfaces-impl-shared/xref/" + $webConfigParam.sourceClassName.replace('.', '/') )
#else
-#set ($javadocPath = "../apidocs/" + $webConfigParam.sourceClassName.replace('.', '/') )
+#set ($javadocPath = "./xref/" + $webConfigParam.sourceClassName.replace('.', '/') )
#end
<b>Source Class:</b> <a href="${javadocPath}.html">$webConfigParam.sourceClassName</a>
<br/>
@@ -153,6 +155,10 @@ $baseContent
<b>Description:</b>
<br/>
$webConfigParam.longDescription
+#elseif ($webConfigParam.description)
+ <b>Description:</b>
+ <br/>
+ $webConfigParam.description
#else
<b>Description:</b> no description available yet.
<br/>
@@ -166,4 +172,4 @@ $baseContent
</section>
</body>
-</document>
\ No newline at end of file
+</document>
Modified: myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java (original)
+++ myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java Mon Aug 29 04:30:48 2011
@@ -54,7 +54,8 @@ public class DefaultViewHandlerSupport i
/**
* Controls the size of the cache used to "remember" if a view exists or not.
*/
- @JSFWebConfigParam(defaultValue = "500", since = "2.0.2")
+ @JSFWebConfigParam(defaultValue = "500", since = "2.0.2",
+ desc="Controls the size of the cache used to 'remember' if a view exists or not.")
private static final String CHECKED_VIEWID_CACHE_SIZE_ATTRIBUTE = "org.apache.myfaces.CHECKED_VIEWID_CACHE_SIZE";
private static final int CHECKED_VIEWID_CACHE_DEFAULT_SIZE = 500;
@@ -62,7 +63,8 @@ public class DefaultViewHandlerSupport i
* Enable or disable a cache used to "remember" if a view exists or not and reduce the impact of
* sucesive calls to ExternalContext.getResource().
*/
- @JSFWebConfigParam(defaultValue = "true", since = "2.0.2")
+ @JSFWebConfigParam(defaultValue = "true", since = "2.0.2",
+ desc="Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact of sucesive calls to ExternalContext.getResource().")
private static final String CHECKED_VIEWID_CACHE_ENABLED_ATTRIBUTE = "org.apache.myfaces.CHECKED_VIEWID_CACHE_ENABLED";
private static final boolean CHECKED_VIEWID_CACHE_ENABLED_DEFAULT = true;
Modified: myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java (original)
+++ myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java Mon Aug 29 04:30:48 2011
@@ -75,7 +75,7 @@ public class MyfacesConfig
private static final boolean INIT_PARAM_ALLOW_JAVASCRIPT_DEFAULT = true;
/**
- *
+ * Deprecated: tomahawk specific param to detect javascript, but it is no longer valid anymore.
*/
@JSFWebConfigParam(defaultValue="false", expectedValues="true,false",since="1.1")
private static final String INIT_PARAM_DETECT_JAVASCRIPT = "org.apache.myfaces.DETECT_JAVASCRIPT";
@@ -102,7 +102,8 @@ public class MyfacesConfig
* StreamingAddResource instead of DefaultAddResource if you want to
* gain performance.
*/
- @JSFWebConfigParam(defaultValue="org.apache.myfaces. renderkit.html.util. DefaultAddResource",since="1.1")
+ @JSFWebConfigParam(defaultValue="org.apache.myfaces. renderkit.html.util. DefaultAddResource",since="1.1",
+ desc="Tomahawk specific: Indicate the class responsible to place scripts and css using tomahawk AddResource API")
private static final String INIT_PARAM_ADD_RESOURCE_CLASS = "org.apache.myfaces.ADD_RESOURCE_CLASS";
private static final String INIT_PARAM_ADD_RESOURCE_CLASS_DEFAULT = "org.apache.myfaces.renderkit.html.util.DefaultAddResource";
@@ -118,42 +119,66 @@ public class MyfacesConfig
*
* In tomahawk for JSF 2.0 since version 1.1.11, this param is set by default to false, otherwise is true.
*/
- @JSFWebConfigParam(defaultValue="for JSF 2.0 since 1.1.11 false, otherwise true", expectedValues="true,false",since="1.1")
+ @JSFWebConfigParam(defaultValue="for JSF 2.0 since 1.1.11 false, otherwise true", expectedValues="true,false",since="1.1",
+ desc="Tomahawk specific: This parameter will check for a properly configured Extensions-Filter if it is needed by the web-app.")
private static final String INIT_CHECK_EXTENSIONS_FILTER = "org.apache.myfaces.CHECK_EXTENSIONS_FILTER";
private static final boolean INIT_CHECK_EXTENSIONS_FILTER_DEFAULT = false;
/**
- *
+ * Tomahawk specific: Interpret "readonly" property as "disable" for select components like t:selectOneRow.
*/
@JSFWebConfigParam(defaultValue="true", expectedValues="true,false",since="1.1")
private static final String INIT_READONLY_AS_DISABLED_FOR_SELECT = "org.apache.myfaces.READONLY_AS_DISABLED_FOR_SELECTS";
private static final boolean INIT_READONLY_AS_DISABLED_FOR_SELECT_DEFAULT = true;
/**
- *
+ * Set the time in seconds that check for updates of web.xml and faces-config descriptors and refresh the configuration.
+ * This param is valid only if project stage is not production. Set this param to 0 disable this feature.
*/
@JSFWebConfigParam(defaultValue="2",since="1.1")
public static final String INIT_PARAM_CONFIG_REFRESH_PERIOD = "org.apache.myfaces.CONFIG_REFRESH_PERIOD";
public static final long INIT_PARAM_CONFIG_REFRESH_PERIOD_DEFAULT = 2;
/**
- *
+ * Set the view state using a javascript function instead a hidden input field.
*/
@JSFWebConfigParam(defaultValue="false", expectedValues="true,false",since="1.1")
private static final String INIT_PARAM_VIEWSTATE_JAVASCRIPT = "org.apache.myfaces.VIEWSTATE_JAVASCRIPT";
private static final boolean INIT_PARAM_VIEWSTATE_JAVASCRIPT_DEFAULT = false;
/**
+ * Define if the input field that should store the state (javax.faces.ViewState) should render id="javax.faces.ViewState".
*
+ * JSF API 1.2 defines a "javax.faces.ViewState" client parameter, that must be rendered as both the "name"
+ * and the "id" attribute of the hidden input that is rendered for the purpose of state saving
+ * (see <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/javax/faces/render/ResponseStateManager.html#VIEW_STATE_PARAM">API</a>).
+ * Actually this causes duplicate id attributes and thus invalid XHTML pages when multiple forms are rendered on
+ * one page. With the org.apache.myfaces.RENDER_VIEWSTATE_ID context parameter you can tune this behaviour.
+ * <br/>Set it to
+ * <ul><li>true - to render JSF 1.2 compliant id attributes (that might cause invalid XHTML), or</li>
+ * <li>false - to omit rendering of the id attribute (which is only needed for very special AJAX/Javascript components)</li></ul>
+ * Default value is: true (for backwards compatibility and JSF 1.2 compliancy)
*/
@JSFWebConfigParam(defaultValue="true", expectedValues="true,false",since="1.1")
private static final String INIT_PARAM_RENDER_VIEWSTATE_ID = "org.apache.myfaces.RENDER_VIEWSTATE_ID";
private static final boolean INIT_PARAM_RENDER_VIEWSTATE_ID_DEFAULT = true;
/**
- *
+ * Use "&amp;" entity instead a plain "&" character within HTML.
+ * <p>W3C recommends to use the "&amp;" entity instead of a plain "&" character within HTML.
+ * This also applies to attribute values and thus to the "href" attribute of <a> elements as well.
+ * Even more, when XHTML is used as output the usage of plain "&" characters is forbidden and would lead to
+ * invalid XML code.
+ * Therefore, since version 1.1.6 MyFaces renders the correct "&amp;" entity for links.</p>
+ * <p>The init parameter
+ * org.apache.myfaces.STRICT_XHTML_LINKS makes it possible to restore the old behaviour and to make MyFaces
+ * "bug compatible" to the Sun RI which renders plain "&" chars in links as well.</p>
+ * <p>
+ * See: <a href="http://www.w3.org/TR/html401/charset.html#h-5.3.2">HTML 4.01 Specification</a>
+ * See: <a href="http://issues.apache.org/jira/browse/MYFACES-1774">Jira: MYFACES-1774</a>
+ * </p>
*/
- @JSFWebConfigParam(defaultValue="true", expectedValues="true,false",since="1.1")
+ @JSFWebConfigParam(defaultValue="true", expectedValues="true,false",since="1.1.6")
private static final String INIT_PARAM_STRICT_XHTML_LINKS = "org.apache.myfaces.STRICT_XHTML_LINKS";
private static final boolean INIT_PARAM_STRICT_XHTML_LINKS_DEFAULT = true;
@@ -186,7 +211,11 @@ public class MyfacesConfig
private static final boolean INIT_PARAM_SAVE_FORM_SUBMIT_LINK_IE_DEFAULT = false;
/**
+ * Define an alternate class name that will be used to initialize MyFaces, instead the default javax.faces.webapp.FacesServlet.
*
+ * <p>This helps MyFaces to detect the mappings and other additional configuration used to setup the environment, and prevent
+ * abort initialization if no FacesServlet config is detected.
+ * </p>
*/
@JSFWebConfigParam(since="1.2.7")
private static final String INIT_PARAM_DELEGATE_FACES_SERVLET = "org.apache.myfaces.DELEGATE_FACES_SERVLET";
Modified: myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/context/flash/FlashImpl.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/context/flash/FlashImpl.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/context/flash/FlashImpl.java (original)
+++ myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/context/flash/FlashImpl.java Mon Aug 29 04:30:48 2011
@@ -57,7 +57,9 @@ public class FlashImpl extends Flash
private static final Logger logger = Logger.getLogger(FlashImpl.class.getName());
/**
- * Defines whether flash scope is disabled.
+ * Defines whether flash scope is disabled, preventing add the Flash cookie to the response.
+ *
+ * <p>This is useful for applications that does not require to use flash scope, and instead uses other scopes.</p>
*/
@JSFWebConfigParam(defaultValue="false",since="2.0.5")
private static final String FLASH_SCOPE_DISABLED_PARAM = "org.apache.myfaces.FLASH_SCOPE_DISABLED";
Modified: myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/BaseResourceHandlerSupport.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/BaseResourceHandlerSupport.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/BaseResourceHandlerSupport.java (original)
+++ myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/BaseResourceHandlerSupport.java Mon Aug 29 04:30:48 2011
@@ -38,7 +38,7 @@ public class BaseResourceHandlerSupport
{
/**
- * Set the max time in miliseconds set on the "Expires" header for a resource.
+ * Set the max time in miliseconds set on the "Expires" header for a resource rendered by the default ResourceHandler.
* (default to one week in miliseconds or 604800000)
*/
@JSFWebConfigParam(since="2.0", defaultValue="604800000")
Modified: myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/ResourceHandlerCache.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/ResourceHandlerCache.java?rev=1162644&r1=1162643&r2=1162644&view=diff
==============================================================================
--- myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/ResourceHandlerCache.java (original)
+++ myfaces/core/branches/2.0.x/shared/src/main/java/org/apache/myfaces/shared/resource/ResourceHandlerCache.java Mon Aug 29 04:30:48 2011
@@ -38,10 +38,19 @@ public class ResourceHandlerCache
private Boolean _resourceCacheEnabled = null;
private Map<ResourceKey, ResourceValue> _resourceCacheMap = null;
+ /**
+ * Controls the size of the cache used to check if a resource exists or not.
+ *
+ * <p>See org.apache.myfaces.RESOURCE_HANDLER_CACHE_ENABLED for details.</p>
+ */
@JSFWebConfigParam(defaultValue = "500", since = "2.0.2")
private static final String RESOURCE_HANDLER_CACHE_SIZE_ATTRIBUTE = "org.apache.myfaces.RESOURCE_HANDLER_CACHE_SIZE";
private static final int RESOURCE_HANDLER_CACHE_DEFAULT_SIZE = 500;
+ /**
+ * Enable or disable the cache used to "remember" if a resource handled by the default ResourceHandler exists or not.
+ *
+ */
@JSFWebConfigParam(defaultValue = "true", since = "2.0.2")
private static final String RESOURCE_HANDLER_CACHE_ENABLED_ATTRIBUTE = "org.apache.myfaces.RESOURCE_HANDLER_CACHE_ENABLED";
private static final boolean RESOURCE_HANDLER_CACHE_ENABLED_DEFAULT = true;