/
RoutesFilter.html
300 lines (230 loc) · 11.1 KB
/
RoutesFilter.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->
<html>
<head>
<!-- Generated by groovydoc (1.7.6) on Wed Jan 12 01:11:33 CET 2011 -->
<title>RoutesFilter (Gaelyk 0.6.1)</title>
<meta name="date" content="2011-01-12">
<link href="../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="../../../groovy.ico" type="image/x-icon" rel="icon">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RoutesFilter (Gaelyk 0.6.1)";
}
}
</script>
<noscript>
</noscript>
</head><body onload="windowTitle();" bgcolor="white">
<hr>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<!--<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
-->
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Groovy Documentation</b>
</EM></TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><!--<FONT SIZE="-2">
<A HREF="../../../groovy/lang/ExpandoMetaClass.ExpandoMetaProperty.html" title="class in groovy.lang"><B>PREV CLASS</B></A>
<A HREF="../../../groovy/lang/GroovyClassLoader.html" title="class in groovy.lang"><B>NEXT CLASS</B></A></FONT>--></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?groovyx/gaelyk/routes/RoutesFilter.html" target="_top"><B>FRAMES</B></A>
<A HREF="RoutesFilter.html" target="_top"><B>NO FRAMES</B></A>
<script type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-frame.html"><B>All Classes</B></A>');
}
//-->
</script>
<noscript>
<A HREF="../../../allclasses-frame.html"><B>All Classes</B></A>
</noscript>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
groovyx.gaelyk.routes</FONT>
<BR>
<span CLASS="ClassTitleFont">[Groovy] Class RoutesFilter</span></H2>
<pre><a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html' title='java.lang.Object'>java.lang.Object</a>
<img src='../../../inherit.gif'>groovyx.gaelyk.routes.RoutesFilter
</pre><dl><dt><b>All Implemented Interfaces:</b> </dt><dd><a href='../../../javax/servlet/Filter.html'>Filter</a></dd></dl><hr>
<PRE>class RoutesFilter
</PRE>
<P>
<code>RoutesFilter</code> is a Servlet Filter whose responsability is to define URL mappings for your
Gaelyk application. When the servlet filter is configured, a file named <code>routes.groovy</code>
will be loaded by the filter, defining the various routes a web request may follow.
<p>
It is possible to customize the location of the routes definition file by using the
<code>routes.location</code> init parameter in the declaration of the filter in <code>web.xml</code>.
<p>
In development mode, routes will be reloaded automatically on each request, but when the application
is deployed on the Google cloud, all the routes will be set in stone.
<DL><DT><B>Authors:</B></DT><DD>Guillaume Laforge</DD></DL>
</P>
<hr>
<!-- =========== NESTED CLASS SUMMARY =========== -->
<A NAME="nested_summary"><!-- --></A>
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<A NAME="enum_constant_summary"><!-- --></A>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<!-- =========== PROPERTY SUMMARY =========== -->
<A NAME="property_summary"><!-- --></A>
<!-- =========== ELEMENT SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2" CLASS="ClassHeadingFont">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1" CLASS="ClassItemFont">
<CODE>void</CODE></FONT>
</TD>
<TD>
<CODE><b><a href="#destroy()">destroy</a></b>()</CODE>
<BR>
<P></P>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1" CLASS="ClassItemFont">
<CODE>void</CODE></FONT>
</TD>
<TD>
<CODE><b><a href="#doFilter(ServletRequest, ServletResponse, FilterChain)">doFilter</a></b>(<a href='../../../ServletRequest.html'>ServletRequest</a> servletRequest, <a href='../../../ServletResponse.html'>ServletResponse</a> servletResponse, <a href='../../../FilterChain.html'>FilterChain</a> filterChain)</CODE>
<BR>
<P>Forward or redirects requests to another URL if a matching route is defined.
</P>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1" CLASS="ClassItemFont">
<CODE>void</CODE></FONT>
</TD>
<TD>
<CODE><b><a href="#init(FilterConfig)">init</a></b>(<a href='../../../FilterConfig.html'>FilterConfig</a> filterConfig)</CODE>
<BR>
<P></P>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1" CLASS="ClassItemFont">
<CODE>void</CODE></FONT>
</TD>
<TD>
<CODE><b><a href="#loadRoutes()">loadRoutes</a></b>()</CODE>
<BR>
<P>Load the routes configuration</P>
</TD>
</TR>
</TABLE>
<table BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<tr CLASS="TableSubHeadingColor"><th ALIGN="left" COLSPAN="2">
<b>Methods inherited from class <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html' title='Object'>Object</a></b>
</th></tr>
<tr class="TableRowColor"><td colspan='2'><a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()' title='wait'>wait</a>, <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)' title='wait'>wait</a>, <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)' title='wait'>wait</a>, <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)' title='equals'>equals</a>, <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()' title='toString'>toString</a>, <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()' title='hashCode'>hashCode</a>, <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()' title='getClass'>getClass</a>, <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()' title='notify'>notify</a>, <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()' title='notifyAll'>notifyAll</a></td></tr>
</table>
<P>
<!-- ============ ENUM CONSTANT DETAIL ========== -->
<A NAME="enum_constant_detail"><!-- --></A>
<!-- =========== FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<!-- =========== PROPERTY DETAIL =========== -->
<A NAME="prop_detail"><!-- --></A>
<!-- =========== ELEMENT DETAIL =========== -->
<A NAME="element_detail"><!-- --></A>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>void <B>destroy</B>()</PRE>
<DL>
<DD>
</DD>
<P>
</DL>
<HR>
<A NAME="doFilter(ServletRequest, ServletResponse, FilterChain)"><!-- --></A><H3>
doFilter</H3>
<PRE>void <B>doFilter</B>(<a href='../../../ServletRequest.html'>ServletRequest</a> servletRequest, <a href='../../../ServletResponse.html'>ServletResponse</a> servletResponse, <a href='../../../FilterChain.html'>FilterChain</a> filterChain)</PRE>
<DL>
<DD> Forward or redirects requests to another URL if a matching route is defined.
Otherwise, the normal filter chain and routing applies.
</DD>
<P>
</DL>
<HR>
<A NAME="init(FilterConfig)"><!-- --></A><H3>
init</H3>
<PRE>void <B>init</B>(<a href='../../../FilterConfig.html'>FilterConfig</a> filterConfig)</PRE>
<DL>
<DD>
</DD>
<P>
</DL>
<HR>
<A NAME="loadRoutes()"><!-- --></A><H3>
loadRoutes</H3>
<PRE>void <B>loadRoutes</B>()</PRE>
<DL>
<DD> Load the routes configuration
</DD>
<P>
</DL>
<HR>
<!-- ========= END OF CLASS DATA ========= -->
<p>Groovy Documentation</p>
<hr>
</body>
</html>