Revision: 591
http://svn.sourceforge.net/stripes/?rev=591&view=rev
Author: bengunter
Date: 2007-07-22 20:48:03 -0700 (Sun, 22 Jul 2007)
Log Message:
-----------
Added javadoc comments describing the use of clean URLs
Modified Paths:
--------------
trunk/stripes/src/net/sourceforge/stripes/action/UrlBinding.java
Modified: trunk/stripes/src/net/sourceforge/stripes/action/UrlBinding.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/action/UrlBinding.java
2007-07-23 02:58:20 UTC (rev 590)
+++ trunk/stripes/src/net/sourceforge/stripes/action/UrlBinding.java
2007-07-23 03:48:03 UTC (rev 591)
@@ -21,10 +21,29 @@
import java.lang.annotation.ElementType;
/**
- * Annotation used to bind ActionBean classes to a specific path within the
web appliction.
+ * <p>
+ * Annotation used to bind ActionBean classes to a specific path within the
web application.
* The AnnotatedClassActionResolver will examine the URL submitted and extract
the section
* that is relative to the web-app root. That will be compared with the URL
specified in
* the UrlBinding annotation, to find the ActionBean that should process the
chosen request.
+ * </p>
+ * <p>
+ * Stripes supports "Clean URLs" through the [EMAIL PROTECTED] UrlBinding}
annotation. Parameters may
+ * be embedded in the URL by placing the parameter name inside braces ({}).
For example,
+ * <code>@UrlBinding("/foo/{bar}/{baz}")</code> maps the action to "/foo" and
indicates
+ * that the "bar" and "baz" parameters may be embedded in the URL. In this
case, the URL
+ * /foo/abc/123 would invoke the action with bar set to "abc" and baz set to
"123". The
+ * literal strings between parameters can be any string.
+ * </p>
+ * <p>
+ * The special parameter name $event may be used to embed the event name in a
clean URL.
+ * For example, given <code>@UrlBinding("/foo/{$event}")</code> the "bar"
event could be
+ * invoked with the URL /foo/bar.
+ * </p>
+ * <p>
+ * Any number of parameters and/or literals may be excluded from the end of a
request URL.
+ * The missing parameters will simply be null when the request is dispatched.
+ * </p>
*
* @author Tim Fennell
*/
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Stripes-development mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/stripes-development
