KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > hessian > io > HessianSerializerOutput


1 /*
2  * Copyright (c) 2001-2004 Caucho Technology, Inc. All rights reserved.
3  *
4  * The Apache Software License, Version 1.1
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution, if
19  * any, must include the following acknowlegement:
20  * "This product includes software developed by the
21  * Caucho Technology (http://www.caucho.com/)."
22  * Alternately, this acknowlegement may appear in the software itself,
23  * if and wherever such third-party acknowlegements normally appear.
24  *
25  * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * info@caucho.com.
29  *
30  * 5. Products derived from this software may not be called "Resin"
31  * nor may "Resin" appear in their names without prior written
32  * permission of Caucho Technology.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37  * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
38  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
39  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
40  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
41  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
42  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
44  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  * @author Scott Ferguson
47  */
48
49 package com.caucho.hessian.io;
50
51 import java.io.IOException JavaDoc;
52 import java.io.OutputStream JavaDoc;
53 import java.lang.reflect.Field JavaDoc;
54 import java.lang.reflect.Method JavaDoc;
55 import java.lang.reflect.Modifier JavaDoc;
56
57 /**
58  * Output stream for Hessian requests.
59  *
60  * <p>HessianOutput is unbuffered, so any client needs to provide
61  * its own buffering.
62  *
63  * <h3>Serialization</h3>
64  *
65  * <pre>
66  * OutputStream os = new FileOutputStream("test.xml");
67  * HessianOutput out = new HessianSerializerOutput(os);
68  *
69  * out.writeObject(obj);
70  * os.close();
71  * </pre>
72  *
73  * <h3>Writing an RPC Call</h3>
74  *
75  * <pre>
76  * OutputStream os = ...; // from http connection
77  * HessianOutput out = new HessianSerializerOutput(os);
78  * String value;
79  *
80  * out.startCall("hello"); // start hello call
81  * out.writeString("arg1"); // write a string argument
82  * out.completeCall(); // complete the call
83  * </pre>
84  */
85 public class HessianSerializerOutput extends HessianOutput {
86   /**
87    * Creates a new Hessian output stream, initialized with an
88    * underlying output stream.
89    *
90    * @param os the underlying output stream.
91    */
92   public HessianSerializerOutput(OutputStream JavaDoc os)
93   {
94     super(os);
95   }
96
97   /**
98    * Creates an uninitialized Hessian output stream.
99    */
100   public HessianSerializerOutput()
101   {
102   }
103
104   /**
105    * Applications which override this can do custom serialization.
106    *
107    * @param object the object to write.
108    */
109   public void writeObjectImpl(Object JavaDoc obj)
110     throws IOException JavaDoc
111   {
112     Class JavaDoc cl = obj.getClass();
113     
114     try {
115       Method JavaDoc method = cl.getMethod("writeReplace", new Class JavaDoc[0]);
116       Object JavaDoc repl = method.invoke(obj, new Object JavaDoc[0]);
117
118       writeObject(repl);
119       return;
120     } catch (Exception JavaDoc e) {
121     }
122
123     try {
124       writeMapBegin(cl.getName());
125       for (; cl != null; cl = cl.getSuperclass()) {
126         Field JavaDoc []fields = cl.getDeclaredFields();
127         for (int i = 0; i < fields.length; i++) {
128           Field JavaDoc field = fields[i];
129
130           if (Modifier.isTransient(field.getModifiers()) ||
131               Modifier.isStatic(field.getModifiers()))
132             continue;
133
134           // XXX: could parameterize the handler to only deal with public
135 field.setAccessible(true);
136       
137           writeString(field.getName());
138           writeObject(field.get(obj));
139         }
140       }
141       writeMapEnd();
142     } catch (IllegalAccessException JavaDoc e) {
143       throw new IOExceptionWrapper(e);
144     }
145   }
146 }
147
Popular Tags