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 io.netty.handler.codec.socks;
17  
18  import io.netty.buffer.ByteBuf;
19  
20  /**
21   * An socks auth response.
22   *
23   * @see SocksAuthRequest
24   * @see SocksAuthResponseDecoder
25   */
26  public final class SocksAuthResponse extends SocksResponse {
27      private static final SocksSubnegotiationVersion SUBNEGOTIATION_VERSION = SocksSubnegotiationVersion.AUTH_PASSWORD;
28      private final SocksAuthStatus authStatus;
29  
30      public SocksAuthResponse(SocksAuthStatus authStatus) {
31          super(SocksResponseType.AUTH);
32          if (authStatus == null) {
33              throw new NullPointerException("authStatus");
34          }
35          this.authStatus = authStatus;
36      }
37  
38      /**
39       * Returns the {@link SocksAuthStatus} of this {@link SocksAuthResponse}
40       *
41       * @return The {@link SocksAuthStatus} of this {@link SocksAuthResponse}
42       */
43      public SocksAuthStatus authStatus() {
44          return authStatus;
45      }
46  
47      @Override
48      public void encodeAsByteBuf(ByteBuf byteBuf) {
49          byteBuf.writeByte(SUBNEGOTIATION_VERSION.byteValue());
50          byteBuf.writeByte(authStatus.byteValue());
51      }
52  }