Package io.netty.handler.codec.socksx.v5

Class Socks5PrivateAuthStatus

java.lang.Object

io.netty.handler.codec.socksx.v5.Socks5PrivateAuthStatus

All Implemented Interfaces:

Comparable<Socks5PrivateAuthStatus>

public final class Socks5PrivateAuthStatus
extends Object
implements Comparable<Socks5PrivateAuthStatus>

The status of a SOCKS5 private authentication response.

RFC 1928 reserves method codes 0x80-0xFE for private authentication methods but does not specify the format of their subnegotiation. This class provides standard status codes for the private authentication response that follow the pattern established by the username/password authentication method in RFC 1929.

See Also:

RFC 1928 Section 3, RFC 1929

Field Summary

Fields

Modifier and Type	Field	Description
static Socks5PrivateAuthStatus	FAILURE
static Socks5PrivateAuthStatus	SUCCESS

Constructor Summary

Constructors

Constructor	Description
Socks5PrivateAuthStatus(int byteValue, String name)	Creates a new SOCKS5 private authentication status.

Method Summary

Modifier and Type	Method	Description
byte	byteValue()
int	compareTo(Socks5PrivateAuthStatus o)
boolean	equals(Object obj)
int	hashCode()
boolean	isSuccess()
String	toString()
static Socks5PrivateAuthStatus	valueOf(byte b)	Returns the Socks5PrivateAuthStatus instance that corresponds to the specified byte value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SUCCESS

public static final Socks5PrivateAuthStatus SUCCESS

FAILURE

public static final Socks5PrivateAuthStatus FAILURE

Constructor Detail

Socks5PrivateAuthStatus

public Socks5PrivateAuthStatus(int byteValue,
                               String name)

Creates a new SOCKS5 private authentication status.

Parameters:

byteValue - The byte value representing the authentication status (0x00 for success, 0xFF for failure, or custom values)

name - The descriptive name of this status, must not be null

Throws:

NullPointerException - if the name is null

Method Detail

valueOf

public static Socks5PrivateAuthStatus valueOf(byte b)

Returns the Socks5PrivateAuthStatus instance that corresponds to the specified byte value.

This method returns a singleton instance for standard status codes:

• 0x00: SUCCESS
• 0xFF: FAILURE

For any other values, a new instance is created.

Parameters:

b - The byte value of the SOCKS5 private authentication status

Returns:

The corresponding Socks5PrivateAuthStatus instance

byteValue

public byte byteValue()

isSuccess

public boolean isSuccess()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Socks5PrivateAuthStatus o)

Specified by:

compareTo in interface Comparable<Socks5PrivateAuthStatus>

toString

public String toString()

Overrides:

toString in class Object