org.parosproxy.paros.core.proxy

Class ProxyServer

java.lang.Object

org.parosproxy.paros.core.proxy.ProxyServer

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ProxyServerSSL

public class ProxyServer
extends Object
implements Runnable

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector<CacheProcessingItem>	cacheProcessingList
protected ConnectionParam	connectionParam
protected boolean	enableCacheProcessing
protected boolean	isProxyRunning
protected Vector<ProxyListener>	listenerList
protected Vector<OverrideMessageProxyListener>	overrideListeners
protected Vector<PersistentConnectionListener>	persistentConnectionListenerList
protected static int	PORT_TIME_OUT
protected ProxyParam	proxyParam
protected ServerSocket	proxySocket
protected boolean	serialize
protected Thread	thread

Constructor Summary

Constructors

Constructor and Description
ProxyServer()
ProxyServer(String threadName)

Method Summary

Modifier and Type	Method and Description
void	addCacheProcessingList(CacheProcessingItem item)
void	addConnectRequestProxyListener(ConnectRequestProxyListener listener) Adds the given listener, that will be notified of the received CONNECT requests.
void	addOverrideMessageProxyListener(OverrideMessageProxyListener listener)
void	addPersistentConnectionListener(PersistentConnectionListener listener)
void	addProxyListener(ProxyListener listener)
protected ProxyThread	createProxyProcess(Socket clientSocket)
protected ServerSocket	createServerSocket(String ip, int port)
boolean	excludeUrl(org.apache.commons.httpclient.URI uri)
ConnectionParam	getConnectionParam()
ProxyParam	getProxyParam()
boolean	isAnyProxyThreadRunning()
boolean	isEnableApi()
boolean	isEnableCacheProcessing()
boolean	isSerialize()
void	removeConnectRequestProxyListener(ConnectRequestProxyListener listener) Removes the given listener, to no longer be notified of the received CONNECT requests.
void	removeOverrideMessageProxyListener(OverrideMessageProxyListener listener)
void	removePersistentConnectionListener(PersistentConnectionListener listener)
void	removeProxyListener(ProxyListener listener)
void	run()
void	setConnectionParam(ConnectionParam connection)
void	setEnableApi(boolean enableApi)
void	setEnableCacheProcessing(boolean enableCacheProcessing)
void	setExcludeList(List<String> urls)
void	setProxyParam(ProxyParam param)
void	setSerialize(boolean serialize)
void	setShouldPrompt(boolean shouldPrompt) Sets whether or not the ProxyServer should prompt the user for an alternate port when there is a conflict.
int	startServer(String ip, int port, boolean isDynamicPort) Starts the proxy server.
boolean	stopServer() Stops the proxy server.
protected void	writeOutput(String s)

Methods inherited from class java.lang.Object

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

Field Detail

thread

protected Thread thread

PORT_TIME_OUT

protected static final int PORT_TIME_OUT

See Also:

Constant Field Values

proxySocket

protected ServerSocket proxySocket

isProxyRunning

protected boolean isProxyRunning

proxyParam

protected ProxyParam proxyParam

connectionParam

protected ConnectionParam connectionParam

listenerList

protected Vector<ProxyListener> listenerList

overrideListeners

protected Vector<OverrideMessageProxyListener> overrideListeners

persistentConnectionListenerList

protected Vector<PersistentConnectionListener> persistentConnectionListenerList

serialize

protected boolean serialize

enableCacheProcessing

protected boolean enableCacheProcessing

cacheProcessingList

protected Vector<CacheProcessingItem> cacheProcessingList

Constructor Detail

ProxyServer

public ProxyServer()

ProxyServer

public ProxyServer(String threadName)

Method Detail

isEnableCacheProcessing

public boolean isEnableCacheProcessing()

Returns:

Returns the enableCacheProcessing.

setEnableCacheProcessing

public void setEnableCacheProcessing(boolean enableCacheProcessing)

Parameters:

enableCacheProcessing - The enableCacheProcessing to set.

isSerialize

public boolean isSerialize()

Returns:

Returns the serialize.

setProxyParam

public void setProxyParam(ProxyParam param)

getProxyParam

public ProxyParam getProxyParam()

setConnectionParam

public void setConnectionParam(ConnectionParam connection)

getConnectionParam

public ConnectionParam getConnectionParam()

startServer

public int startServer(String ip,
                       int port,
                       boolean isDynamicPort)

Starts the proxy server.

If the proxy server was already running it's stopped first.

Parameters:

ip - the IP/address the server should bind to

port - the port

isDynamicPort - true if it should use another port if the given one is already in use, false otherwise.

Returns:

the port the server is listening to, or -1 if not able to start

stopServer

public boolean stopServer()

Stops the proxy server.

Returns:

true if the proxy server was stopped, false if it was not running.

run

public void run()

Specified by:

run in interface Runnable

createServerSocket

protected ServerSocket createServerSocket(String ip,
                                          int port)
                                   throws UnknownHostException,
                                          IOException

Throws:

UnknownHostException

IOException

createProxyProcess

protected ProxyThread createProxyProcess(Socket clientSocket)

writeOutput

protected void writeOutput(String s)

addProxyListener

public void addProxyListener(ProxyListener listener)

removeProxyListener

public void removeProxyListener(ProxyListener listener)

addPersistentConnectionListener

public void addPersistentConnectionListener(PersistentConnectionListener listener)

removePersistentConnectionListener

public void removePersistentConnectionListener(PersistentConnectionListener listener)

addOverrideMessageProxyListener

public void addOverrideMessageProxyListener(OverrideMessageProxyListener listener)

removeOverrideMessageProxyListener

public void removeOverrideMessageProxyListener(OverrideMessageProxyListener listener)

addConnectRequestProxyListener

public void addConnectRequestProxyListener(ConnectRequestProxyListener listener)

Adds the given listener, that will be notified of the received CONNECT requests.

Parameters:

listener - the listener that will be added

Throws:

IllegalArgumentException - if the given listener is null.

Since:

2.5.0

removeConnectRequestProxyListener

public void removeConnectRequestProxyListener(ConnectRequestProxyListener listener)

Removes the given listener, to no longer be notified of the received CONNECT requests.

Parameters:

listener - the listener that should be removed

Throws:

IllegalArgumentException - if the given listener is null.

Since:

2.5.0

isAnyProxyThreadRunning

public boolean isAnyProxyThreadRunning()

setSerialize

public void setSerialize(boolean serialize)

Parameters:

serialize - The serialize to set.

addCacheProcessingList

public void addCacheProcessingList(CacheProcessingItem item)

setExcludeList

public void setExcludeList(List<String> urls)

excludeUrl

public boolean excludeUrl(org.apache.commons.httpclient.URI uri)

setEnableApi

public void setEnableApi(boolean enableApi)

isEnableApi

public boolean isEnableApi()

setShouldPrompt

public void setShouldPrompt(boolean shouldPrompt)

Sets whether or not the ProxyServer should prompt the user for an alternate port when there is a conflict.

Parameters:

shouldPrompt - true if the user should be prompted, false otherwise

Since:

2.9.0