org.zaproxy.zap.network

Class SocksProxy

java.lang.Object

org.zaproxy.zap.network.SocksProxy

public class SocksProxy
extends Object

A SOCKS proxy.

Contains the host, port, version, and if names should be resolved by the proxy.

Since:

2.10.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocksProxy.Version The version of the SOCKS proxy.

Constructor Summary

Constructors

Constructor and Description
SocksProxy(String host, int port) Constructs a SocksProxy with the given host and port.
SocksProxy(String host, int port, SocksProxy.Version version, boolean useDns) Constructs a SocksProxy with the given data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getHost() Gets the host (name or address).
int	getPort() Gets the port.
SocksProxy.Version	getVersion() Gets the version.
int	hashCode()
boolean	isUseDns() Tells whether or not the names should be resolved by the proxy.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SocksProxy

public SocksProxy(String host,
                  int port)

Constructs a SocksProxy with the given host and port.

Uses SocksProxy.Version.SOCKS5 and names are resolved by the proxy.

Parameters:

host - the host, must not be null or empty.

port - the port.

Throws:

NullPointerException - if the host is null.

IllegalArgumentException - if the host is empty or the port is not a valid port number.

SocksProxy

public SocksProxy(String host,
                  int port,
                  SocksProxy.Version version,
                  boolean useDns)

Constructs a SocksProxy with the given data.

Parameters:

host - the host, must not be null or empty.

port - the port.

version - the version, must not be null.

useDns - true if the names should be resolved by the proxy, false otherwise.

Throws:

NullPointerException - if the host or version is null.

IllegalArgumentException - if the host is empty or the port is not a valid port number.

Method Detail

getHost

public String getHost()

Gets the host (name or address).

Returns:

the host, never null or empty.

getPort

public int getPort()

Gets the port.

Returns:

the port.

getVersion

public SocksProxy.Version getVersion()

Gets the version.

Returns:

the version, never null.

isUseDns

public boolean isUseDns()

Tells whether or not the names should be resolved by the proxy.

Only supported by SocksProxy.Version.SOCKS5.

Returns:

true if the names should be resolved by the proxy, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object