Modifier and Type	Class and Description
public static interface	Socks5.Authentication A SOCKS5 authentication method.
public static class	Socks5.NoAuthenticationFactory The implementation of the `NO AUTH` authentication method defined in RFC 1928.
public static class	Socks5.UsernamePasswordAuthenticationFactory The implementation of the `USERNAME/PASSWORD` authentication method defined in RFC 1929.

Modifier and Type	Field and Description
public static final byte	ADDRESS_TYPE_DOMAIN The address type for domain names used in SOCKS5 connect requests and responses.
public static final byte	ADDRESS_TYPE_IPV4 The address type for IPv4 used in SOCKS5 connect requests and responses.
public static final byte	ADDRESS_TYPE_IPV6 The address type for IPv6 used in SOCKS5 connect requests and responses.
public static final byte	COMMAND_CONNECT The SOCKS5 `CONNECT` command used in SOCKS5 connect requests.
public static final byte	RESERVED The reserved byte value: 0.
public static final byte	VERSION The SOCKS protocol version: 5.

Access	Constructor and Description
private	Socks5()

ADDRESS_TYPE_DOMAIN	back to summary
public static final byte ADDRESS_TYPE_DOMAIN The address type for domain names used in SOCKS5 connect requests and responses.

ADDRESS_TYPE_IPV4	back to summary
public static final byte ADDRESS_TYPE_IPV4 The address type for IPv4 used in SOCKS5 connect requests and responses.

ADDRESS_TYPE_IPV6	back to summary
public static final byte ADDRESS_TYPE_IPV6 The address type for IPv6 used in SOCKS5 connect requests and responses.

COMMAND_CONNECT	back to summary
public static final byte COMMAND_CONNECT The SOCKS5 `CONNECT` command used in SOCKS5 connect requests.

RESERVED	back to summary
public static final byte RESERVED The reserved byte value: 0.

VERSION	back to summary
public static final byte VERSION The SOCKS protocol version: 5.

Socks5	back to summary
private Socks5()

org.eclipse.jetty.client back to summary

public Interface Socks5.Authentication

Known Direct Implementers: org.eclipse.jetty.client.Socks5.UsernamePasswordAuthenticationFactory.UsernamePasswordAuthentication

A SOCKS5 authentication method.

Implementations should send and receive the bytes that are specific to the particular authentication method.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	Socks5.Authentication.Factory A factory for `Authentication`s.

Method Summary

Modifier and Type	Method and Description
public void	authenticate(EndPoint the `EndPoint` to send to and receive from the SOCKS5 server endPoint, Callback the callback to complete when the authentication is complete callback) Performs the authentication send and receive bytes exchanges specific for this `Authentication`.

Method Detail

authenticate back to summary

authenticate	back to summary
public void authenticate(EndPoint endPoint, Callback callback) Performs the authentication send and receive bytes exchanges specific for this `Authentication`. Parameters endPoint:EndPoint the `EndPoint` to send to and receive from the SOCKS5 server callback:Callback the callback to complete when the authentication is complete

public void authenticate(EndPoint endPoint, Callback callback)

Performs the authentication send and receive bytes exchanges specific for this Authentication.

Parameters

endPoint:EndPoint: the EndPoint to send to and receive from the SOCKS5 server
callback:Callback: the callback to complete when the authentication is complete

org.eclipse.jetty.client back to summary

public Interface Socks5.Authentication.Factory

Known Direct Implementers: org.eclipse.jetty.client.Socks5.NoAuthenticationFactory, org.eclipse.jetty.client.Socks5.UsernamePasswordAuthenticationFactory

A factory for Authentications.

Method Summary

Modifier and Type	Method and Description
public byte	Returns: the authentication method defined by RFC 1928 getMethod()
public Socks5.Authentication	Returns: a new `Authentication` newAuthentication()

Method Detail

getMethod	back to summary
public byte getMethod() Returns:byte the authentication method defined by RFC 1928

newAuthentication	back to summary
public Socks5.Authentication newAuthentication() Returns:Socks5.Authentication a new `Authentication`

org.eclipse.jetty.client back to summary

public Class Socks5.NoAuthenticationFactory

Class Inheritance

extends Object
implements Factory

java.lang.Object
org.eclipse.jetty.client.Socks5.NoAuthenticationFactory

All Implemented Interfaces

org.eclipse.jetty.client.Socks5.Authentication.Factory

The implementation of the NO AUTH authentication method defined in RFC 1928.

Field Summary

Modifier and Type	Field and Description
public static final byte	METHOD

Constructor Summary

Access	Constructor and Description
public	NoAuthenticationFactory()

Method Summary

Modifier and Type	Method and Description
public byte	getMethod() Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod.
public Socks5.Authentication	newAuthentication() Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

METHOD	back to summary
public static final byte METHOD

Constructor Detail

NoAuthenticationFactory	back to summary
public NoAuthenticationFactory()

Method Detail

getMethod	back to summary
public byte getMethod() Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod. Returns:byte Doc from org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod. the authentication method defined by RFC 1928 Annotations @Override

getMethod

back to summary

public byte getMethod()

Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod.

Returns:byte

Doc from org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod.

the authentication method defined by RFC 1928

Annotations

@Override

newAuthentication back to summary

newAuthentication	back to summary
public Socks5.Authentication newAuthentication() Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication. Returns:Socks5.Authentication Doc from org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication. a new `Authentication` Annotations @Override

public Socks5.Authentication newAuthentication()

Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication.

Returns:Socks5.Authentication

Doc from org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication.

a new Authentication

Annotations

@Override

org.eclipse.jetty.client back to summary

public Class Socks5.UsernamePasswordAuthenticationFactory

Class Inheritance

extends Object
implements Factory

java.lang.Object
org.eclipse.jetty.client.Socks5.UsernamePasswordAuthenticationFactory

All Implemented Interfaces

org.eclipse.jetty.client.Socks5.Authentication.Factory

The implementation of the USERNAME/PASSWORD authentication method defined in RFC 1929.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Socks5.UsernamePasswordAuthenticationFactory.UsernamePasswordAuthentication

Field Summary

Modifier and Type	Field and Description
private final Charset	charset
private static final Logger	LOG
public static final byte	METHOD
private final String	password
private final String	userName
public static final byte	VERSION

Constructor Summary

Access	Constructor and Description
public	UsernamePasswordAuthenticationFactory(String userName, String password)
public	UsernamePasswordAuthenticationFactory(String userName, String password, Charset charset)

Method Summary

Modifier and Type	Method and Description
public byte	getMethod() Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod.
public Socks5.Authentication	newAuthentication() Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

charset	back to summary
private final Charset charset

LOG	back to summary
private static final Logger LOG

METHOD	back to summary
public static final byte METHOD

password	back to summary
private final String password

userName	back to summary
private final String userName

VERSION	back to summary
public static final byte VERSION

Constructor Detail

UsernamePasswordAuthenticationFactory	back to summary
public UsernamePasswordAuthenticationFactory(String userName, String password)

UsernamePasswordAuthenticationFactory	back to summary
public UsernamePasswordAuthenticationFactory(String userName, String password, Charset charset)

Method Detail

getMethod	back to summary
public byte getMethod() Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod. Returns:byte Doc from org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod. the authentication method defined by RFC 1928 Annotations @Override

getMethod

back to summary

public byte getMethod()

Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod.

Returns:byte

Doc from org.eclipse.jetty.client.Socks5.Authentication.Factory.getMethod.

the authentication method defined by RFC 1928

Annotations

@Override

newAuthentication back to summary

newAuthentication	back to summary
public Socks5.Authentication newAuthentication() Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication. Returns:Socks5.Authentication Doc from org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication. a new `Authentication` Annotations @Override

public Socks5.Authentication newAuthentication()

Implements org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication.

Returns:Socks5.Authentication

Doc from org.eclipse.jetty.client.Socks5.Authentication.Factory.newAuthentication.

a new Authentication

Annotations

@Override

org.eclipse.jetty.client back to summary

private Class Socks5.UsernamePasswordAuthenticationFactory.UsernamePasswordAuthentication

Class Inheritance

extends Object
implements Authentication, Callback

java.lang.Object
org.eclipse.jetty.client.Socks5.UsernamePasswordAuthenticationFactory.UsernamePasswordAuthentication

All Implemented Interfaces

org.eclipse.jetty.util.Callback, org.eclipse.jetty.util.thread.Invocable, org.eclipse.jetty.client.Socks5.Authentication

Field Summary

Modifier and Type	Field and Description
private final ByteBuffer	byteBuffer
private Callback	callback
private EndPoint	endPoint
private final Socks5.UsernamePasswordAuthenticationFactory	factory

Constructor Summary

Access	Constructor and Description
private	UsernamePasswordAuthentication(Socks5.UsernamePasswordAuthenticationFactory factory)

Method Summary

Modifier and Type	Method and Description
public void	authenticate(EndPoint the `EndPoint` to send to and receive from the SOCKS5 server endPoint, Callback the callback to complete when the authentication is complete callback) Implements org.eclipse.jetty.client.Socks5.Authentication.authenticate. Performs the authentication send and receive bytes exchanges specific for this `Authentication`.
private void	authenticationSent()
public void	failed(Throwable the reason for the operation failure x) Overrides default org.eclipse.jetty.util.Callback.failed. Callback invoked when the operation fails.
public Invocable.InvocationType	getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.
public void	succeeded() Overrides default org.eclipse.jetty.util.Callback.succeeded. Callback invoked when the operation completes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

byteBuffer	back to summary
private final ByteBuffer byteBuffer

callback	back to summary
private Callback callback

endPoint	back to summary
private EndPoint endPoint

factory	back to summary
private final Socks5.UsernamePasswordAuthenticationFactory factory

Constructor Detail

UsernamePasswordAuthentication	back to summary
private UsernamePasswordAuthentication(Socks5.UsernamePasswordAuthenticationFactory factory)

Method Detail

authenticate back to summary

authenticate	back to summary
public void authenticate(EndPoint endPoint, Callback callback) Implements org.eclipse.jetty.client.Socks5.Authentication.authenticate. Doc from org.eclipse.jetty.client.Socks5.Authentication.authenticate. Performs the authentication send and receive bytes exchanges specific for this `Authentication`. Parameters endPoint:EndPoint the `EndPoint` to send to and receive from the SOCKS5 server callback:Callback the callback to complete when the authentication is complete Annotations @Override

public void authenticate(EndPoint endPoint, Callback callback)

Implements org.eclipse.jetty.client.Socks5.Authentication.authenticate.

Doc from org.eclipse.jetty.client.Socks5.Authentication.authenticate.

Performs the authentication send and receive bytes exchanges specific for this Authentication.

Parameters

endPoint:EndPoint: the EndPoint to send to and receive from the SOCKS5 server
callback:Callback: the callback to complete when the authentication is complete

Annotations

@Override

authenticationSent	back to summary
private void authenticationSent()

failed	back to summary
public void failed(Throwable x) Overrides default org.eclipse.jetty.util.Callback.failed. Doc from org.eclipse.jetty.util.Callback.failed. Callback invoked when the operation fails. Parameters x:Throwable the reason for the operation failure Annotations @Override

failed

back to summary

public void failed(Throwable x)

Overrides default org.eclipse.jetty.util.Callback.failed.

Doc from org.eclipse.jetty.util.Callback.failed.

Callback invoked when the operation fails.

Parameters

x:Throwable: the reason for the operation failure

Annotations

@Override

getInvocationType	back to summary
public Invocable.InvocationType getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType. Returns:Invocable.InvocationType Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType. The InvocationType of this object Annotations @Override

getInvocationType

back to summary

public Invocable.InvocationType getInvocationType()

Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.

Returns:Invocable.InvocationType

Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType.

The InvocationType of this object

Annotations

@Override

succeeded	back to summary
public void succeeded() Overrides default org.eclipse.jetty.util.Callback.succeeded. Doc from org.eclipse.jetty.util.Callback.succeeded. Callback invoked when the operation completes. Annotations @Override

succeeded

back to summary

public void succeeded()

Overrides default org.eclipse.jetty.util.Callback.succeeded.

Doc from org.eclipse.jetty.util.Callback.succeeded.

Callback invoked when the operation completes.

Annotations

@Override