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.File;
31  import java.io.FileInputStream;
32  import java.io.IOException;
33  import java.io.InputStream;
34  import java.io.OutputStream;
35  
36  import org.apache.http.annotation.NotThreadSafe;
37  import org.apache.http.util.Args;
38  
39  /**
40   * A self contained, repeatable entity that obtains its content from a file.
41   *
42   * @since 4.0
43   */
44  @NotThreadSafe
45  public class FileEntity extends AbstractHttpEntity implements Cloneable {
46  
47      protected final File file;
48  
49      /**
50       * @deprecated (4.1.3) {@link #FileEntity(File, ContentType)}
51       */
52      @Deprecated
53      public FileEntity(final File file, final String contentType) {
54          super();
55          this.file = Args.notNull(file, "File");
56          setContentType(contentType);
57      }
58  
59      /**
60       * @since 4.2
61       */
62      public FileEntity(final File file, final ContentType contentType) {
63          super();
64          this.file = Args.notNull(file, "File");
65          if (contentType != null) {
66              setContentType(contentType.toString());
67          }
68      }
69  
70      /**
71       * @since 4.2
72       */
73      public FileEntity(final File file) {
74          super();
75          this.file = Args.notNull(file, "File");
76      }
77  
78      public boolean isRepeatable() {
79          return true;
80      }
81  
82      public long getContentLength() {
83          return this.file.length();
84      }
85  
86      public InputStream getContent() throws IOException {
87          return new FileInputStream(this.file);
88      }
89  
90      public void writeTo(final OutputStream outstream) throws IOException {
91          Args.notNull(outstream, "Output stream");
92          final InputStream instream = new FileInputStream(this.file);
93          try {
94              final byte[] tmp = new byte[OUTPUT_BUFFER_SIZE];
95              int l;
96              while ((l = instream.read(tmp)) != -1) {
97                  outstream.write(tmp, 0, l);
98              }
99              outstream.flush();
100         } finally {
101             instream.close();
102         }
103     }
104 
105     /**
106      * Tells that this entity is not streaming.
107      *
108      * @return <code>false</code>
109      */
110     public boolean isStreaming() {
111         return false;
112     }
113 
114     @Override
115     public Object clone() throws CloneNotSupportedException {
116         // File instance is considered immutable
117         // No need to make a copy of it
118         return super.clone();
119     }
120 
121 } // class FileEntity