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.hc.core5.http.nio.entity;
29  
30  import java.io.IOException;
31  import java.util.Set;
32  
33  import org.apache.hc.core5.annotation.Contract;
34  import org.apache.hc.core5.annotation.ThreadingBehavior;
35  import org.apache.hc.core5.http.nio.AsyncEntityProducer;
36  import org.apache.hc.core5.http.nio.DataStreamChannel;
37  import org.apache.hc.core5.util.Args;
38  
39  /**
40   * Base class for wrapping entity producers that delegates all calls to the wrapped producer.
41   * Implementations can derive from this class and override only those methods that
42   * should not be delegated to the wrapped producer.
43   *
44   * @since 5.0
45   */
46  @Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL)
47  public class AsyncEntityProducerWrapper implements AsyncEntityProducer {
48  
49      private final AsyncEntityProducer wrappedEntityProducer;
50  
51      public AsyncEntityProducerWrapper(final AsyncEntityProducer wrappedEntityProducer) {
52          super();
53          this.wrappedEntityProducer = Args.notNull(wrappedEntityProducer, "Wrapped entity producer");
54      }
55  
56      @Override
57      public boolean isRepeatable() {
58          return wrappedEntityProducer.isRepeatable();
59      }
60  
61      @Override
62      public boolean isChunked() {
63          return wrappedEntityProducer.isChunked();
64      }
65  
66      @Override
67      public long getContentLength() {
68          return wrappedEntityProducer.getContentLength();
69      }
70  
71      @Override
72      public String getContentType() {
73          return wrappedEntityProducer.getContentType();
74      }
75  
76      @Override
77      public String getContentEncoding() {
78          return wrappedEntityProducer.getContentEncoding();
79      }
80  
81      @Override
82      public Set<String> getTrailerNames() {
83          return wrappedEntityProducer.getTrailerNames();
84      }
85  
86      @Override
87      public int available() {
88          return wrappedEntityProducer.available();
89      }
90  
91      @Override
92      public void produce(final DataStreamChannel channel) throws IOException {
93          wrappedEntityProducer.produce(channel);
94      }
95  
96      @Override
97      public void failed(final Exception cause) {
98          wrappedEntityProducer.failed(cause);
99      }
100 
101     @Override
102     public void releaseResources() {
103         wrappedEntityProducer.releaseResources();
104     }
105 
106     @Override
107     public String toString() {
108         return "Wrapper [" + wrappedEntityProducer + "]";
109     }
110 
111 }