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.impl.client;
29  
30  import java.io.IOException;
31  import java.io.InputStream;
32  import java.io.OutputStream;
33  
34  import org.apache.http.Header;
35  import org.apache.http.HttpEntity;
36  import org.apache.http.HttpEntityEnclosingRequest;
37  import org.apache.http.ProtocolException;
38  import org.apache.http.annotation.NotThreadSafe;
39  import org.apache.http.entity.HttpEntityWrapper;
40  import org.apache.http.protocol.HTTP;
41  
42  /**
43   * A wrapper class for {@link HttpEntityEnclosingRequest}s that can
44   * be used to change properties of the current request without
45   * modifying the original object.
46   * </p>
47   * This class is also capable of resetting the request headers to
48   * the state of the original request.
49   *
50   * @since 4.0
51   *
52   * @deprecated (4.3) do not use.
53   */
54  @Deprecated
55  @NotThreadSafe // e.g. [gs]etEntity()
56  public class EntityEnclosingRequestWrapper extends RequestWrapper
57      implements HttpEntityEnclosingRequest {
58  
59      private HttpEntity entity;
60      private boolean consumed;
61  
62      public EntityEnclosingRequestWrapper(final HttpEntityEnclosingRequest request)
63          throws ProtocolException {
64          super(request);
65          setEntity(request.getEntity());
66      }
67  
68      @Override
69      public HttpEntity getEntity() {
70          return this.entity;
71      }
72  
73      @Override
74      public void setEntity(final HttpEntity entity) {
75          this.entity = entity != null ? new EntityWrapper(entity) : null;
76          this.consumed = false;
77      }
78  
79      @Override
80      public boolean expectContinue() {
81          final Header expect = getFirstHeader(HTTP.EXPECT_DIRECTIVE);
82          return expect != null && HTTP.EXPECT_CONTINUE.equalsIgnoreCase(expect.getValue());
83      }
84  
85      @Override
86      public boolean isRepeatable() {
87          return this.entity == null || this.entity.isRepeatable() || !this.consumed;
88      }
89  
90      class EntityWrapper extends HttpEntityWrapper {
91  
92          EntityWrapper(final HttpEntity entity) {
93              super(entity);
94          }
95  
96          @Override
97          public void consumeContent() throws IOException {
98              consumed = true;
99              super.consumeContent();
100         }
101 
102         @Override
103         public InputStream getContent() throws IOException {
104             consumed = true;
105             return super.getContent();
106         }
107 
108         @Override
109         public void writeTo(final OutputStream outstream) throws IOException {
110             consumed = true;
111             super.writeTo(outstream);
112         }
113 
114     }
115 
116 }