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.reactor;
29  
30  import java.nio.channels.SocketChannel;
31  
32  import org.apache.http.util.Args;
33  
34  /**
35   * {@link SocketChannel} entry maintained by the I/O reactor. If the channel
36   *  represents an outgoing client connection, this entry also contains the
37   *  original {@link SessionRequestImpl} used to request it.
38   *
39   * @since 4.0
40   */
41  public class ChannelEntry {
42  
43      private final SocketChannel channel;
44      private final SessionRequestImpl sessionRequest;
45  
46      /**
47       * Creates new ChannelEntry.
48       *
49       * @param channel the channel
50       * @param sessionRequest original session request. Can be {@code null}
51       *   if the channel represents an incoming server-side connection.
52       */
53      public ChannelEntry(final SocketChannel channel, final SessionRequestImpl sessionRequest) {
54          super();
55          Args.notNull(channel, "Socket channel");
56          this.channel = channel;
57          this.sessionRequest = sessionRequest;
58      }
59  
60      /**
61       * Creates new ChannelEntry.
62       *
63       * @param channel the channel.
64       */
65      public ChannelEntry(final SocketChannel channel) {
66          this(channel, null);
67      }
68  
69      /**
70       * Returns the original session request, if available. If the channel
71       * entry represents an incoming server-side connection, returns
72       * {@code null}.
73       *
74       * @return the original session request, if client-side channel,
75       *  {@code null} otherwise.
76       */
77      public SessionRequestImpl getSessionRequest() {
78          return this.sessionRequest;
79      }
80  
81      /**
82       * Returns the original session request attachment, if available.
83       *
84       * @return the original session request attachment, if available,
85       *  {@code null} otherwise.
86       */
87      public Object getAttachment() {
88          if (this.sessionRequest != null) {
89              return this.sessionRequest.getAttachment();
90          } else {
91              return null;
92          }
93      }
94  
95      /**
96       * Returns the channel.
97       *
98       * @return the channel.
99       */
100     public SocketChannel getChannel() {
101         return this.channel;
102     }
103 
104 }