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