ホーム
製品
Red Hat JBoss Enterprise Application Platform
5
RESTEasy リファレンスガイド
17.6. JAXB オブジェクトのアレイとコレクション

17.6. JAXB オブジェクトのアレイとコレクション

RESTEasy は java.util.Set や JAXB オブジェクトの java.util.List のアレイを XML、 JSON、 Fastinfoset、その他の RESTEasy JAXB マッパ間で自動的にマーシャリングします。

 @XmlRootElement(name = "customer")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class Customer
 {
@XmlElement
private String name;

public Customer()
{
}

public Customer(String name)
{
   this.name = name;
}

public String getName()
{
   return name;
}
 }

 @Path("/")
 public class MyResource
 {
   @PUT
   @Path("array")
   @Consumes("application/xml")
   public void putCustomers(Customer[] customers)
   {
      Assert.assertEquals("bill", customers[0].getName());
      Assert.assertEquals("monica", customers[1].getName());
   }

   @GET
   @Path("set")
   @Produces("application/xml")
   public Set<Customer> getCustomerSet()
   {
      HashSet<Customer> set = new HashSet<Customer>();
      set.add(new Customer("bill"));
      set.add(new Customer("monica"));

      return set;
   }


   @PUT
   @Path("list")
   @Consumes("application/xml")
   public void putCustomers(List<Customer> customers)
   {
      Assert.assertEquals("bill", customers.get(0).getName());
      Assert.assertEquals("monica", customers.get(1).getName());
   }
 }

 @XmlRootElement(name = "customer")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class Customer
 {
@XmlElement
private String name;

public Customer()
{
}

public Customer(String name)
{
   this.name = name;
}

public String getName()
{
   return name;
}
 }

 @Path("/")
 public class MyResource
 {
   @PUT
   @Path("array")
   @Consumes("application/xml")
   public void putCustomers(Customer[] customers)
   {
      Assert.assertEquals("bill", customers[0].getName());
      Assert.assertEquals("monica", customers[1].getName());
   }

   @GET
   @Path("set")
   @Produces("application/xml")
   public Set<Customer> getCustomerSet()
   {
      HashSet<Customer> set = new HashSet<Customer>();
      set.add(new Customer("bill"));
      set.add(new Customer("monica"));

      return set;
   }


   @PUT
   @Path("list")
   @Consumes("application/xml")
   public void putCustomers(List<Customer> customers)
   {
      Assert.assertEquals("bill", customers.get(0).getName());
      Assert.assertEquals("monica", customers.get(1).getName());
   }
 }

Copy to Clipboard

Toggle word wrap

前述のリソースは、 JAXB オブジェクトを公開し、受け取ります。リソースは次のようなコレクションエレメントにラッピングされることとします。

 <collection>
<customer><name>bill</name></customer>
<customer><name>monica</name></customer>
 <collection>

 <collection>
<customer><name>bill</name></customer>
<customer><name>monica</name></customer>
 <collection>

Copy to Clipboard

Toggle word wrap

パラメータかメソッド上で @org.jboss.resteasy.annotations.providers.jaxb.Wrapped アノテーションを使用すると、名前空間 URL や名前空間タグ、コレクションエレメント名を変更することができます。

 @Target({ElementType.PARAMETER, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Wrapped
 {
String element() default "collection";

String namespace() default "http://jboss.org/resteasy";

String prefix() default "resteasy";
 }

 @Target({ElementType.PARAMETER, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Wrapped
 {
String element() default "collection";

String namespace() default "http://jboss.org/resteasy";

String prefix() default "resteasy";
 }

Copy to Clipboard

Toggle word wrap

次の XML を出力したいとしましょう。

 <foo:list xmlns:foo="http://foo.org">
<customer><name>bill</name></customer>
<customer><name>monica</name></customer>
 </foo:list>

 <foo:list xmlns:foo="http://foo.org">
<customer><name>bill</name></customer>
<customer><name>monica</name></customer>
 </foo:list>

Copy to Clipboard

Toggle word wrap

この場合、次のように @Wrapped アノテーションを使用します。

   @GET
   @Path("list")
   @Produces("application/xml")
   @Wrapped(element="list", namespace="http://foo.org", prefix="foo")
   public List<Customer> getCustomerSet()
   {
      List<Customer> list = new ArrayList<Customer>();
      list.add(new Customer("bill"));
      list.add(new Customer("monica"));

      return list;
   }

   @GET
   @Path("list")
   @Produces("application/xml")
   @Wrapped(element="list", namespace="http://foo.org", prefix="foo")
   public List<Customer> getCustomerSet()
   {
      List<Customer> list = new ArrayList<Customer>();
      list.add(new Customer("bill"));
      list.add(new Customer("monica"));

      return list;
   }

Copy to Clipboard

Toggle word wrap

17.6.1. JSON および JAXB コレクション / アレイ
リンクのコピー

RESTEasy は JSON とのコレクションの使用をサポートします。簡単な JSON アレイ内の返された JAXB オブジェクトのリストやセット、アレイが含まれます。次の例を見てみましょう。

   @XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public static class Foo
{
   @XmlAttribute
   private String test;

   public Foo()
   {
   }

   public Foo(String test)
   {
      this.test = test;
   }

   public String getTest()
   {
      return test;
   }

   public void setTest(String test)
   {
      this.test = test;
   }
}

   @XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public static class Foo
{
   @XmlAttribute
   private String test;

   public Foo()
   {
   }

   public Foo(String test)
   {
      this.test = test;
   }

   public String getTest()
   {
      return test;
   }

   public void setTest(String test)
   {
      this.test = test;
   }
}

Copy to Clipboard

Toggle word wrap

次のように Foo クラスのリストやアレイが JSON で示されます。

 [{"foo":{"@test":"bill"}},{"foo":{"@test":"monica}"}}]

 [{"foo":{"@test":"bill"}},{"foo":{"@test":"monica}"}}]

Copy to Clipboard

Toggle word wrap

出力を受け取る時もこの形式が必要です。

トップに戻る

17.6. JAXB オブジェクトのアレイとコレクション

17.6.1. JSON および JAXB コレクション / アレイ
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

17.6. JAXB オブジェクトのアレイとコレクション

17.6.1. JSON および JAXB コレクション / アレイリンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

17.6.1. JSON および JAXB コレクション / アレイ
リンクのコピー