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      @SuppressWarnings("deprecation")
56      public ByteArrayEntity(final byte[] b, final ContentType contentType) {
57          super();
58          Args.notNull(b, "Source byte array");
59          this.content = b;
60          this.b = b;
61          this.off = 0;
62          this.len = this.b.length;
63          if (contentType != null) {
64              setContentType(contentType.toString());
65          }
66      }
67  
68      /**
69       * @since 4.2
70       */
71      @SuppressWarnings("deprecation")
72      public ByteArrayEntity(final byte[] b, final int off, final int len, final ContentType contentType) {
73          super();
74          Args.notNull(b, "Source byte array");
75          if ((off < 0) || (off > b.length) || (len < 0) ||
76                  ((off + len) < 0) || ((off + len) > b.length)) {
77              throw new IndexOutOfBoundsException("off: " + off + " len: " + len + " b.length: " + b.length);
78          }
79          this.content = b;
80          this.b = b;
81          this.off = off;
82          this.len = len;
83          if (contentType != null) {
84              setContentType(contentType.toString());
85          }
86      }
87  
88      public ByteArrayEntity(final byte[] b) {
89          this(b, null);
90      }
91  
92      public ByteArrayEntity(final byte[] b, final int off, final int len) {
93          this(b, off, len, null);
94      }
95  
96      @Override
97      public boolean isRepeatable() {
98          return true;
99      }
100 
101     @Override
102     public long getContentLength() {
103         return this.len;
104     }
105 
106     @Override
107     public InputStream getContent() {
108         return new ByteArrayInputStream(this.b, this.off, this.len);
109     }
110 
111     @Override
112     public void writeTo(final OutputStream outstream) throws IOException {
113         Args.notNull(outstream, "Output stream");
114         outstream.write(this.b, this.off, this.len);
115         outstream.flush();
116     }
117 
118 
119     /**
120      * Tells that this entity is not streaming.
121      *
122      * @return {@code false}
123      */
124     @Override
125     public boolean isStreaming() {
126         return false;
127     }
128 
129     @Override
130     public Object clone() throws CloneNotSupportedException {
131         return super.clone();
132     }
133 
134 } // class ByteArrayEntity