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