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    *   http://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 org.jboss.netty.handler.codec.socks;
17  
18  /**
19   * An abstract class that defines a SocksResponse, providing common properties for
20   * {@link SocksInitResponse}, {@link SocksAuthResponse}, {@link SocksCmdResponse} and {@link UnknownSocksResponse}.
21   *
22   * @see {@link SocksInitResponse}
23   * @see {@link SocksAuthResponse}
24   * @see {@link SocksCmdResponse}
25   * @see {@link UnknownSocksResponse}
26   */
27  public abstract class SocksResponse extends SocksMessage {
28      private final SocksResponseType socksResponseType;
29  
30      protected SocksResponse(SocksResponseType socksResponseType) {
31          super(MessageType.RESPONSE);
32          if (socksResponseType == null) {
33              throw new NullPointerException("socksResponseType");
34          }
35          this.socksResponseType = socksResponseType;
36      }
37  
38      /**
39       * Returns socks response type
40       *
41       * @return socks response type
42       */
43      public SocksResponseType getSocksResponseType() {
44          return socksResponseType;
45      }
46  
47      /**
48       * Type of socks response
49       */
50      public enum SocksResponseType {
51          INIT,
52          AUTH,
53          CMD,
54          UNKNOWN
55      }
56  }