[jboss-cvs] JBossAS SVN: r95726 - projects/docs/enterprise/5.0/RESTEasy/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Oct 29 00:00:21 EDT 2009
Author: laubai
Date: 2009-10-29 00:00:21 -0400 (Thu, 29 Oct 2009)
New Revision: 95726
Modified:
projects/docs/enterprise/5.0/RESTEasy/en-US/Async_job_service.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Atom.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Book_Info.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Cache_NoCache_CacheControl.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Content_Marshalling_Providers.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Installation_Configuration.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Interceptors.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Jaxb.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Json.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Maven_and_RESTEasy.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Migration_from_older_versions.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Multipart.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/RESTEasy_Client_Framework.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/RESTEasy_Spring_Integration.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Revision_History.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/Securing_JAX-RS_and_RESTeasy.xml
projects/docs/enterprise/5.0/RESTEasy/en-US/StringConverter.xml
Log:
Removed all CDATA tags.
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Async_job_service.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Async_job_service.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Async_job_service.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -72,7 +72,6 @@
The Asynchronous Job Service is not enabled by default, so you will need to enable it in your <filename>web.xml</filename>:
</para>
<programlisting>
-<![CDATA[
<web-app>
<!-- enable the Asynchronous Job Service -->
<context-param>
@@ -126,7 +125,6 @@
</servlet-mapping>
</web-app>
-]]>
</programlisting>
</section>
</chapter>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Atom.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Atom.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Atom.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -13,7 +13,7 @@
<para>
RESTEasy has defined a simple object model to represent Atom in Java, and uses JAXB to marshal and unmarshal it. The <literal>org.jboss.resteasy.plugins.providers.atom</literal> package contains the main classes: <classname>Feed</classname>, <classname>Entry</classname>, <classname>Content</classname>, and <classname>Link</classname>. Each class is annotated with JAXB annotations. The distribution also contains the JavaDocs for this project, which are very useful in learning the model. The following code is a simple example of sending an Atom feed with the RESTEasy API:
</para>
- <programlisting><![CDATA[
+ <programlisting>
import org.jboss.resteasy.plugins.providers.atom.Content;
import org.jboss.resteasy.plugins.providers.atom.Entry;
import org.jboss.resteasy.plugins.providers.atom.Feed;
@@ -48,7 +48,6 @@
return feed;
}
}
-]]>
</programlisting>
<para>RESTEasy's Atom provider is JAXB-based, so you are not limited to sending Atom objects with XML. You can automatically re-use RESTEasy's other JAXB providers (JSON and FastinfoSet). All you need to do is add <literal>+atom</literal> in front of the main subtype (that is, <code>@Produces("application/atom+json")</code> or <code>@Consumes("application/atom+fastinfoset")</code>.
</para>
@@ -58,8 +57,7 @@
<para>
The <classname>org.jboss.resteasy.plugins.providers.atom.Content</classname> class lets you marshal and unmarshal JAXB-annotated objects that form the body of an entry's content. The following code is an example of sending an <literal>Entry</literal> with a <literal>Customer</literal> object attached as the body of the entry's content.
</para>
- <programlisting><![CDATA[
- at XmlRootElement(namespace = "http://jboss.org/Customer")
+ <programlisting>@XmlRootElement(namespace = "http://jboss.org/Customer")
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer
{
@@ -96,16 +94,14 @@
entry.setContent(content);
return entry;
}
-}
-]]></programlisting>
+}</programlisting>
<para>
The <literal>Content.setJAXBObject()</literal> method tells the content object that you are returning a Java JAXB object to be marshalled. If you use a base format other than XML (for example, <literal>application/atom+json</literal>), the attached JAXB object will be marshalled into that format.
</para>
<para>
If your input is an Atom document, you can also extract JAXB objects from <literal>Content</literal> by using <code>Content.getJAXBObject(Class clazz)</code>. The code that follows is an example of extracting a <literal>Customer</literal> object from the <literal>Content</literal>:
</para>
- <programlisting><![CDATA[
- at Path("atom")
+ <programlisting>@Path("atom")
public static class AtomServer
{
@PUT
@@ -116,8 +112,7 @@
Content content = entry.getContent();
Customer cust = content.getJAXBObject(Customer.class);
}
-}
-]]></programlisting>
+}</programlisting>
</section>
<section id="Abdera">
@@ -132,8 +127,7 @@
<title>Abdera and Maven</title>
<para>The Abdera provider is not included with the RESTEasy distribution. To include the Abdera provider in your WAR archive's <filename>pom</filename> files, add the following. Remember to change the version in the code to the version of RESTEasy that you are working with.</para>
<warning><para>RESTEasy may not pick up the latest version of Abdera.</para></warning>
- <programlisting><![CDATA[
- <repository>
+ <programlisting><repository>
<id>jboss</id>
<url>http://repository.jboss.org/maven2</url>
</repository>
@@ -143,13 +137,11 @@
<groupId>org.jboss.resteasy</groupId>
<artifactId>abdera-atom-provider</artifactId>
<version>...version...</version>
- </dependency>
-]]></programlisting>
+ </dependency></programlisting>
</section>
<section id="using_abdera">
<title>Using the Abdera Provider</title>
- <programlisting><![CDATA[
-import org.apache.abdera.Abdera;
+ <programlisting>import org.apache.abdera.Abdera;
import org.apache.abdera.factory.Factory;
import org.apache.abdera.model.Entry;
import org.apache.abdera.model.Feed;
@@ -308,7 +300,6 @@
Assert.assertEquals(200, status);
}
}
-]]>
</programlisting>
</section>
</section>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Book_Info.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Book_Info.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Book_Info.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -8,7 +8,7 @@
<productname>JBoss Enterprise Application Platform</productname>
<productnumber>5.0</productnumber>
<edition>1</edition>
- <pubsnumber>3</pubsnumber>
+ <pubsnumber>4</pubsnumber>
<corpauthor>
<inlinemediaobject>
<imageobject>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Cache_NoCache_CacheControl.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Cache_NoCache_CacheControl.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Cache_NoCache_CacheControl.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -105,19 +105,16 @@
To set up the server-side cache with Maven, you must use the <literal>resteasy-cache-core</literal> artifact:
</para>
<programlisting>
-<![CDATA[
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-cache-core</artifactId>
<version>1.1.GA</version>
</dependency>
-]]>
</programlisting>
<para>
Next, add a <literal>ServletContextListener</literal>: <literal>org.jboss.resteasy.plugins.cache.server.ServletServerCache</literal>. You must specify this after the <literal>ResteasyBootstrap</literal> listener in your <filename>web.xml</filename> file.
</para>
<programlisting>
-<![CDATA[
<web-app>
<listener>
<listener-class>
@@ -154,7 +151,6 @@
</servlet-mapping>
</web-app>
-]]>
</programlisting>
<para>
The cache implementation is based on the <ulink url="http://jboss.org/jbosscache">JBoss Cache project</ulink>. You can set two <literal>context-param</literal> configuration variables: <literal>resteasy.server.cache.maxsize</literal> sets the number of elements that can be cached, and <literal>resteasy.server.cache.eviction.wakeup.interval</literal> sets the rate at which the background eviction thread runs to purge the cache of stale entries.
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Content_Marshalling_Providers.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Content_Marshalling_Providers.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Content_Marshalling_Providers.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -112,7 +112,6 @@
<literal>javax.ws.rs.ext.Providers</literal> is a simple injectable interface that lets you locate <literal>MessageBodyReader</literal>s, <literal>MessageBodyWriter</literal>s, <literal>ContextResolver</literal>s and <literal>ExceptionMapper</literal>s. It also lets you implement multi-part providers (content types that embed other content types).
</para>
<programlisting>
-<![CDATA[
public interface Providers
{
@@ -212,7 +211,6 @@
<T> ContextResolver<T> getContextResolver(Class<T> contextType,
MediaType mediaType);
}
-]]>
</programlisting>
<para>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Installation_Configuration.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Installation_Configuration.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Installation_Configuration.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -23,7 +23,6 @@
<para>
<programlisting>
- <![CDATA[
<web-app>
<display-name>Archetype Created Web Application</display-name>
<!-- Set this if you want Resteasy to scan for JAX-RS classes
@@ -60,7 +59,6 @@
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
-]]>
</programlisting>
</para>
<para>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Interceptors.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Interceptors.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Interceptors.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -39,7 +39,6 @@
To use an interceptor, implement the <literal>org.jbos.resteasy.spi.interception.MessageBodyReaderInterceptor</literal> or <literal>MessageBodyWriterInterceptor</literal>.
</para>
<programlisting>
-<![CDATA[
public interface MessageBodyReaderInterceptor
{
Object read(MessageBodyReaderContext context) throws IOException, WebApplicationException;
@@ -51,14 +50,11 @@
void write(MessageBodyWriterContext context) throws IOException, WebApplicationException;
}
-
- ]]>
</programlisting>
<para>
Interceptors are driven by the <literal>MessageBodyWriterContext</literal> or <literal>MessageBodyReaderContext</literal>. They are invoked together in a Java call stack. You must call <literal>MessageBodyReaderContext.proceed()</literal> or <literal>MessageBodyWriterContext.proceed()</literal> to add subsequent interceptors. When there are no more interceptors to invoke, call the <literal>readFrom()</literal> or <literal>writeTo()</literal> method of the <literal>MessageBodyReader</literal> or <literal>MessageBodyWriter</literal>. This wrapping lets you modify objects before they reach the Reader or Writer, and clean up when <literal>proceed()</literal> returns. The <literal>Context</literal> objects also posess methods that modify the parameters sent to the Reader or Writer.
</para>
<programlisting>
-<![CDATA[
public interface MessageBodyReaderContext
{
Class getType();
@@ -116,7 +112,6 @@
void proceed() throws IOException, WebApplicationException;
}
-]]>
</programlisting>
<para>
<literal>MessageBodyReaderInterceptor</literal>s and <literal>MessageBodyWriterInterceptor</literal>s can be use on the server or the client side. They must be annotated with <literal>@org.jboss.resteasy.annotations.interception.ServerInterceptor</literal> or <literal>@org.jboss.resteasy.annotations.interception.ClientInterceptor</literal> so that RESTEasy adds them to the correct interceptor list. If your interceptor classes are not annotated with one or both of these annotations, a deployment error will occur. Interceptors should also be annotated with <literal>@Provider</literal>, like so:
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Jaxb.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Jaxb.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Jaxb.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -77,7 +77,6 @@
For this to work, you must annotate the <literal>@Pretty</literal> annotation with a meta-annotation named <literal>@Decorator</literal>. The <literal>target()</literal> attribute must be the JAXB <literal>Marshaller</literal> class. Next, we will write the <literal>processor()</literal> attribute class.
</para>
<programlisting>
- <![CDATA[
import org.jboss.resteasy.core.interception.DecoratorProcessor;
import org.jboss.resteasy.annotations.DecorateTypes;
@@ -100,7 +99,6 @@
target.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
}
}
- ]]>
</programlisting>
<para>
The <literal>processor</literal> implementation must implement the <literal>DecoratorProcessor</literal> interface, and should also be annotated with <literal>@DecorateTypes</literal>. This annotation specifies the media types that the processor can work with.
@@ -193,7 +191,6 @@
To set an XML header when you output XML documents, use the <literal>@org.jboss.resteasy.annotations.providers.jaxb.XmlHeader</literal> annotation.
</para>
<programlisting>
- <![CDATA[
@XmlRootElement
public static class Thing
{
@@ -224,7 +221,7 @@
thing.setName("bill");
return thing;
}
-}]]>
+}
</programlisting>
<para>
Here, the <literal>@XmlHeader</literal> forces an <literal>xml-stylesheet</literal> header on the XML output. The same result can be obtained by placing the header on the <literal>Thing</literal> class. Read the JavaDocs for further information regarding the substitution values provided by RESTEasy.
@@ -233,7 +230,6 @@
RESTEasy also has a convenient annotation for stylesheet headers. For example:
</para>
<programlisting>
- <![CDATA[
@XmlRootElement
public static class Thing
{
@@ -265,7 +261,7 @@
thing.setName("bill");
return thing;
}
-}]]>
+}
</programlisting>
</section>
</section>
@@ -472,7 +468,6 @@
RESTEasy automatically marshals arrays, <literal>java.util.Set</literal>s, and <literal>java.util.List</literal>s of JAXB objects to and from XML, JSON, <literal>Fastinfoset</literal>, and other RESTEasy JAXB mappers.
</para>
<programlisting>
- <![CDATA[
@XmlRootElement(name = "customer")
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer
@@ -529,17 +524,15 @@
Assert.assertEquals("monica", customers.get(1).getName());
}
}
- ]]>
</programlisting>
<para>
The resource above publishes and receives JAXB objects. We assume that these are wrapped in a collection element like the following:
</para>
- <programlisting><![CDATA[
+ <programlisting>
<collection>
<customer><name>bill</name></customer>
<customer><name>monica</name></customer>
<collection>
- ]]>
</programlisting>
<para>
You can change the namespace URI, namespace tag, and collection element name by using the <literal>@org.jboss.resteasy.annotations.providers.jaxb.Wrapped</literal> annotation on a parameter or method:
@@ -559,17 +552,16 @@
<para>
So, if we wanted to output the following XML:
</para>
- <programlisting><![CDATA[
+ <programlisting>
<foo:list xmlns:foo="http://foo.org">
<customer><name>bill</name></customer>
<customer><name>monica</name></customer>
</foo:list>
- ]]>
</programlisting>
<para>
We would use the <literal>@Wrapped</literal> annotation as follows:
</para>
- <programlisting><![CDATA[
+ <programlisting>
@GET
@Path("list")
@Produces("application/xml")
@@ -582,7 +574,7 @@
return list;
}
- ]]>
+
</programlisting>
<section id="json_list">
<title>JSON and JAXB Collections/Arrays</title>
@@ -621,9 +613,7 @@
A List or Array of the <literal>Foo</literal> class would be represented in JSON like so:
</para>
<programlisting>
- <![CDATA[
[{"foo":{"@test":"bill"}},{"foo":{"@test":"monica}"}}]
- ]]>
</programlisting>
<para>
It would also expect this format when receiving input.
@@ -636,7 +626,6 @@
RESTEasy automatically marshals maps of JAXB objects to and from XML, JSON, <literal>Fastinfoset</literal>, and other JAXB mappers. Your parameter or method return type must be generic, with a String as the key and the JAXB object's type.
</para>
<programlisting>
-<![CDATA[
@XmlRootElement(namespace = "http://foo.com")
public static class Foo
{
@@ -674,13 +663,11 @@
return map;
}
}
- ]]>
</programlisting>
<para>
This resource publishes and receives JAXB objects within a map. By default, they are wrapped in a <literal>map</literal> element in the default namespace. Each <literal>map</literal> element has zero or more <literal>entry</literal> elements with a <literal>key</literal> attribute.
</para>
<programlisting>
- <![CDATA[
<map>
<entry key="bill" xmlns="http://foo.com">
<foo name="bill"/>
@@ -689,7 +676,6 @@
<foo name="monica"/>
</entry>
</map>
- ]]>
</programlisting>
<para>
You can change the namespace URI, namespace prefix and map, entry, and key element and attribute names by using the <literal>@org.jboss.resteasy.annotations.providers.jaxb.WrappedMap</literal> annotation on a parameter or method.
@@ -723,17 +709,14 @@
So, to output the following XML:
</para>
<programlisting>
- <![CDATA[
<hashmap>
<hashentry hashkey="bill" xmlns:foo="http://foo.com">
<foo:foo name="bill"/>
</hashentry>
</map>
- ]]>
</programlisting>
<para>We would use the @WrappedMap annotation as follows: </para>
<programlisting>
- <![CDATA[
@Path("/map")
public static class MyResource
{
@@ -745,7 +728,6 @@
...
return map;
}
- ]]>
</programlisting>
<section id="json_map">
<title>JSON and JAXB maps</title>
@@ -784,9 +766,7 @@
This a List or array of this Foo class would be represented in JSON like this:
</para>
<programlisting>
- <![CDATA[
{ "entry1" : {"foo":{"@test":"bill"}}, "entry2" : {"foo":{"@test":"monica}"}}}
- ]]>
</programlisting>
<para>It also expects this format for input</para>
</section>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Json.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Json.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Json.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -14,7 +14,6 @@
</para>
<programlisting>
-<![CDATA[
<repository>
<id>jboss</id>
<url>http://repository.jboss.org/maven2</url>
@@ -26,13 +25,11 @@
<artifactId>resteasy-jackson-provider</artifactId>
<version>1.1.GA</version>
</dependency>
- ]]>
</programlisting>
<para>
RESTEasy expands the JAX-RS integration built into Jackson in several ways. The first expansion provided support for <literal>application/*+json</literal>. Previously, Jackson accepted only <literal>application/json</literal> and <literal>text/json</literal> as valid media types. <literal>application/*+json</literal> support lets you marshal your JSON-based media types with Jackson. For example:
</para>
<programlisting>
-<![CDATA[
@Path("/customers")
public class MyService {
@@ -40,14 +37,11 @@
@Produces("application/vnd.customer+json")
public Customer[] getCustomers() {}
}
-]]>
</programlisting>
<para>
Using RESTEasy JAXB providers alongside Jackson is also problematic. Rather than use Jackson to output your JSON, you can use Jettison and JAXB. To do so, you must either not install the Jackson provider, or use the <literal>@org.jboss.resteasy.annotations.providers.NoJackson</literal> annotation on your JAXB annotated classes, like so:
</para>
<programlisting>
- <![CDATA[
-
@XmlRootElement
@NoJackson
public class Customer {...}
@@ -59,13 +53,11 @@
@Produces("application/vnd.customer+json")
public Customer[] getCustomers() {}
}
- ]]>
</programlisting>
<para>
If you cannot annotate the JAXB class with <literal>@NoJackson</literal>, tehn you can annotate a method parameter instead:
</para>
<programlisting>
- <![CDATA[
@XmlRootElement
public class Customer {...}
@@ -82,7 +74,6 @@
@Consumes("application/vnd.customer+json")
public void createCustomer(@NoJackson Customer[] customers) {...}
}
- ]]>
</programlisting>
<section id="Possible_Jackson_Problems">
<title>Possible Conflict With JAXB Provider</title>
@@ -90,4 +81,4 @@
If your Jackson classes are annotated with JAXB annotations and the <literal>resteasy-jaxb-provider</literal> is on your classpath, you can trigger the Jettison JAXB marshalling code. To disable the JAXB JSON Marshaller, annotate your classes with <literal>@org.jboss.resteasy.annotations.providers.jaxb.IgnoreMediaTypes("application/*+json")</literal>.
</para>
</section>
-</chapter>
\ No newline at end of file
+</chapter>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Maven_and_RESTEasy.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Maven_and_RESTEasy.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Maven_and_RESTEasy.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -10,7 +10,6 @@
You can combine them with the following <filename>pom.xml</filename> fragment. RESTEasy is divided into various components. You can mix and match components as required. Remember to replace <replaceable>1.1.GA</replaceable> with the RESTEasy version you want to use.
</para>
<programlisting>
-<![CDATA[
<repositories>
<repository>
<id>jboss</id>
@@ -104,7 +103,6 @@
</dependency>
</dependencies>
-]]>
</programlisting>
<para>
You can also import a <filename>POM</filename> to ensure that individual module versions need not me specified.
@@ -115,7 +113,6 @@
</para>
</note>
<programlisting>
-<![CDATA[
<dependencyManagement>
<dependencies>
<dependency>
@@ -127,6 +124,5 @@
</dependency>
</dependencies>
</dependencyManagement>
-]]>
</programlisting>
</chapter>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Migration_from_older_versions.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Migration_from_older_versions.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Migration_from_older_versions.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -27,7 +27,6 @@
<para>
The <literal>tjws</literal> and <literal>servlet-api</literal> artifacts are now scoped as <emphasis>provided</emphasis> in the <literal>resteasy-jar</literal> dependencies. If you have trouble with <emphasis>Class not found</emphasis> errors, you may need to scope them as <literal>provided</literal> or <literal>test</literal> in your <filename>pom</filename> files.</para>
<programlisting>
-<![CDATA[
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
@@ -38,7 +37,6 @@
<artifactId>webserver</artifactId>
<scope>provided</scope>
</dependency>
-]]>
</programlisting>
</listitem>
</itemizedlist>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Multipart.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Multipart.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Multipart.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -173,7 +173,7 @@
<para>
RESTEasy provides a simple API to output multipart data.
</para>
-<programlisting><![CDATA[
+<programlisting>
package org.jboss.resteasy.plugins.providers.multipart;
public class MultipartOutput
@@ -204,7 +204,6 @@
public MediaType getMediaType()
}
-]]>
</programlisting>
<para>
To output <literal>multipart</literal> data, create a <literal>MultipartOutput</literal> object and call <literal>addPart()</literal> methods. RESTEasy automatically finds a <literal>MessageBodyWriter</literal> to marshall your entity objects. As with <literal>MultipartInput</literal>, your marshalling may be sensitive to generic type metadata. In this case, use <literal>GenericType</literal>. The following example returns a <literal>multipart/mixed</literal> format to the calling client. The parts are JAXB-annotated <literal>Customer</literal> objects that will marshal into <literal>application/xml</literal>.
@@ -307,7 +306,6 @@
RESTEasy provides a simple API to output <literal>multipart/related</literal>.
</para>
<programlisting>
-<![CDATA[
package org.jboss.resteasy.plugins.providers.multipart;
public class MultipartRelatedOutput extends MultipartOutput
@@ -321,7 +319,6 @@
public void setStartInfo(String startInfo)
}
-]]>
</programlisting>
<para>
To output <literal>multipart/related</literal>, create a <literal>MultipartRelatedOutput</literal> object and call <literal>addPart()</literal> methods. The first added part is used as the root part of the <literal>multipart/related</literal> message. RESTEasy automatically locates a <literal>MessageBodyWriter</literal> to marshal your entity objects. As with <literal>MultipartInput</literal>, your marshalling may be sensitive to generic type metadata. In this case, use <literal>GenericType</literal>. The example below returns a <literal>multipart/related</literal> format to the calling client — a HTML file with two images.
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/RESTEasy_Client_Framework.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/RESTEasy_Client_Framework.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/RESTEasy_Client_Framework.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -88,7 +88,6 @@
You can retrieve all data associated with a request with the <literal>org.resteasy.spi.ClientResponse</literal> interface:
</para>
<programlisting>
- <![CDATA[
/**
* Response extension for the RESTEasy client framework. Use this, or Response
* in your client proxy interface method return type declarations if you want
@@ -151,7 +150,6 @@
*/
public abstract <T2> T2 getEntity(GenericType<T2> type);
}
-]]>
</programlisting>
<para>
All <literal>getEntity()</literal> methods are deferred until you invoke them. In other words, the response <literal>OutputStream</literal> is not read until you call one of these methods. The <literal>getEntity()</literal> method with no parameters can only be used if you have templated the <literal>ClientResponse</literal> within your method declaration. RESTEasy uses this generic type information to determine which media type the <literal>OutputStream</literal> is unmarshalled into. The <literal>getEntity()</literal> methods that take parameters let you specify the Object type the response should be marshalled into. This lets you dynamically extract the desired types at runtime. For example:
@@ -199,11 +197,11 @@
<para>
In this case, your client code can cast the returned Response object to a <literal>ClientResponse</literal> and use one of the typed <literal>getEntity()</literal> methods.
</para>
- <programlisting><![CDATA[
+ <programlisting>
MyInterface proxy = ProxyFactory.create(MyInterface.class, "http://localhost:8081");
ClientResponse response = (ClientResponse)proxy.getMyListOfJAXBObjects();
List<MyJaxbClass> list = response.getEntity(new GenericType<List<MyJaxbClass>>());
-]]></programlisting>
+</programlisting>
</section>
<section id="Client_error_handling">
@@ -227,7 +225,7 @@
</para>
<programlisting>
-<![CDATA[ ClientRequest request = new ClientRequest("http://localhost:8080/some/path");
+ ClientRequest request = new ClientRequest("http://localhost:8080/some/path");
request.header("custom-header", "value");
// We're posting XML and a JAXB object
@@ -239,7 +237,7 @@
if (response.getStatus() == 200) // OK!
{
String str = response.getEntity();
- }]]>
+ }
</programlisting>
</section>
</chapter>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/RESTEasy_Spring_Integration.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/RESTEasy_Spring_Integration.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/RESTEasy_Spring_Integration.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -12,13 +12,11 @@
<para>For Maven users, you must use the resteasy-spring artifact. Otherwise, the jar is available in the downloaded distribution.
</para>
<programlisting>
-<![CDATA[
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-spring</artifactId>
<version>whatever version you are using</version>
</dependency>
-]]>
</programlisting>
<para>
RESTEasy includes its own Spring <literal>ContextLoaderListener</literal>. This registers a RESTEasy-specific <literal>BeanPostProcessor</literal> that processes JAX-RS annotations when a bean is created by a <literal>BeanFactory</literal>. This means that RESTEasy automatically scans for <literal>@Provider</literal> and JAX-RS resource annotations on your bean class and registers them as JAX-RS resources.
@@ -92,7 +90,6 @@
Then, within your main Spring beans xml file, import the <filename>springmvc-resteasy.xml</filename> file.
</para>
<programlisting>
-<![CDATA[
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
@@ -104,7 +101,6 @@
<!-- Import basic SpringMVC Resteasy integration -->
<import resource="classpath:springmvc-resteasy.xml"/>
....
-]]>
</programlisting>
</section>
-</chapter>
\ No newline at end of file
+</chapter>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Revision_History.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Revision_History.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Revision_History.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -4,7 +4,25 @@
<appendix id="appe-Publican-Revision_History">
<title>Revision History</title>
- <simpara>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1.2</revnumber>
+ <date>Wed Oct 28 2009</date>
+ <author>
+ <firstname>Laura</firstname>
+ <surname>Bailey</surname>
+ <email>lbailey at redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>JIRA corrections.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+ <simpara>
<revhistory>
<revision>
<revnumber>1.0</revnumber>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/Securing_JAX-RS_and_RESTeasy.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/Securing_JAX-RS_and_RESTeasy.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/Securing_JAX-RS_and_RESTeasy.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -27,14 +27,13 @@
</para>
</note>
<programlisting>
-<![CDATA[
<web-app>
...
<context-param>
<context-name>resteasy.role.based.security</context-name>
<context-value>true</context-value>
</context-param>
-</web-app>]]>
+</web-app>
</programlisting>
<para>
Modified: projects/docs/enterprise/5.0/RESTEasy/en-US/StringConverter.xml
===================================================================
--- projects/docs/enterprise/5.0/RESTEasy/en-US/StringConverter.xml 2009-10-29 03:18:32 UTC (rev 95725)
+++ projects/docs/enterprise/5.0/RESTEasy/en-US/StringConverter.xml 2009-10-29 04:00:21 UTC (rev 95726)
@@ -19,7 +19,6 @@
This interface lets you use your own customized String marshalling. It is registered in <filename>web.xml</filename> under the <literal>resteasy.providers context-param</literal>. (See the Installation and Configuration chapter for details.) You can register it manually by calling the <literal>ResteasyProviderFactory.addStringConverter()</literal> method. A simple example of using the <literal>StringConverter</literal> follows:
</para>
<programlisting>
- <![CDATA[
import org.jboss.resteasy.client.ProxyFactory;
import org.jboss.resteasy.spi.StringConverter;
import org.jboss.resteasy.test.BaseResourceTest;
@@ -109,6 +108,5 @@
client.put(pojo, pojo, pojo, pojo);
}
}
-]]>
</programlisting>
</chapter>
More information about the jboss-cvs-commits
mailing list