You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tiles.apache.org by nl...@apache.org on 2012/08/09 01:22:18 UTC
svn commit: r1371015 - in /tiles/request/trunk:
tiles-request-api/src/main/java/org/apache/tiles/request/
tiles-request-api/src/test/java/org/apache/tiles/request/
tiles-request-freemarker/src/test/java/org/apache/tiles/request/freemarker/
tiles-reques...
Author: nlebas
Date: Wed Aug 8 23:22:18 2012
New Revision: 1371015
URL: http://svn.apache.org/viewvc?rev=1371015&view=rev
Log:
documented request & application scopes as mandatory, declared constants for them
Modified:
tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/AbstractRequest.java
tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/Request.java
tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractClientRequestTest.java
tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractRequestTest.java
tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractViewRequestTest.java
tiles/request/trunk/tiles-request-freemarker/src/test/java/org/apache/tiles/request/freemarker/FreemarkerRequestTest.java
tiles/request/trunk/tiles-request-jsp/src/main/java/org/apache/tiles/request/jsp/JspRequest.java
tiles/request/trunk/tiles-request-mustache/src/test/java/org/apache/tiles/request/mustache/MustacheRendererTest.java
tiles/request/trunk/tiles-request-portlet/src/main/java/org/apache/tiles/request/portlet/PortletRequest.java
tiles/request/trunk/tiles-request-servlet/src/main/java/org/apache/tiles/request/servlet/ServletRequest.java
Modified: tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/AbstractRequest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/AbstractRequest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/AbstractRequest.java (original)
+++ tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/AbstractRequest.java Wed Aug 8 23:22:18 2012
@@ -41,7 +41,7 @@ public abstract class AbstractRequest im
* will be included and never forwarded.
*/
protected void setForceInclude(boolean forceInclude) {
- getContext("request").put(FORCE_INCLUDE_ATTRIBUTE_NAME, forceInclude);
+ getContext(REQUEST_SCOPE).put(FORCE_INCLUDE_ATTRIBUTE_NAME, forceInclude);
}
/**
@@ -51,7 +51,7 @@ public abstract class AbstractRequest im
* @return <code>true</code> if inclusion is forced.
*/
protected boolean isForceInclude() {
- Boolean forceInclude = (Boolean) getContext("request").get(
+ Boolean forceInclude = (Boolean) getContext(REQUEST_SCOPE).get(
FORCE_INCLUDE_ATTRIBUTE_NAME);
if (forceInclude != null) {
return forceInclude;
Modified: tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/Request.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/Request.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/Request.java (original)
+++ tiles/request/trunk/tiles-request-api/src/main/java/org/apache/tiles/request/Request.java Wed Aug 8 23:22:18 2012
@@ -38,6 +38,12 @@ import org.apache.tiles.request.attribut
*/
public interface Request {
+ /** the name of the (mandatory) "application" scope */
+ static String APPLICATION_SCOPE = "application";
+
+ /** the name of the "request" context */
+ static String REQUEST_SCOPE = "request";
+
/**
* Return an immutable Map that maps header names to the first (or only)
* header value (as a String).
@@ -64,6 +70,9 @@ public interface Request {
/**
* Returns a context map, given the scope name.
+ * This method always return a map for all the scope names returned by
+ * getAvailableScopes(). That map may be writable, or immutable, depending
+ * on the implementation.
*
* @param scope The name of the scope.
* @return The context.
@@ -71,8 +80,12 @@ public interface Request {
Map<String, Object> getContext(String scope);
/**
- * Returns all available scopes, that are the ones returned by
- * {@link #getNativeScopes()} plus derivative scopes (e.g. flash scope).
+ * Returns all available scopes.
+ * The scopes are ordered according to their lifetime,
+ * the innermost, shorter lived scope appears first,
+ * and the outermost, longer lived scope appears last.
+ * Besides, the scopes "request" and "application" always included
+ * in the list.
*
* @return All the available scopes.
*/
Modified: tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractClientRequestTest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractClientRequestTest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractClientRequestTest.java (original)
+++ tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractClientRequestTest.java Wed Aug 8 23:22:18 2012
@@ -74,7 +74,7 @@ public class AbstractClientRequestTest {
public void testDispatch() throws IOException {
Map<String, Object> requestScope = new HashMap<String, Object>();
- expect(request.getContext("request")).andReturn(requestScope).anyTimes();
+ expect(request.getContext(Request.REQUEST_SCOPE)).andReturn(requestScope).anyTimes();
request.doForward("/my/path.html");
request.doInclude("/my/path2.html");
@@ -92,12 +92,12 @@ public class AbstractClientRequestTest {
public void testInclude() throws IOException {
Map<String, Object> requestScope = new HashMap<String, Object>();
- expect(request.getContext("request")).andReturn(requestScope).anyTimes();
+ expect(request.getContext(Request.REQUEST_SCOPE)).andReturn(requestScope).anyTimes();
request.doInclude("/my/path2.html");
replay(request, applicationContext);
request.include("/my/path2.html");
- assertTrue((Boolean)request.getContext("request").get(AbstractRequest.FORCE_INCLUDE_ATTRIBUTE_NAME));
+ assertTrue((Boolean)request.getContext(Request.REQUEST_SCOPE).get(AbstractRequest.FORCE_INCLUDE_ATTRIBUTE_NAME));
verify(request, applicationContext);
}
Modified: tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractRequestTest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractRequestTest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractRequestTest.java (original)
+++ tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractRequestTest.java Wed Aug 8 23:22:18 2012
@@ -43,7 +43,7 @@ public class AbstractRequestTest {
AbstractRequest request = createMockBuilder(AbstractRequest.class).createMock();
Map<String, Object> scope = new HashMap<String, Object>();
- expect(request.getContext("request")).andReturn(scope).anyTimes();
+ expect(request.getContext(Request.REQUEST_SCOPE)).andReturn(scope).anyTimes();
replay(request);
assertFalse(request.isForceInclude());
Modified: tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractViewRequestTest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractViewRequestTest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractViewRequestTest.java (original)
+++ tiles/request/trunk/tiles-request-api/src/test/java/org/apache/tiles/request/AbstractViewRequestTest.java Wed Aug 8 23:22:18 2012
@@ -80,7 +80,7 @@ public class AbstractViewRequestTest {
public void testDispatch() throws IOException {
Map<String, Object> requestScope = new HashMap<String, Object>();
- expect(request.getContext("request")).andReturn(requestScope);
+ expect(request.getContext(Request.REQUEST_SCOPE)).andReturn(requestScope);
wrappedRequest.include("/my/path.html");
replay(wrappedRequest, request, applicationContext);
@@ -97,7 +97,7 @@ public class AbstractViewRequestTest {
public void testInclude() throws IOException {
Map<String, Object> requestScope = new HashMap<String, Object>();
- expect(request.getContext("request")).andReturn(requestScope);
+ expect(request.getContext(Request.REQUEST_SCOPE)).andReturn(requestScope);
wrappedRequest.include("/my/path.html");
replay(wrappedRequest, request, applicationContext);
Modified: tiles/request/trunk/tiles-request-freemarker/src/test/java/org/apache/tiles/request/freemarker/FreemarkerRequestTest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-freemarker/src/test/java/org/apache/tiles/request/freemarker/FreemarkerRequestTest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-freemarker/src/test/java/org/apache/tiles/request/freemarker/FreemarkerRequestTest.java (original)
+++ tiles/request/trunk/tiles-request-freemarker/src/test/java/org/apache/tiles/request/freemarker/FreemarkerRequestTest.java Wed Aug 8 23:22:18 2012
@@ -36,6 +36,7 @@ import javax.servlet.http.HttpServletReq
import javax.servlet.http.HttpServletResponse;
import org.apache.tiles.request.ApplicationContext;
+import org.apache.tiles.request.Request;
import org.apache.tiles.request.DispatchRequest;
import org.apache.tiles.request.servlet.ServletRequest;
import org.junit.Before;
@@ -136,7 +137,7 @@ public class FreemarkerRequestTest {
enclosedRequest.include(path);
expect(enclosedRequest.getAvailableScopes()).andReturn(Collections.singletonList("parent"));
- expect(enclosedRequest.getContext("request")).andReturn(requestScope);
+ expect(enclosedRequest.getContext(Request.REQUEST_SCOPE)).andReturn(requestScope);
replay(enclosedRequest, applicationContext);
context = new FreemarkerRequest(enclosedRequest, env);
context.dispatch(path);
Modified: tiles/request/trunk/tiles-request-jsp/src/main/java/org/apache/tiles/request/jsp/JspRequest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-jsp/src/main/java/org/apache/tiles/request/jsp/JspRequest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-jsp/src/main/java/org/apache/tiles/request/jsp/JspRequest.java (original)
+++ tiles/request/trunk/tiles-request-jsp/src/main/java/org/apache/tiles/request/jsp/JspRequest.java Wed Aug 8 23:22:18 2012
@@ -54,7 +54,7 @@ public class JspRequest extends Abstract
* The native available scopes.
*/
private static final List<String> SCOPES
- = Collections.unmodifiableList(Arrays.asList("page", "request", "session", "application"));
+ = Collections.unmodifiableList(Arrays.asList("page", REQUEST_SCOPE, "session", APPLICATION_SCOPE));
/**
* The current page context.
@@ -203,11 +203,11 @@ public class JspRequest extends Abstract
public Map<String, Object> getContext(String scope) {
if("page".equals(scope)){
return getPageScope();
- }else if("request".equals(scope)){
+ }else if(REQUEST_SCOPE.equals(scope)){
return getRequestScope();
}else if("session".equals(scope)){
return getSessionScope();
- }else if("application".equals(scope)){
+ }else if(APPLICATION_SCOPE.equals(scope)){
return getApplicationScope();
}
throw new IllegalArgumentException(scope + " does not exist. Call getAvailableScopes() first to check.");
Modified: tiles/request/trunk/tiles-request-mustache/src/test/java/org/apache/tiles/request/mustache/MustacheRendererTest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-mustache/src/test/java/org/apache/tiles/request/mustache/MustacheRendererTest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-mustache/src/test/java/org/apache/tiles/request/mustache/MustacheRendererTest.java (original)
+++ tiles/request/trunk/tiles-request-mustache/src/test/java/org/apache/tiles/request/mustache/MustacheRendererTest.java Wed Aug 8 23:22:18 2012
@@ -63,10 +63,10 @@ public final class MustacheRendererTest
expect(request.getApplicationContext()).andReturn(applicationContext);
expect(applicationContext.getResource(isA(String.class))).andReturn(applicationResource).anyTimes();
- expect(request.getAvailableScopes()).andReturn(Arrays.asList("request", "session", "application"));
- expect(request.getContext("request")).andReturn(context);
+ expect(request.getAvailableScopes()).andReturn(Arrays.asList(Request.REQUEST_SCOPE, "session", Request.APPLICATION_SCOPE));
+ expect(request.getContext(Request.REQUEST_SCOPE)).andReturn(context);
expect(request.getContext("session")).andReturn(Collections.<String,Object>emptyMap());
- expect(request.getContext("application")).andReturn(Collections.<String,Object>emptyMap());
+ expect(request.getContext(Request.APPLICATION_SCOPE)).andReturn(Collections.<String,Object>emptyMap());
expect(request.getWriter()).andReturn(writer);
writer.write("test template with test value");
writer.flush();
Modified: tiles/request/trunk/tiles-request-portlet/src/main/java/org/apache/tiles/request/portlet/PortletRequest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-portlet/src/main/java/org/apache/tiles/request/portlet/PortletRequest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-portlet/src/main/java/org/apache/tiles/request/portlet/PortletRequest.java (original)
+++ tiles/request/trunk/tiles-request-portlet/src/main/java/org/apache/tiles/request/portlet/PortletRequest.java Wed Aug 8 23:22:18 2012
@@ -59,7 +59,7 @@ public class PortletRequest extends Abst
* The native available scopes.
*/
private static final List<String> SCOPES
- = Collections.unmodifiableList(Arrays.asList("request", "portletSession", "session", "application"));
+ = Collections.unmodifiableList(Arrays.asList(REQUEST_SCOPE, "portletSession", "session", APPLICATION_SCOPE));
/**
* <p>The lazily instantiated <code>Map</code> of header name-value
@@ -323,13 +323,13 @@ public class PortletRequest extends Abst
@Override
public Map<String, Object> getContext(String scope) {
- if("request".equals(scope)){
+ if(REQUEST_SCOPE.equals(scope)){
return getRequestScope();
- }else if("application".equals(scope)){
- return getApplicationScope();
+ }else if("session".equals(scope)){
+ return getSessionScope();
}else if("portletSession".equals(scope)){
return getPortletSessionScope();
- }else if("application".equals(scope)){
+ }else if(APPLICATION_SCOPE.equals(scope)){
return getApplicationScope();
}
throw new IllegalArgumentException(scope + " does not exist. Call getAvailableScopes() first to check.");
Modified: tiles/request/trunk/tiles-request-servlet/src/main/java/org/apache/tiles/request/servlet/ServletRequest.java
URL: http://svn.apache.org/viewvc/tiles/request/trunk/tiles-request-servlet/src/main/java/org/apache/tiles/request/servlet/ServletRequest.java?rev=1371015&r1=1371014&r2=1371015&view=diff
==============================================================================
--- tiles/request/trunk/tiles-request-servlet/src/main/java/org/apache/tiles/request/servlet/ServletRequest.java (original)
+++ tiles/request/trunk/tiles-request-servlet/src/main/java/org/apache/tiles/request/servlet/ServletRequest.java Wed Aug 8 23:22:18 2012
@@ -57,7 +57,7 @@ public class ServletRequest extends Abst
* The native available scopes: request, session and application.
*/
private static final List<String> SCOPES
- = Collections.unmodifiableList(Arrays.asList("request", "session", "application"));
+ = Collections.unmodifiableList(Arrays.asList(REQUEST_SCOPE, "session", APPLICATION_SCOPE));
/**
* The request object to use.
@@ -184,11 +184,11 @@ public class ServletRequest extends Abst
@Override
public Map<String, Object> getContext(String scope) {
- if("request".equals(scope)){
+ if(REQUEST_SCOPE.equals(scope)){
return getRequestScope();
}else if("session".equals(scope)){
return getSessionScope();
- }else if("application".equals(scope)){
+ }else if(APPLICATION_SCOPE.equals(scope)){
return getApplicationScope();
}
throw new IllegalArgumentException(scope + " does not exist. Call getAvailableScopes() first to check.");