View Javadoc
1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec.socks;
17  
18  import io.netty.util.internal.ObjectUtil;
19  
20  /**
21   * An abstract class that defines a SocksResponse, providing common properties for
22   * {@link SocksInitResponse}, {@link SocksAuthResponse}, {@link SocksCmdResponse} and {@link UnknownSocksResponse}.
23   *
24   * @see SocksInitResponse
25   * @see SocksAuthResponse
26   * @see SocksCmdResponse
27   * @see UnknownSocksResponse
28   */
29  public abstract class SocksResponse extends SocksMessage {
30      private final SocksResponseType responseType;
31  
32      protected SocksResponse(SocksResponseType responseType) {
33          super(SocksMessageType.RESPONSE);
34          this.responseType = ObjectUtil.checkNotNull(responseType, "responseType");
35      }
36  
37      /**
38       * Returns socks response type
39       *
40       * @return socks response type
41       */
42      public SocksResponseType responseType() {
43          return responseType;
44      }
45  }