fucksocks.server

Class GenericSocksProxyServer

java.lang.Object

fucksocks.server.GenericSocksProxyServer

All Implemented Interfaces:

SocksProxyServer, Runnable

Direct Known Subclasses:

SSLSocksProxyServer

public class GenericSocksProxyServer
extends Object
implements SocksProxyServer, Runnable

The class GenericSocksProxyServer is a implementation of SocksProxyServer.
You can create a SOKCS5 server easily by following codes:

 ProxyServer proxyServer = new GenericSocksProxyServer(Socks5Handler.class);
 proxyServer.start(); // Create a SOCKS5 server bind at 1080.
 

If you want change the port, you can using following codes:

 proxyServer.start(9999);
 

Version:

1.0

Author:

Youchao Feng

date

Apr 19, 2015 1:10:17 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
protected static int	THREAD_NUMBER Number of threads in thread pool.

Fields inherited from interface fucksocks.server.SocksProxyServer

DEFAULT_SOCKS_PORT

Constructor Summary

Constructors

Constructor and Description
GenericSocksProxyServer(Class<? extends SocksHandler> socketHandlerClass) Constructs a GenericSocksProxyServer by a SocksHandler class.
GenericSocksProxyServer(Class<? extends SocksHandler> socketHandlerClass, ExecutorService executorService) Constructs a GenericSocksProxyServer by a SocksHandler class and a ExecutorService.
GenericSocksProxyServer(Class<? extends SocksHandler> socketHandlerClass, int port) Constructs a GenericSocksProxyServer by a SocksHandler class and a port.
GenericSocksProxyServer(Class<? extends SocksHandler> socketHandlerClass, int port, ExecutorService executorService) Constructs a GenericSocksProxyServer by a SocksHandler class , a port and a ExecutorService.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSessionFilter(SessionFilter sessionFilter) Adds SessionFilter.
void	addSocksCommandFilter(SocksCommandFilter socksListener) Adds a SocksCommandFilter.
protected void	closeAllSession() Closes all sessions.
protected ServerSocket	createServerSocket(int bindPort)
SocksHandler	createSocksHandler() Create an instance SocksHandler.
int	getBindPort()
int	getBufferSize() Returns buffer size.
ExecutorService	getExecutorService()
Map<Long,Session>	getManagedSessions() Gets all sessions that SOKCS server managed.
SocksProxy	getProxy()
SessionFilterChain	getSessionFilterChain()
int	getTimeout() Returns timeout.
void	initializeSocksHandler(SocksHandler socksHandler) Initializes SocksHandler.
void	removeSessionFilter(SessionFilter sessionFilter) Removes SessionFilter.
void	removeSocksCommandFilter(SocksCommandFilter socksListener) Removes a SocksCommandFilter.
void	run()
void	setBindPort(int bindPort)
void	setBufferSize(int bufferSize) Sets buffer size.
void	setExecutorService(ExecutorService executorService)
void	setProxy(SocksProxy proxy)
void	setSessionFilterChain(SessionFilterChain sessionFilterChain)
void	setSupportMethods(SocksMethod... methods) Sets the methods that socks server supports.
void	setTimeout(int timeout) Sets timeout.
void	shutdown() Shutdown a SOCKS server.
void	start() Starts a SOCKS server.
void	start(int bindPort) Starts a SOCKS server and binds a port.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final org.slf4j.Logger logger

THREAD_NUMBER

protected static final int THREAD_NUMBER

Number of threads in thread pool.

See Also:

Constant Field Values

Constructor Detail

GenericSocksProxyServer

public GenericSocksProxyServer(Class<? extends SocksHandler> socketHandlerClass)

Constructs a GenericSocksProxyServer by a SocksHandler class. The bind port is 1080.

Parameters:

socketHandlerClass - SocksHandler class.

GenericSocksProxyServer

public GenericSocksProxyServer(Class<? extends SocksHandler> socketHandlerClass,
                       int port)

Constructs a GenericSocksProxyServer by a SocksHandler class and a port.

Parameters:

socketHandlerClass - SocksHandler class.

port - The port that SOCKS server will listen.

GenericSocksProxyServer

public GenericSocksProxyServer(Class<? extends SocksHandler> socketHandlerClass,
                       ExecutorService executorService)

Constructs a GenericSocksProxyServer by a SocksHandler class and a ExecutorService.

Parameters:

socketHandlerClass - SocksHandler class.

executorService - Thread pool.

GenericSocksProxyServer

public GenericSocksProxyServer(Class<? extends SocksHandler> socketHandlerClass,
                       int port,
                       ExecutorService executorService)

Constructs a GenericSocksProxyServer by a SocksHandler class , a port and a ExecutorService.

Parameters:

socketHandlerClass - SocksHandler class.

port - The port that SOCKS server will listen.

executorService - Thread pool.

Method Detail

run

public void run()

Specified by:

run in interface Runnable

setExecutorService

public void setExecutorService(ExecutorService executorService)

shutdown

public void shutdown()

Description copied from interface: SocksProxyServer

Shutdown a SOCKS server.

Specified by:

shutdown in interface SocksProxyServer

start

public void start()
           throws IOException

Description copied from interface: SocksProxyServer

Starts a SOCKS server.

Specified by:

start in interface SocksProxyServer

Throws:

IOException - If any I/O error occurs.

start

public void start(int bindPort)
           throws IOException

Description copied from interface: SocksProxyServer

Starts a SOCKS server and binds a port.

Specified by:

start in interface SocksProxyServer

Parameters:

bindPort - The port that SOCKS server listened..

Throws:

IOException - If any I/O error occurs.

createServerSocket

protected ServerSocket createServerSocket(int bindPort)
                                   throws IOException

Throws:

IOException

createSocksHandler

public SocksHandler createSocksHandler()

Description copied from interface: SocksProxyServer

Create an instance SocksHandler.

Specified by:

createSocksHandler in interface SocksProxyServer

Returns:

Instance of SocksHandler.

initializeSocksHandler

public void initializeSocksHandler(SocksHandler socksHandler)

Description copied from interface: SocksProxyServer

Initializes SocksHandler.

Specified by:

initializeSocksHandler in interface SocksProxyServer

Parameters:

socksHandler - The instance of SocksHandler.

closeAllSession

protected void closeAllSession()

Closes all sessions.

getExecutorService

public ExecutorService getExecutorService()

getManagedSessions

public Map<Long,Session> getManagedSessions()

Description copied from interface: SocksProxyServer

Gets all sessions that SOKCS server managed.

Specified by:

getManagedSessions in interface SocksProxyServer

Returns:

All sessions that SOCKS server managed.

setSupportMethods

public void setSupportMethods(SocksMethod... methods)

Description copied from interface: SocksProxyServer

Sets the methods that socks server supports.

Specified by:

setSupportMethods in interface SocksProxyServer

Parameters:

methods - The methods that SOCKS server sports.

getTimeout

public int getTimeout()

Description copied from interface: SocksProxyServer

Returns timeout.

Specified by:

getTimeout in interface SocksProxyServer

Returns:

Timeout.

setTimeout

public void setTimeout(int timeout)

Description copied from interface: SocksProxyServer

Sets timeout.

Specified by:

setTimeout in interface SocksProxyServer

Parameters:

timeout - timeout.

getBufferSize

public int getBufferSize()

Description copied from interface: SocksProxyServer

Returns buffer size.

Specified by:

getBufferSize in interface SocksProxyServer

Returns:

Buffer size.

setBufferSize

public void setBufferSize(int bufferSize)

Description copied from interface: SocksProxyServer

Sets buffer size.

Specified by:

setBufferSize in interface SocksProxyServer

Parameters:

bufferSize - Buffer size.

addSocksCommandFilter

public void addSocksCommandFilter(SocksCommandFilter socksListener)

Description copied from interface: SocksProxyServer

Adds a SocksCommandFilter.

Specified by:

addSocksCommandFilter in interface SocksProxyServer

Parameters:

socksListener - Instance of SocksCommandFilter.

removeSocksCommandFilter

public void removeSocksCommandFilter(SocksCommandFilter socksListener)

Description copied from interface: SocksProxyServer

Removes a SocksCommandFilter.

Specified by:

removeSocksCommandFilter in interface SocksProxyServer

Parameters:

socksListener - Instance of SocksCommandFilter.

addSessionFilter

public void addSessionFilter(SessionFilter sessionFilter)

Description copied from interface: SocksProxyServer

Adds SessionFilter.

Specified by:

addSessionFilter in interface SocksProxyServer

Parameters:

sessionFilter - Instance of SessionFilter.

removeSessionFilter

public void removeSessionFilter(SessionFilter sessionFilter)

Description copied from interface: SocksProxyServer

Removes SessionFilter.

Specified by:

removeSessionFilter in interface SocksProxyServer

Parameters:

sessionFilter - Instance of SessionFilter.

getProxy

public SocksProxy getProxy()

Specified by:

getProxy in interface SocksProxyServer

setProxy

public void setProxy(SocksProxy proxy)

Specified by:

setProxy in interface SocksProxyServer

getBindPort

public int getBindPort()

Specified by:

getBindPort in interface SocksProxyServer

setBindPort

public void setBindPort(int bindPort)

Specified by:

setBindPort in interface SocksProxyServer

getSessionFilterChain

public SessionFilterChain getSessionFilterChain()

setSessionFilterChain

public void setSessionFilterChain(SessionFilterChain sessionFilterChain)