svn commit: r628469 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/jsf/RequestParameterFacesContextFactory.java

[sk...@apache.org]

Author: skitching
Date: Sun Feb 17 02:29:32 2008
New Revision: 628469

URL: http://svn.apache.org/viewvc?rev=628469&view=rev
Log:
Doc changes only

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/jsf/RequestParameterFacesContextFactory.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/jsf/RequestParameterFacesContextFactory.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/jsf/RequestParameterFacesContextFactory.java?rev=628469&r1=628468&r2=628469&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/jsf/RequestParameterFacesContextFactory.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/jsf/RequestParameterFacesContextFactory.java Sun Feb 17 02:29:32 2008
@@ -29,7 +29,7 @@
 import javax.servlet.http.HttpServletResponse;
 
 /**
- * Ensure that a custom wrapper is put aroung the HttpServletResponse so that encodeURL can be 
+ * Ensure that a custom wrapper is put around the HttpServletResponse so that encodeURL can be 
  * intercepted and modified.
  * <p>
  * There is a servlet filter (RequestParameterServletFilter) that does this in the obvious way, but
@@ -49,6 +49,12 @@
 		this.original = original;
 	}
 
+	/**
+	 * Invokes the getFacesContext method on the original factory in order to return a
+	 * perfectly normal FacesContext instance. However the ServletResponse object passed
+	 * to that FacesContext instance is a modified one that tweaks every url that is
+	 * processed by the ServletResponse.encodeUrl method.
+	 */
 	public FacesContext getFacesContext(Object context, Object request, Object response, Lifecycle lifecycle) throws FacesException
 	{
 		if (response instanceof HttpServletResponse)