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   * </p>
50   *
51   * @since 4.0
52   *
53   * @deprecated (4.3) do not use.
54   */
55  @Deprecated
56  @NotThreadSafe // e.g. [gs]etEntity()
57  public class EntityEnclosingRequestWrapper extends RequestWrapper
58      implements HttpEntityEnclosingRequest {
59  
60      private HttpEntity entity;
61      private boolean consumed;
62  
63      public EntityEnclosingRequestWrapper(final HttpEntityEnclosingRequest request)
64          throws ProtocolException {
65          super(request);
66          setEntity(request.getEntity());
67      }
68  
69      @Override
70      public HttpEntity getEntity() {
71          return this.entity;
72      }
73  
74      @Override
75      public void setEntity(final HttpEntity entity) {
76          this.entity = entity != null ? new EntityWrapper(entity) : null;
77          this.consumed = false;
78      }
79  
80      @Override
81      public boolean expectContinue() {
82          final Header expect = getFirstHeader(HTTP.EXPECT_DIRECTIVE);
83          return expect != null && HTTP.EXPECT_CONTINUE.equalsIgnoreCase(expect.getValue());
84      }
85  
86      @Override
87      public boolean isRepeatable() {
88          return this.entity == null || this.entity.isRepeatable() || !this.consumed;
89      }
90  
91      class EntityWrapper extends HttpEntityWrapper {
92  
93          EntityWrapper(final HttpEntity entity) {
94              super(entity);
95          }
96  
97          @Override
98          public void consumeContent() throws IOException {
99              consumed = true;
100             super.consumeContent();
101         }
102 
103         @Override
104         public InputStream getContent() throws IOException {
105             consumed = true;
106             return super.getContent();
107         }
108 
109         @Override
110         public void writeTo(final OutputStream outstream) throws IOException {
111             consumed = true;
112             super.writeTo(outstream);
113         }
114 
115     }
116 
117 }