View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.entity;
29  
30  import java.io.ByteArrayInputStream;
31  import java.io.ByteArrayOutputStream;
32  import java.io.IOException;
33  import java.io.InputStream;
34  import java.io.ObjectOutputStream;
35  import java.io.OutputStream;
36  import java.io.Serializable;
37  
38  import org.apache.http.util.Args;
39  
40  /**
41   * A streamed entity that obtains its content from a {@link Serializable}.
42   * The content obtained from the {@link Serializable} instance can
43   * optionally be buffered in a byte array in order to make the
44   * entity self-contained and repeatable.
45   *
46   * @since 4.0
47   */
48  public class SerializableEntity extends AbstractHttpEntity {
49  
50      private byte[] objSer;
51  
52      private Serializable objRef;
53  
54      /**
55       * Creates new instance of this class.
56       *
57       * @param ser input
58       * @param bufferize tells whether the content should be
59       *        stored in an internal buffer
60       * @throws IOException in case of an I/O error
61       */
62      public SerializableEntity(final Serializable ser, final boolean bufferize) throws IOException {
63          super();
64          Args.notNull(ser, "Source object");
65          if (bufferize) {
66              createBytes(ser);
67          } else {
68              this.objRef = ser;
69          }
70      }
71  
72      /**
73       * @since 4.3
74       */
75      public SerializableEntity(final Serializable ser) {
76          super();
77          Args.notNull(ser, "Source object");
78          this.objRef = ser;
79      }
80  
81      private void createBytes(final Serializable ser) throws IOException {
82          final ByteArrayOutputStream baos = new ByteArrayOutputStream();
83          final ObjectOutputStream out = new ObjectOutputStream(baos);
84          out.writeObject(ser);
85          out.flush();
86          this.objSer = baos.toByteArray();
87      }
88  
89      @Override
90      public InputStream getContent() throws IOException, IllegalStateException {
91          if (this.objSer == null) {
92              createBytes(this.objRef);
93          }
94          return new ByteArrayInputStream(this.objSer);
95      }
96  
97      @Override
98      public long getContentLength() {
99          if (this.objSer ==  null) {
100             return -1;
101         } else {
102             return this.objSer.length;
103         }
104     }
105 
106     @Override
107     public boolean isRepeatable() {
108         return true;
109     }
110 
111     @Override
112     public boolean isStreaming() {
113         return this.objSer == null;
114     }
115 
116     @Override
117     public void writeTo(final OutputStream outstream) throws IOException {
118         Args.notNull(outstream, "Output stream");
119         if (this.objSer == null) {
120             final ObjectOutputStream out = new ObjectOutputStream(outstream);
121             out.writeObject(this.objRef);
122             out.flush();
123         } else {
124             outstream.write(this.objSer);
125             outstream.flush();
126         }
127     }
128 
129 }