SocksAuthRequest

java.lang.Object
- org.jboss.netty.handler.codec.socks.SocksMessage
- - org.jboss.netty.handler.codec.socks.SocksRequest
  - - org.jboss.netty.handler.codec.socks.SocksAuthRequest

public final class SocksAuthRequest
extends SocksRequest

An socks auth request.

Nested Class Summary
- Nested classes/interfaces inherited from class org.jboss.netty.handler.codec.socks.SocksRequest
  SocksRequest.SocksRequestType
- Nested classes/interfaces inherited from class org.jboss.netty.handler.codec.socks.SocksMessage
  SocksMessage.AddressType, SocksMessage.AuthScheme, SocksMessage.AuthStatus, SocksMessage.CmdStatus, SocksMessage.CmdType, SocksMessage.MessageType, SocksMessage.ProtocolVersion, SocksMessage.SubnegotiationVersion

Field Summary

Fields
Modifier and Type	Field	Description
`private static java.nio.charset.CharsetEncoder`	`asciiEncoder`
`private java.lang.String`	`password`
`private static SocksMessage.SubnegotiationVersion`	`SUBNEGOTIATION_VERSION`
`private java.lang.String`	`username`

Constructor Summary

Constructors
Constructor Description

SocksAuthRequest(java.lang.String username, java.lang.String password)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`encodeAsByteBuf(ChannelBuffer channelBuffer)`	Encode socks message into its byte representation and write it into byteBuf
`java.lang.String`	`getPassword()`	Returns password that needs to be validated
`java.lang.String`	`getUsername()`	Returns username that needs to be authenticated

Methods inherited from class org.jboss.netty.handler.codec.socks.SocksRequest
getSocksRequestType

Methods inherited from class org.jboss.netty.handler.codec.socks.SocksMessage
getMessageType, getProtocolVersion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - asciiEncoder
```
private static final java.nio.charset.CharsetEncoder asciiEncoder
```
  - SUBNEGOTIATION_VERSION
```
private static final SocksMessage.SubnegotiationVersion SUBNEGOTIATION_VERSION
```
  - username
```
private final java.lang.String username
```
  - password
```
private final java.lang.String password
```
- Constructor Detail
  - SocksAuthRequest
```
public SocksAuthRequest(java.lang.String username,
                        java.lang.String password)
```
- Method Detail
  - getUsername
```
public java.lang.String getUsername()
```
    Returns username that needs to be authenticated
    
    Returns:
    
    username that needs to be authenticated
  - getPassword
```
public java.lang.String getPassword()
```
    Returns password that needs to be validated
    
    Returns:
    
    password that needs to be validated
  - encodeAsByteBuf
```
public void encodeAsByteBuf(ChannelBuffer channelBuffer)
                     throws java.lang.Exception
```
    Description copied from class: SocksMessage
    
    Encode socks message into its byte representation and write it into byteBuf
    
    Specified by:
    
    encodeAsByteBuf in class SocksMessage
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    ChannelBuffer