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