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.buffer.ByteBuf;
19  import io.netty.util.internal.ObjectUtil;
20  
21  import java.util.Collections;
22  import java.util.List;
23  
24  /**
25   * An socks init request.
26   *
27   * @see SocksInitResponse
28   * @see SocksInitRequestDecoder
29   */
30  public final class SocksInitRequest extends SocksRequest {
31      private final List<SocksAuthScheme> authSchemes;
32  
33      public SocksInitRequest(List<SocksAuthScheme> authSchemes) {
34          super(SocksRequestType.INIT);
35          this.authSchemes = ObjectUtil.checkNotNull(authSchemes, "authSchemes");
36      }
37  
38      /**
39       * Returns the List<{@link SocksAuthScheme}> of this {@link SocksInitRequest}
40       *
41       * @return The List<{@link SocksAuthScheme}> of this {@link SocksInitRequest}
42       */
43      public List<SocksAuthScheme> authSchemes() {
44          return Collections.unmodifiableList(authSchemes);
45      }
46  
47      @Override
48      public void encodeAsByteBuf(ByteBuf byteBuf) {
49          byteBuf.writeByte(protocolVersion().byteValue());
50          byteBuf.writeByte(authSchemes.size());
51          for (SocksAuthScheme authScheme : authSchemes) {
52              byteBuf.writeByte(authScheme.byteValue());
53          }
54      }
55  }