root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Moved REST Etag filter to MVC chapter 

git-svn-id: https://src.springframework.org/svn/spring-framework/trunk@1390 50f2f4bb-b051-0410-bef5-90022cba6387
This commit is contained in:
Arjen Poutsma 2009-06-16 14:37:57 +00:00
parent 90379c5172
commit dbca532155
1 changed files with 187 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

143
spring-framework-reference/src/mvc.xml
View File

@ -1550,15 +1550,15 @@ public class MyFormController {
<section id="mvc-handlermapping"> <section id="mvc-handlermapping">
<title>Handler mappings</title> <title>Handler mappings</title>
<para>In previous versions of Spring MVC, users were required to define <interfacename>HandlerMapping</interfacename>s in <para>In previous versions of Spring MVC, users were required to define
the web application context <interfacename>HandlerMapping</interfacename>s in the web application
to map incoming web requests to context to map incoming web requests to appropriate handlers. With the
appropriate handlers. With the introduction of Spring 2.5, the <classname>DispatcherServlet</classname> enables the introduction of Spring 2.5, the <classname>DispatcherServlet</classname>
<classname>DefaultAnnotationHandlerMapping</classname>, which looks for enables the <classname>DefaultAnnotationHandlerMapping</classname>, which
<interfacename>@RequestMapping</interfacename> annotations on <interfacename>@Controllers</interfacename>. looks for <interfacename>@RequestMapping</interfacename> annotations on
Typically, you do not need to override this default mapping, except when overriding the properties. <interfacename>@Controllers</interfacename>. Typically, you do not need to
These properties are: override this default mapping, except when overriding the properties.
</para> These properties are:</para>
<itemizedlist spacing="compact"> <itemizedlist spacing="compact">
<listitem> <listitem>
@ -1615,16 +1615,17 @@ public class MyFormController {
subclasses of subclasses of
<classname>org.springframework.web.servlet.handler.AbstractUrlHandlerMapping</classname></emphasis>).</para> <classname>org.springframework.web.servlet.handler.AbstractUrlHandlerMapping</classname></emphasis>).</para>
<para>The following example shows how to override the default mapping, and add an interceptor:</para> <para>The following example shows how to override the default mapping, and
add an interceptor:</para>
<programlisting language="xml"><![CDATA[<beans> <programlisting language="xml">&lt;beans&gt;
<bean id="handlerMapping" class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"> &lt;bean id="handlerMapping" class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"&gt;
<property name="interceptors"> &lt;property name="interceptors"&gt;
<bean class="example.MyInterceptor"/> &lt;bean class="example.MyInterceptor"/&gt;
</property> &lt;/property&gt;
</bean> &lt;/bean&gt;
<beans>]]></programlisting> &lt;beans&gt;</programlisting>
<section id="mvc-handlermapping-interceptor"> <section id="mvc-handlermapping-interceptor">
<title>Intercepting requests - the <title>Intercepting requests - the
@ -1841,10 +1842,11 @@ public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter {
<row> <row>
<entry><classname>ContentNegotiatingViewResolver</classname></entry> <entry><classname>ContentNegotiatingViewResolver</classname></entry>
<entry>An implementation of the <interfacename>ViewResolver</interfacename> <entry>An implementation of the
interface that that resolves a view based on the request file name or <literal>Accept</literal> header. <interfacename>ViewResolver</interfacename> interface that that
See <xref linkend="mvc-multiple-representations"/>. resolves a view based on the request file name or
</entry> <literal>Accept</literal> header. See <xref
linkend="mvc-multiple-representations" />.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
@ -2071,11 +2073,10 @@ public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter {
<section id="mvc-multiple-representations"> <section id="mvc-multiple-representations">
<title><classname>ContentNegotiatingViewResolver</classname></title> <title><classname>ContentNegotiatingViewResolver</classname></title>
<para>The <classname>ContentNegotiatingViewResolver</classname> <para>The <classname>ContentNegotiatingViewResolver</classname> does not
does not resolve views itself, but rather delegates to other resolve views itself, but rather delegates to other view resolvers,
view resolvers, selecting the view that resembles the representation selecting the view that resembles the representation requested by the
requested by the client. client. There are two strategies for a client to inform the server of
There are two strategies for a client to inform the server of
the representation it is interested in receiving.</para> the representation it is interested in receiving.</para>
<para>The first strategy is to use a distinct URI for each resource. <para>The first strategy is to use a distinct URI for each resource.
@ -2142,26 +2143,26 @@ public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter {
<para>Here is an example configuration of a <para>Here is an example configuration of a
<classname>ContentNegotiatingViewResolver</classname></para> <classname>ContentNegotiatingViewResolver</classname></para>
<programlisting language="xml"><![CDATA[<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver"> <programlisting language="xml">&lt;bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver"&gt;
<property name="mediaTypes"> &lt;property name="mediaTypes"&gt;
<map> &lt;map&gt;
<entry key="atom" value="application/atom+xml"/> &lt;entry key="atom" value="application/atom+xml"/&gt;
<entry key="html" value="text/html"/> &lt;entry key="html" value="text/html"/&gt;
</map> &lt;/map&gt;
</property> &lt;/property&gt;
<property name="viewResolvers"> &lt;property name="viewResolvers"&gt;
<list> &lt;list&gt;
<bean class="org.springframework.web.servlet.view.BeanNameViewResolver"/> &lt;bean class="org.springframework.web.servlet.view.BeanNameViewResolver"/&gt;
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> &lt;bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"&gt;
<property name="prefix" value="/WEB-INF/jsp/"/> &lt;property name="prefix" value="/WEB-INF/jsp/"/&gt;
<property name="suffix" value=".jsp"/> &lt;property name="suffix" value=".jsp"/&gt;
</bean> &lt;/bean&gt;
</list> &lt;/list&gt;
</property> &lt;/property&gt;
</bean> &lt;/bean&gt;
<bean id="content" class="com.springsource.samples.rest.SampleContentAtomView"/>]]></programlisting> &lt;bean id="content" class="com.springsource.samples.rest.SampleContentAtomView"/&gt;</programlisting>
<para>The <classname>InternalResourceViewResolver</classname> handles <para>The <classname>InternalResourceViewResolver</classname> handles
the translation of view names and JSP pages while the the translation of view names and JSP pages while the
@ -2214,9 +2215,7 @@ public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter {
} }
}</programlisting> }</programlisting>
</section> </section>
</section> </section>
<section id="mvc-localeresolver"> <section id="mvc-localeresolver">
@ -2813,9 +2812,11 @@ public class FileUploadBean {
<section id="mvc-ann-exceptionhandler"> <section id="mvc-ann-exceptionhandler">
<title><interfacename>@ExceptionResolver</interfacename></title> <title><interfacename>@ExceptionResolver</interfacename></title>
<para>As an alternative to implementing the <interfacename>HandlerExceptionResolver</interfacename>, you <para>As an alternative to implementing the
can use the <interfacename>@ExceptionHandler</interfacename>. The <classname>@ExceptionHandler</classname> method annotation is <interfacename>HandlerExceptionResolver</interfacename>, you can use the
used within a controller to specify which method will be invoked when an <interfacename>@ExceptionHandler</interfacename>. The
<classname>@ExceptionHandler</classname> method annotation is used
within a controller to specify which method will be invoked when an
exception of a specific type is thrown during the execution of exception of a specific type is thrown during the execution of
controller methods. For example</para> controller methods. For example</para>
@ -2851,7 +2852,6 @@ public class SimpleController {
<classname>ModelAndView</classname> object. Please refer to the API <classname>ModelAndView</classname> object. Please refer to the API
documentation for more details.</para> documentation for more details.</para>
</section> </section>
</section> </section>
<section id="mvc-coc"> <section id="mvc-coc">
@ -3189,6 +3189,49 @@ public class SimpleController {
</section> </section>
</section> </section>
<section id="mvc-etag">
<title>ETag support</title>
<para>An <ulink url="http://en.wikipedia.org/wiki/HTTP_ETag">ETag</ulink>
(entity tag) is an HTTP response header returned by an HTTP/1.1 compliant
web server used to determine change in content at a given URL. It can be
considered to be the more sophisticated successor to the
<literal>Last-Modified</literal> header. When a server returns a
representation with an ETag header, the client can use this header in
subsequent GETs, in an <literal>If-None-Match</literal> header. If the
content has not changed, the server will return <literal>304: Not
Modified</literal>.</para>
<para>Support for ETags is provided by the servlet filter
<classname>ShallowEtagHeaderFilter</classname>. Since it is a plain
Servlet Filter, and thus can be used in combination with any web
framework. The <classname>ShallowEtagHeaderFilter</classname> filter
creates so-called shallow ETags (as opposed to deep ETags, more about that
later). The way it works is quite simple: the filter simply caches the
content of the rendered JSP (or other content), generates an MD5 hash over
that, and returns that as an ETag header in the response. The next time a
client sends a request for the same resource, it uses that hash as the
<literal>If-None-Match</literal> value. The filter notices this, renders
the view again, and compares the two hashes. If they are equal, a
<literal>304</literal> is returned. It is important to note that this
filter will not save processing power, as the view is still rendered. The
only thing it saves is bandwidth, as the rendered response is not sent
back over the wire.</para>
<para>You configure the <classname>ShallowEtagHeaderFilter</classname> in
<filename>web.xml</filename>:</para>
<programlisting language="xml">&lt;filter&gt;
&lt;filter-name&gt;etagFilter&lt;/filter-name&gt;
&lt;filter-class&gt;org.springframework.web.filter.ShallowEtagHeaderFilter&lt;/filter-class&gt;
&lt;/filter&gt;
&lt;filter-mapping&gt;
&lt;filter-name&gt;etagFilter&lt;/filter-name&gt;
&lt;servlet-name&gt;petclinic&lt;/servlet-name&gt;
&lt;/filter-mapping&gt;</programlisting>
</section>
<section id="mvc-resources"> <section id="mvc-resources">
<title>Further Resources</title> <title>Further Resources</title>