You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by jd...@apache.org on 2009/12/26 09:25:04 UTC

svn commit: r893948 - in /wicket/trunk/wicket/src: main/java/org/apache/wicket/ng/ main/java/org/apache/wicket/ng/mock/ main/java/org/apache/wicket/ng/protocol/http/ test/java/org/apache/wicket/ng/test/

Author: jdonnerstag
Date: Sat Dec 26 08:25:04 2009
New Revision: 893948

URL: http://svn.apache.org/viewvc?rev=893948&view=rev
Log:
javadocs

Modified:
    wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/ThreadContext.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/mock/WicketTester.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/BufferedWebResponse.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/WicketFilter.java
    wicket/trunk/wicket/src/test/java/org/apache/wicket/ng/test/TestPageRender.java

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/ThreadContext.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/ThreadContext.java?rev=893948&r1=893947&r2=893948&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/ThreadContext.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/ThreadContext.java Sat Dec 26 08:25:04 2009
@@ -26,11 +26,6 @@
  */
 public class ThreadContext
 {
-	private ThreadContext()
-	{
-
-	}
-
 	private Application application;
 
 	private RequestCycle requestCycle;
@@ -39,6 +34,11 @@
 
 	private static ThreadLocal<ThreadContext> threadLocal = new ThreadLocal<ThreadContext>();
 
+	/**
+	 * 
+	 * @param createIfDoesNotExist
+	 * @return
+	 */
 	private static ThreadContext get(boolean createIfDoesNotExist)
 	{
 		ThreadContext context = threadLocal.get();
@@ -111,19 +111,11 @@
 	}
 
 	/**
-	 * Cleans the thread local state.
-	 */
-	public static void detach()
-	{
-		threadLocal.remove();
-	}
-
-	/**
 	 * Cleans the {@link ThreadContext} and returns previous context.
 	 * 
 	 * @return old {@link ThreadContext}
 	 */
-	public static ThreadContext getAndClean()
+	public static ThreadContext detach()
 	{
 		ThreadContext value = threadLocal.get();
 		threadLocal.remove();
@@ -134,10 +126,17 @@
 	 * Restores the context
 	 * 
 	 * @param threadContext
-	 * @see #getAndClean()
+	 * @see #detach()
 	 */
 	public static void restore(ThreadContext threadContext)
 	{
 		threadLocal.set(threadContext);
 	}
+
+	/**
+	 * Construct.
+	 */
+	private ThreadContext()
+	{
+	}
 }

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/mock/WicketTester.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/mock/WicketTester.java?rev=893948&r1=893947&r2=893948&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/mock/WicketTester.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/mock/WicketTester.java Sat Dec 26 08:25:04 2009
@@ -62,7 +62,7 @@
 	 */
 	public WicketTester()
 	{
-		oldThreadContext = ThreadContext.getAndClean();
+		oldThreadContext = ThreadContext.detach();
 
 		application = new MockApplication();
 		application.setName("WicketTesterApplication");

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/BufferedWebResponse.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/BufferedWebResponse.java?rev=893948&r1=893947&r2=893948&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/BufferedWebResponse.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/BufferedWebResponse.java Sat Dec 26 08:25:04 2009
@@ -40,6 +40,33 @@
  */
 public class BufferedWebResponse extends WebResponse
 {
+	private final List<CookieEntry> cookieEntries = new ArrayList<CookieEntry>();
+
+	private Long contentLength;
+
+	private String contentType;
+
+	private final Map<String, Long> dateHeaders = new HashMap<String, Long>();
+
+	private final Map<String, String> headers = new HashMap<String, String>();
+
+	private StringBuilder builder;
+
+	private ByteArrayOutputStream stream;
+
+	private String redirectUrl;
+
+	private Integer statusCode;
+
+	/**
+	 * 
+	 */
+	private static class CookieEntry
+	{
+		Cookie cookie;
+		boolean add;
+	}
+
 	/**
 	 * Construct.
 	 */
@@ -47,20 +74,19 @@
 	{
 	}
 
+	/**
+	 * Construct.
+	 * 
+	 * @param httpServletResponse
+	 */
 	public BufferedWebResponse(HttpServletResponse httpServletResponse)
 	{
 		super(httpServletResponse);
 	}
 
-
-	private static class CookieEntry
-	{
-		Cookie cookie;
-		boolean add;
-	}
-
-	private final List<CookieEntry> cookieEntries = new ArrayList<CookieEntry>();
-
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#addCookie(javax.servlet.http.Cookie)
+	 */
 	@Override
 	public void addCookie(Cookie cookie)
 	{
@@ -70,6 +96,9 @@
 		cookieEntries.add(entry);
 	}
 
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#clearCookie(javax.servlet.http.Cookie)
+	 */
 	@Override
 	public void clearCookie(Cookie cookie)
 	{
@@ -79,41 +108,46 @@
 		cookieEntries.add(entry);
 	}
 
-	private Long contentLength = null;
-
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#setContentLength(long)
+	 */
 	@Override
 	public void setContentLength(long length)
 	{
 		contentLength = length;
 	}
 
-	private String contentType = null;
-
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#setContentType(java.lang.String)
+	 */
 	@Override
 	public void setContentType(String mimeType)
 	{
 		contentType = mimeType;
 	}
 
-	private final Map<String, Long> dateHeaders = new HashMap<String, Long>();
-
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#setDateHeader(java.lang.String, long)
+	 */
 	@Override
 	public void setDateHeader(String name, long date)
 	{
 		dateHeaders.put(name, date);
 	}
 
-	private final Map<String, String> headers = new HashMap<String, String>();
-
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#setHeader(java.lang.String,
+	 *      java.lang.String)
+	 */
 	@Override
 	public void setHeader(String name, String value)
 	{
 		headers.put(name, value);
 	}
 
-	private StringBuilder builder;
-	private ByteArrayOutputStream stream;
-
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#write(java.lang.CharSequence)
+	 */
 	@Override
 	public void write(CharSequence sequence)
 	{
@@ -131,6 +165,9 @@
 		builder.append(sequence);
 	}
 
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#write(byte[])
+	 */
 	@Override
 	public void write(byte[] array)
 	{
@@ -153,16 +190,18 @@
 		}
 	}
 
-	private String redirectUrl = null;
-
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#redirect(java.lang.String)
+	 */
 	@Override
 	public void redirect(String url)
 	{
 		redirectUrl = url;
 	}
 
-	private Integer statusCode = null;
-
+	/**
+	 * @see org.apache.wicket.protocol.http.WebResponse#setStatus(int)
+	 */
 	@Override
 	public void setStatus(int sc)
 	{
@@ -265,5 +304,4 @@
 				filter(new AppendingStringBuffer(builder.toString())).toString());
 		}
 	}
-
 }

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/WicketFilter.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/WicketFilter.java?rev=893948&r1=893947&r2=893948&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/WicketFilter.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/ng/protocol/http/WicketFilter.java Sat Dec 26 08:25:04 2009
@@ -65,16 +65,22 @@
  */
 public class WicketFilter implements Filter
 {
-	/**
-	 * The name of the root path parameter that specifies the root dir of the app.
-	 */
+	private static final Logger log = LoggerFactory.getLogger(WicketFilter.class);
+
+	/** The name of the root path parameter that specifies the root dir of the app. */
 	public static final String FILTER_MAPPING_PARAM = "filterMappingUrlPattern";
 
-	/**
-	 * The name of the context parameter that specifies application factory class
-	 */
+	/** The name of the context parameter that specifies application factory class */
 	public static final String APP_FACT_PARAM = "applicationFactoryClassName";
 
+	private WebApplication webApplication;
+
+	private FilterConfig filterConfig;
+
+	private String filterPath;
+
+	private final boolean servletMode = false;
+
 	/**
 	 * Checks if the request is for home page and lacks trailing slash. If necessary redirects to
 	 * URL with trailing slash.
@@ -122,6 +128,10 @@
 		return true;
 	}
 
+	/**
+	 * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest,
+	 *      javax.servlet.ServletResponse, javax.servlet.FilterChain)
+	 */
 	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
 		throws IOException, ServletException
 	{
@@ -141,7 +151,6 @@
 
 				RequestCycle requestCycle = webApplication.createRequestCycle(req, resp);
 
-
 				if (!requestCycle.processRequestAndDetach())
 				{
 					chain.doFilter(request, response);
@@ -154,8 +163,6 @@
 		}
 	}
 
-	private WebApplication webApplication;
-
 	/**
 	 * Creates the web application factory instance.
 	 * 
@@ -211,6 +218,9 @@
 		}
 	}
 
+	/**
+	 * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
+	 */
 	public void init(FilterConfig filterConfig) throws ServletException
 	{
 		this.filterConfig = filterConfig;
@@ -240,6 +250,9 @@
 		return filterConfig;
 	}
 
+	/**
+	 * 
+	 */
 	private void initFilterPath()
 	{
 		InputStream is = filterConfig.getServletContext().getResourceAsStream("/WEB-INF/web.xml");
@@ -268,114 +281,13 @@
 		}
 	};
 
-	private FilterConfig filterConfig;
-	private String filterPath;
-
-	private final boolean servletMode = false;
-
-	// private String getFilterPath(String filterName, InputStream is) throws ServletException
-	// {
-	// String prefix = servletMode ? "servlet" : "filter";
-	// String mapping = prefix + "-mapping";
-	// String name = prefix + "-name";
-	//
-	// // Filter mappings look like this:
-	// //
-	// // <filter-mapping> <filter-name>WicketFilter</filter-name>
-	// // <url-pattern>/*</url-pattern> <...> <filter-mapping>
-	// try
-	// {
-	// ArrayList<String> urlPatterns = new ArrayList<String>();
-	// XmlPullParser parser = new XmlPullParser();
-	// parser.parse(is);
-	//
-	// while (true)
-	// {
-	// XmlTag elem;
-	// do
-	// {
-	// elem = (XmlTag)parser.nextTag();
-	// }
-	// while (elem != null && (!(elem.getName().equals(mapping) && elem.isOpen())));
-	//
-	// if (elem == null)
-	// {
-	// break;
-	// }
-	//
-	// String encounteredFilterName = null, urlPattern = null;
-	//
-	// do
-	// {
-	// elem = (XmlTag)parser.nextTag();
-	// if (elem.isOpen())
-	// {
-	// parser.setPositionMarker();
-	// }
-	// else if (elem.isClose() && elem.getName().equals(name))
-	// {
-	// encounteredFilterName = parser.getInputFromPositionMarker(elem.getPos())
-	// .toString()
-	// .trim();
-	// }
-	// else if (elem.isClose() && elem.getName().equals("url-pattern"))
-	// {
-	// urlPattern = parser.getInputFromPositionMarker(elem.getPos())
-	// .toString()
-	// .trim();
-	// }
-	// }
-	// while (urlPattern == null || encounteredFilterName == null);
-	//
-	// if (filterName.equals(encounteredFilterName))
-	// {
-	// urlPatterns.add(urlPattern);
-	// }
-	// }
-	//
-	// String prefixUppered = Character.toUpperCase(prefix.charAt(0)) + prefix.substring(1);
-	//
-	// // By the time we get here, we have a list of urlPatterns we match
-	// // this filter against.
-	// // In all likelihood, we will only have one. If we have none, we
-	// // have an error.
-	// // If we have more than one, we pick the first one to use for any
-	// // 302 redirects that require absolute URLs.
-	// if (urlPatterns.size() == 0)
-	// {
-	// throw new IllegalArgumentException("Error initializing Wicket" + prefixUppered +
-	// " - you have no <" + mapping + "> element with a url-pattern that uses " +
-	// prefix + ": " + filterName);
-	// }
-	// String urlPattern = urlPatterns.get(0);
-	//
-	// // Check for leading '/' and trailing '*'.
-	// if (!urlPattern.startsWith("/") || !urlPattern.endsWith("*"))
-	// {
-	// throw new IllegalArgumentException("<" + mapping + "> for Wicket" + prefixUppered +
-	// " \"" + filterName + "\" must start with '/' and end with '*'.");
-	// }
-	//
-	// // Strip trailing '*' and keep leading '/'.
-	// return stripWildcard(urlPattern);
-	// }
-	// catch (IOException e)
-	// {
-	// throw new ServletException("Error finding <" + prefix + "> " + filterName +
-	// " in web.xml", e);
-	// }
-	// catch (ParseException e)
-	// {
-	// throw new ServletException("Error finding <" + prefix + "> " + filterName +
-	// " in web.xml", e);
-	// }
-	// catch (ResourceStreamNotFoundException e)
-	// {
-	// throw new ServletException("Error finding <" + prefix + "> " + filterName +
-	// " in web.xml", e);
-	// }
-	// }
-
+	/**
+	 * 
+	 * @param filterName
+	 * @param name
+	 * @param node
+	 * @return
+	 */
 	private String getFilterPath(String filterName, String name, Node node)
 	{
 		String foundUrlPattern = null;
@@ -403,6 +315,14 @@
 		}
 	}
 
+	/**
+	 * 
+	 * @param filterName
+	 * @param mapping
+	 * @param name
+	 * @param nodeList
+	 * @return
+	 */
 	private String getFilterPath(String filterName, String mapping, String name, NodeList nodeList)
 	{
 		for (int i = 0; i < nodeList.getLength(); ++i)
@@ -428,6 +348,13 @@
 		return null;
 	}
 
+	/**
+	 * 
+	 * @param filterName
+	 * @param is
+	 * @return
+	 * @throws ServletException
+	 */
 	private String getFilterPath(String filterName, InputStream is) throws ServletException
 	{
 		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
@@ -449,6 +376,11 @@
 		}
 	}
 
+	/**
+	 * 
+	 * @param request
+	 * @return
+	 */
 	protected String getFilterPath(HttpServletRequest request)
 	{
 		if (filterPath != null)
@@ -487,6 +419,9 @@
 		return result.substring(1, result.length() - 1);
 	}
 
+	/**
+	 * @see javax.servlet.Filter#destroy()
+	 */
 	public void destroy()
 	{
 		if (webApplication != null)
@@ -495,6 +430,4 @@
 			webApplication = null;
 		}
 	}
-
-	private static final Logger log = LoggerFactory.getLogger(WicketFilter.class);
 }

Modified: wicket/trunk/wicket/src/test/java/org/apache/wicket/ng/test/TestPageRender.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/test/java/org/apache/wicket/ng/test/TestPageRender.java?rev=893948&r1=893947&r2=893948&view=diff
==============================================================================
--- wicket/trunk/wicket/src/test/java/org/apache/wicket/ng/test/TestPageRender.java (original)
+++ wicket/trunk/wicket/src/test/java/org/apache/wicket/ng/test/TestPageRender.java Sat Dec 26 08:25:04 2009
@@ -65,7 +65,7 @@
 	public void testRender1()
 	{
 		// Store current ThreadContext
-		ThreadContext context = ThreadContext.getAndClean();
+		ThreadContext context = ThreadContext.detach();
 
 		// Create MockApplication
 		MockApplication app = new MockApplication();