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