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.IOException;
32  import java.io.InputStream;
33  import java.io.OutputStream;
34  
35  import org.apache.http.util.Args;
36  
37  /**
38   * A self contained, repeatable entity that obtains its content from a byte array.
39   *
40   * @since 4.0
41   */
42  public class ByteArrayEntity extends AbstractHttpEntity implements Cloneable {
43  
44      /**
45       * @deprecated (4.2)
46       */
47      @Deprecated
48      protected final byte[] content;
49      private final byte[] b;
50      private final int off, len;
51  
52      /**
53       * @since 4.2
54       */
55      public ByteArrayEntity(final byte[] b, final ContentType contentType) {
56          super();
57          Args.notNull(b, "Source byte array");
58          this.content = b;
59          this.b = b;
60          this.off = 0;
61          this.len = this.b.length;
62          if (contentType != null) {
63              setContentType(contentType.toString());
64          }
65      }
66  
67      /**
68       * @since 4.2
69       */
70      public ByteArrayEntity(final byte[] b, final int off, final int len, final ContentType contentType) {
71          super();
72          Args.notNull(b, "Source byte array");
73          if ((off < 0) || (off > b.length) || (len < 0) ||
74                  ((off + len) < 0) || ((off + len) > b.length)) {
75              throw new IndexOutOfBoundsException("off: " + off + " len: " + len + " b.length: " + b.length);
76          }
77          this.content = b;
78          this.b = b;
79          this.off = off;
80          this.len = len;
81          if (contentType != null) {
82              setContentType(contentType.toString());
83          }
84      }
85  
86      public ByteArrayEntity(final byte[] b) {
87          this(b, null);
88      }
89  
90      public ByteArrayEntity(final byte[] b, final int off, final int len) {
91          this(b, off, len, null);
92      }
93  
94      @Override
95      public boolean isRepeatable() {
96          return true;
97      }
98  
99      @Override
100     public long getContentLength() {
101         return this.len;
102     }
103 
104     @Override
105     public InputStream getContent() {
106         return new ByteArrayInputStream(this.b, this.off, this.len);
107     }
108 
109     @Override
110     public void writeTo(final OutputStream outStream) throws IOException {
111         Args.notNull(outStream, "Output stream");
112         outStream.write(this.b, this.off, this.len);
113         outStream.flush();
114     }
115 
116 
117     /**
118      * Tells that this entity is not streaming.
119      *
120      * @return {@code false}
121      */
122     @Override
123     public boolean isStreaming() {
124         return false;
125     }
126 
127     @Override
128     public Object clone() throws CloneNotSupportedException {
129         return super.clone();
130     }
131 
132 } // class ByteArrayEntity