Proxy (Maverick Legacy - Client Assembly 1.7.58 API)

java.lang.Object
- socks.Proxy

Direct Known Subclasses:

Socks4Proxy, Socks5Proxy
```
public abstract class Proxy
extends Object
```
Abstract class Proxy, base for classes Socks4Proxy and Socks5Proxy. Defines methods for specifying default proxy, to be used by all classes of this package.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Proxy`	`chainProxy`
`protected static Proxy`	`defaultProxy`
`protected InetRange`	`directHosts`
`protected InputStream`	`in`
`protected OutputStream`	`out`
`protected String`	`proxyHost`
`protected InetAddress`	`proxyIP`
`protected int`	`proxyPort`
`protected Socket`	`proxySocket`
`static int`	`SOCKS_ADDR_NOT_SUPPORTED`
`static int`	`SOCKS_AUTH_FAILURE`
`static int`	`SOCKS_AUTH_NOT_SUPPORTED`
`static int`	`SOCKS_BADCONNECT`
`static int`	`SOCKS_BADNETWORK`
`static int`	`SOCKS_CMD_NOT_SUPPORTED`
`static int`	`SOCKS_CONNECTION_REFUSED`
`static int`	`SOCKS_DIRECT_FAILED`
`static int`	`SOCKS_FAILURE`
`static int`	`SOCKS_HOST_UNREACHABLE`
`static int`	`SOCKS_JUST_ERROR`
`static int`	`SOCKS_METHOD_NOTSUPPORTED`
`static int`	`SOCKS_NO_PROXY`
`static int`	`SOCKS_PROXY_IO_ERROR`
`static int`	`SOCKS_PROXY_NO_CONNECT`
`static int`	`SOCKS_SUCCESS`
`static int`	`SOCKS_TTL_EXPIRE`
`protected int`	`version`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected ProxyMessage`	`accept()`
`void`	`addDirect(InetAddress ip)` Adds given ip to the list of direct addresses.
`void`	`addDirect(InetAddress from, InetAddress to)` Adds given range of addresses to the lsit of direct addresses, machines within this range will be accessed without using proxy.
`boolean`	`addDirect(String host)` Adds host to the list of direct addresses.
`protected ProxyMessage`	`bind(InetAddress ip, int port)`
`protected ProxyMessage`	`bind(String host, int port)`
`protected ProxyMessage`	`connect(InetAddress ip, int port)`
`protected ProxyMessage`	`connect(String host, int port)`
`protected abstract Proxy`	`copy()`
`protected void`	`endSession()`
`protected ProxyMessage`	`exchange(ProxyMessage request)` Sends the request reads reply and returns it throws exception if something wrong with IO or the reply code is not zero
`protected abstract ProxyMessage`	`formMessage(InputStream in)`
`protected abstract ProxyMessage`	`formMessage(int cmd, InetAddress ip, int port)`
`protected abstract ProxyMessage`	`formMessage(int cmd, String host, int port)`
`Proxy`	`getChainProxy()` Get proxy which is used to connect to this proxy.
`static Proxy`	`getDefaultProxy()` Get current default proxy.
`InetRange`	`getDirect()` Get the list of direct hosts.
`InetAddress`	`getInetAddress()` Get the ip address of the proxy server host.
`int`	`getPort()` Get the port on which proxy server is running.
`boolean`	`isDirect(InetAddress host)` Check wether the given host is on the list of direct addresses.
`boolean`	`isDirect(String host)` Check wether the given host is on the list of direct address.
`static Proxy`	`parseProxy(String proxy_entry)` Parses strings in the form: host[:port:user:password], and creates proxy from information obtained from parsing.
`protected ProxyMessage`	`readMsg()` Reads the reply from the SOCKS server
`protected void`	`sendMsg(ProxyMessage msg)` Sends the request to SOCKS server
`void`	`setChainProxy(Proxy chainProxy)` Set the proxy which should be used to connect to given proxy.
`static void`	`setDefaultProxy(InetAddress ipAddress, int port)` Sets SOCKS5 proxy as default.
`static void`	`setDefaultProxy(InetAddress ipAddress, int port, String user)` Sets SOCKS4 proxy as default.
`static void`	`setDefaultProxy(Proxy p)` Sets default proxy.
`static void`	`setDefaultProxy(String hostName, int port)` Sets SOCKS5 proxy as default.
`static void`	`setDefaultProxy(String hostName, int port, String user)` Sets SOCKS4 proxy as default.
`void`	`setDirect(InetRange ir)` Sets given InetRange as the list of direct address, previous list will be discarded, any changes done previously with addDirect(Inetaddress) will be lost.
`protected void`	`startSession()`
`String`	`toString()` Get string representation of this proxy.
`protected ProxyMessage`	`udpAssociate(InetAddress ip, int port)`
`protected ProxyMessage`	`udpAssociate(String host, int port)`

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

Field Detail

directHosts
```
protected InetRange directHosts
```

proxyIP
```
protected InetAddress proxyIP
```

proxyHost
```
protected String proxyHost
```

proxyPort
```
protected int proxyPort
```

proxySocket
```
protected Socket proxySocket
```

in
```
protected InputStream in
```

out
```
protected OutputStream out
```

version
```
protected int version
```

chainProxy
```
protected Proxy chainProxy
```

defaultProxy
```
protected static Proxy defaultProxy
```

SOCKS_SUCCESS
```
public static final int SOCKS_SUCCESS
```
See Also:

Constant Field Values

SOCKS_FAILURE
```
public static final int SOCKS_FAILURE
```
See Also:

Constant Field Values

SOCKS_BADCONNECT
```
public static final int SOCKS_BADCONNECT
```
See Also:

Constant Field Values

SOCKS_BADNETWORK
```
public static final int SOCKS_BADNETWORK
```
See Also:

Constant Field Values

SOCKS_HOST_UNREACHABLE
```
public static final int SOCKS_HOST_UNREACHABLE
```
See Also:

Constant Field Values

SOCKS_CONNECTION_REFUSED
```
public static final int SOCKS_CONNECTION_REFUSED
```
See Also:

Constant Field Values

SOCKS_TTL_EXPIRE
```
public static final int SOCKS_TTL_EXPIRE
```
See Also:

Constant Field Values

SOCKS_CMD_NOT_SUPPORTED
```
public static final int SOCKS_CMD_NOT_SUPPORTED
```
See Also:

Constant Field Values

SOCKS_ADDR_NOT_SUPPORTED
```
public static final int SOCKS_ADDR_NOT_SUPPORTED
```
See Also:

Constant Field Values

SOCKS_NO_PROXY
```
public static final int SOCKS_NO_PROXY
```
See Also:

Constant Field Values

SOCKS_PROXY_NO_CONNECT
```
public static final int SOCKS_PROXY_NO_CONNECT
```
See Also:

Constant Field Values

SOCKS_PROXY_IO_ERROR
```
public static final int SOCKS_PROXY_IO_ERROR
```
See Also:

Constant Field Values

SOCKS_AUTH_NOT_SUPPORTED
```
public static final int SOCKS_AUTH_NOT_SUPPORTED
```
See Also:

Constant Field Values

SOCKS_AUTH_FAILURE
```
public static final int SOCKS_AUTH_FAILURE
```
See Also:

Constant Field Values

SOCKS_JUST_ERROR
```
public static final int SOCKS_JUST_ERROR
```
See Also:

Constant Field Values

SOCKS_DIRECT_FAILED
```
public static final int SOCKS_DIRECT_FAILED
```
See Also:

Constant Field Values

SOCKS_METHOD_NOTSUPPORTED
```
public static final int SOCKS_METHOD_NOTSUPPORTED
```
See Also:

Constant Field Values

Method Detail
- getPort
```
public int getPort()
```
  Get the port on which proxy server is running.
  
  Returns:
  
  Proxy port.
- getInetAddress
```
public InetAddress getInetAddress()
```
  Get the ip address of the proxy server host.
  
  Returns:
  
  Proxy InetAddress.
- addDirect
```
public void addDirect(InetAddress ip)
```
  Adds given ip to the list of direct addresses. This machine will be accessed without using proxy.
- addDirect
```
public boolean addDirect(String host)
```
  Adds host to the list of direct addresses. This machine will be accessed without using proxy.
- addDirect
```
public void addDirect(InetAddress from,
                      InetAddress to)
```
  Adds given range of addresses to the lsit of direct addresses, machines within this range will be accessed without using proxy.
- setDirect
```
public void setDirect(InetRange ir)
```
  Sets given InetRange as the list of direct address, previous list will be discarded, any changes done previously with addDirect(Inetaddress) will be lost. The machines in this range will be accessed without using proxy.
  
  Parameters:
  
  ir - InetRange which should be used to look up direct addresses.
  
  See Also:
  
  InetRange
- getDirect
```
public InetRange getDirect()
```
  Get the list of direct hosts.
  
  Returns:
  
  Current range of direct address as InetRange object.
  
  See Also:
  
  InetRange
- isDirect
```
public boolean isDirect(String host)
```
  Check wether the given host is on the list of direct address.
  
  Parameters:
  
  host - Host name to check.
  
  Returns:
  
  true if the given host is specified as the direct addresses.
- isDirect
```
public boolean isDirect(InetAddress host)
```
  Check wether the given host is on the list of direct addresses.
  
  Parameters:
  
  host - Host address to check.
  
  Returns:
  
  true if the given host is specified as the direct address.
- setChainProxy
```
public void setChainProxy(Proxy chainProxy)
```
  Set the proxy which should be used to connect to given proxy.
  
  Parameters:
  
  chainProxy - Proxy to use to connect to this proxy.
- getChainProxy
```
public Proxy getChainProxy()
```
  Get proxy which is used to connect to this proxy.
  
  Returns:
  
  Proxy which is used to connect to this proxy, or null if proxy is to be contacted directly.
- toString
```
public String toString()
```
  Get string representation of this proxy.
  
  Overrides:
  
  toString in class Object
- setDefaultProxy
```
public static void setDefaultProxy(String hostName,
                                   int port,
                                   String user)
                            throws UnknownHostException
```
  Sets SOCKS4 proxy as default.
  
  Parameters:
  
  hostName - Host name on which SOCKS4 server is running.
  
  port - Port on which SOCKS4 server is running.
  
  user - Username to use for communications with proxy.
  
  Throws:
  
  UnknownHostException
- setDefaultProxy
```
public static void setDefaultProxy(InetAddress ipAddress,
                                   int port,
                                   String user)
```
  Sets SOCKS4 proxy as default.
  
  Parameters:
  
  ipAddress - Host address on which SOCKS4 server is running.
  
  port - Port on which SOCKS4 server is running.
  
  user - Username to use for communications with proxy.
- setDefaultProxy
```
public static void setDefaultProxy(String hostName,
                                   int port)
                            throws UnknownHostException
```
  Sets SOCKS5 proxy as default. Default proxy only supports no-authentication.
  
  Parameters:
  
  hostName - Host name on which SOCKS5 server is running.
  
  port - Port on which SOCKS5 server is running.
  
  Throws:
  
  UnknownHostException
- setDefaultProxy
```
public static void setDefaultProxy(InetAddress ipAddress,
                                   int port)
```
  Sets SOCKS5 proxy as default. Default proxy only supports no-authentication.
  
  Parameters:
  
  ipAddress - Host address on which SOCKS5 server is running.
  
  port - Port on which SOCKS5 server is running.
- setDefaultProxy
```
public static void setDefaultProxy(Proxy p)
```
  Sets default proxy.
  
  Parameters:
  
  p - Proxy to use as default proxy.
- getDefaultProxy
```
public static Proxy getDefaultProxy()
```
  Get current default proxy.
  
  Returns:
  
  Current default proxy, or null if none is set.
- parseProxy
```
public static Proxy parseProxy(String proxy_entry)
```
  Parses strings in the form: host[:port:user:password], and creates proxy from information obtained from parsing.
  Defaults: port = 1080.
  If user specified but not password, creates Socks4Proxy, if user not specified creates Socks5Proxy, if both user and password are speciefied creates Socks5Proxy with user/password authentication.
  
  Parameters:
  
  proxy_entry - String in the form host[:port:user:password]
  
  Returns:
  
  Proxy created from the string, null if entry was somehow invalid(host unknown for example, or empty string)
- startSession
```
protected void startSession()
                     throws SocksException
```
  Throws:
  
  SocksException
- copy
```
protected abstract Proxy copy()
```
- formMessage
```
protected abstract ProxyMessage formMessage(int cmd,
                                            InetAddress ip,
                                            int port)
```
- formMessage
```
protected abstract ProxyMessage formMessage(int cmd,
                                            String host,
                                            int port)
                                     throws UnknownHostException
```
  Throws:
  
  UnknownHostException
- formMessage
```
protected abstract ProxyMessage formMessage(InputStream in)
                                     throws SocksException,
                                            IOException
```
  Throws:
  
  SocksException
  
  IOException
- connect
```
protected ProxyMessage connect(InetAddress ip,
                               int port)
                        throws SocksException
```
  Throws:
  
  SocksException
- connect
```
protected ProxyMessage connect(String host,
                               int port)
                        throws UnknownHostException,
                               SocksException
```
  Throws:
  
  UnknownHostException
  
  SocksException
- bind
```
protected ProxyMessage bind(InetAddress ip,
                            int port)
                     throws SocksException
```
  Throws:
  
  SocksException
- bind
```
protected ProxyMessage bind(String host,
                            int port)
                     throws UnknownHostException,
                            SocksException
```
  Throws:
  
  UnknownHostException
  
  SocksException
- accept
```
protected ProxyMessage accept()
                       throws IOException,
                              SocksException
```
  Throws:
  
  IOException
  
  SocksException
- udpAssociate
```
protected ProxyMessage udpAssociate(InetAddress ip,
                                    int port)
                             throws SocksException
```
  Throws:
  
  SocksException
- udpAssociate
```
protected ProxyMessage udpAssociate(String host,
                                    int port)
                             throws UnknownHostException,
                                    SocksException
```
  Throws:
  
  UnknownHostException
  
  SocksException
- endSession
```
protected void endSession()
```
- sendMsg
```
protected void sendMsg(ProxyMessage msg)
                throws SocksException,
                       IOException
```
  Sends the request to SOCKS server
  
  Throws:
  
  SocksException
  
  IOException
- readMsg
```
protected ProxyMessage readMsg()
                        throws SocksException,
                               IOException
```
  Reads the reply from the SOCKS server
  
  Throws:
  
  SocksException
  
  IOException
- exchange
```
protected ProxyMessage exchange(ProxyMessage request)
                         throws SocksException
```
  Sends the request reads reply and returns it throws exception if something wrong with IO or the reply code is not zero
  
  Throws:
  
  SocksException

Class Proxy

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

directHosts

proxyIP

proxyHost

proxyPort

proxySocket

in

out

version

chainProxy

defaultProxy

SOCKS_SUCCESS

SOCKS_FAILURE

SOCKS_BADCONNECT

SOCKS_BADNETWORK

SOCKS_HOST_UNREACHABLE

SOCKS_CONNECTION_REFUSED

SOCKS_TTL_EXPIRE

SOCKS_CMD_NOT_SUPPORTED

SOCKS_ADDR_NOT_SUPPORTED

SOCKS_NO_PROXY

SOCKS_PROXY_NO_CONNECT

SOCKS_PROXY_IO_ERROR

SOCKS_AUTH_NOT_SUPPORTED

SOCKS_AUTH_FAILURE

SOCKS_JUST_ERROR

SOCKS_DIRECT_FAILED

SOCKS_METHOD_NOTSUPPORTED

Method Detail

getPort

getInetAddress

addDirect

addDirect

addDirect

setDirect

getDirect

isDirect

isDirect

setChainProxy

getChainProxy

toString

setDefaultProxy

setDefaultProxy

setDefaultProxy

setDefaultProxy

setDefaultProxy

getDefaultProxy

parseProxy

startSession

copy

formMessage

formMessage

formMessage

connect

connect

bind

bind

accept

udpAssociate

udpAssociate

endSession

sendMsg

readMsg

exchange