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.nio.codecs;
29
30 import java.nio.channels.ReadableByteChannel;
31
32 import org.apache.http.nio.ContentDecoder;
33 import org.apache.http.nio.reactor.SessionInputBuffer;
34 import org.apache.http.annotation.NotThreadSafe;
35 import org.apache.http.impl.io.HttpTransportMetricsImpl;
36
37 /**
38 * Abstract {@link ContentDecoder} that serves as a base for all content
39 * decoder implementations.
40 *
41 * @since 4.0
42 */
43 @NotThreadSafe
44 public abstract class AbstractContentDecoder implements ContentDecoder {
45
46 protected final ReadableByteChannel channel;
47 protected final SessionInputBuffer buffer;
48 protected final HttpTransportMetricsImpl metrics;
49
50 protected boolean completed;
51
52 /**
53 * Creates an instance of this class.
54 *
55 * @param channel the source channel.
56 * @param buffer the session input buffer that can be used to store
57 * session data for intermediate processing.
58 * @param metrics Transport metrics of the underlying HTTP transport.
59 */
60 public AbstractContentDecoder(
61 final ReadableByteChannel channel,
62 final SessionInputBuffer buffer,
63 final HttpTransportMetricsImpl metrics) {
64 super();
65 if (channel == null) {
66 throw new IllegalArgumentException("Channel may not be null");
67 }
68 if (buffer == null) {
69 throw new IllegalArgumentException("Session input buffer may not be null");
70 }
71 if (metrics == null) {
72 throw new IllegalArgumentException("Transport metrics may not be null");
73 }
74 this.buffer = buffer;
75 this.channel = channel;
76 this.metrics = metrics;
77 }
78
79 public boolean isCompleted() {
80 return this.completed;
81 }
82
83 }