Class ProxyConnector

java.lang.Object

org.apache.mina.core.service.AbstractIoService

org.apache.mina.core.service.AbstractIoConnector

org.apache.mina.proxy.ProxyConnector

All Implemented Interfaces:

IoConnector, IoService

public class ProxyConnector
extends AbstractIoConnector

ProxyConnector.java - Decorator for SocketConnector to provide proxy support, as suggested by MINA list discussions.

Operates by intercepting connect requests and replacing the endpoint address with the proxy address, then adding a ProxyFilter as the first IoFilter which performs any necessary handshaking with the proxy before allowing data to flow normally. During the handshake, any outgoing write requests are buffered.

Since:

MINA 2.0.0-M3

See Also:

• Proxy reconnection
• Proxy support

Nested Class Summary

Nested classes/interfaces inherited from class AbstractIoService

AbstractIoService.ServiceOperationFuture

Field Summary

Fields

Modifier and Type	Field	Description
private SocketConnector	connector	Wrapped connector to use for outgoing TCP connections.
private DefaultConnectFuture	future	This future will notify it's listeners when really connected to the target
private static final TransportMetadata	METADATA
private final ProxyFilter	proxyFilter	Proxy filter instance.
private ProxyIoSession	proxyIoSession	The ProxyIoSession in use.

Fields inherited from class AbstractIoService

disposalLock, LOGGER, sessionConfig

Constructor Summary

Constructors

Constructor	Description
ProxyConnector()	Creates a new proxy connector.
ProxyConnector(SocketConnector connector)	Creates a new proxy connector.
ProxyConnector(SocketConnector connector, IoSessionConfig config, Executor executor)	Creates a new proxy connector.

Method Summary

Modifier and Type	Method	Description
void	cancelConnectFuture()	Cancels the real connection when reconnection is in use.
protected ConnectFuture	connect0(SocketAddress remoteAddress, SocketAddress localAddress, IoSessionInitializer<? extends ConnectFuture> sessionInitializer)	Connects to the specified address.
protected void	dispose0()	Implement this method to release any acquired resources.
protected ConnectFuture	fireConnected(IoSession session)	Fires the connection event on the real future to notify the client.
final SocketConnector	getConnector()
ProxyIoSession	getProxyIoSession()
IoSessionConfig	getSessionConfig()
TransportMetadata	getTransportMetadata()
private void	setConnector(SocketConnector connector)	Sets the SocketConnector to be used for connections to the proxy server.
void	setProxyIoSession(ProxyIoSession proxyIoSession)	Sets the proxy session object of this connector.

Methods inherited from class AbstractIoConnector

connect, connect, connect, connect, connect, connect, finishSessionInitialization0, getConnectTimeout, getConnectTimeoutCheckInterval, getConnectTimeoutMillis, getDefaultLocalAddress, getDefaultRemoteAddress, setConnectTimeout, setConnectTimeoutCheckInterval, setConnectTimeoutMillis, setDefaultLocalAddress, setDefaultRemoteAddress, toString

Methods inherited from class AbstractIoService

addListener, broadcast, dispose, dispose, executeWorker, executeWorker, getActivationTime, getFilterChain, getFilterChainBuilder, getHandler, getListeners, getManagedSessionCount, getManagedSessions, getScheduledWriteBytes, getScheduledWriteMessages, getSessionDataStructureFactory, getStatistics, initSession, isActive, isDisposed, isDisposing, removeListener, setFilterChainBuilder, setHandler, setSessionDataStructureFactory

Methods inherited from class Object

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

Methods inherited from interface IoService

addListener, broadcast, dispose, dispose, getActivationTime, getFilterChain, getFilterChainBuilder, getHandler, getManagedSessionCount, getManagedSessions, getScheduledWriteBytes, getScheduledWriteMessages, getSessionDataStructureFactory, getStatistics, isActive, isDisposed, isDisposing, removeListener, setFilterChainBuilder, setHandler, setSessionDataStructureFactory

Field Details

METADATA

private static final TransportMetadata METADATA

connector

private SocketConnector connector

Wrapped connector to use for outgoing TCP connections.

proxyFilter

private final ProxyFilter proxyFilter

Proxy filter instance.

proxyIoSession

private ProxyIoSession proxyIoSession

The ProxyIoSession in use.

future

private DefaultConnectFuture future

This future will notify it's listeners when really connected to the target

Constructor Details

ProxyConnector

public ProxyConnector()

Creates a new proxy connector.

ProxyConnector

public ProxyConnector(SocketConnector connector)

Creates a new proxy connector.

Parameters:

connector - Connector used to establish proxy connections.

ProxyConnector

public ProxyConnector(SocketConnector connector,
 IoSessionConfig config,
 Executor executor)

Creates a new proxy connector.

Parameters:

connector - The Connector used to establish proxy connections.

config - The session confiugarion to use

executor - The associated executor

Method Details

getSessionConfig

public IoSessionConfig getSessionConfig()

Returns:

the default configuration of the new IoSessions created by this service.

getProxyIoSession

public ProxyIoSession getProxyIoSession()

Returns:

the ProxyIoSession linked with this connector.

setProxyIoSession

public void setProxyIoSession(ProxyIoSession proxyIoSession)

Sets the proxy session object of this connector.

Parameters:

proxyIoSession - the configuration of this connector.

connect0

protected ConnectFuture connect0(SocketAddress remoteAddress,
 SocketAddress localAddress,
 IoSessionInitializer<? extends ConnectFuture> sessionInitializer)

Connects to the specified address. If communication starts successfully, events are fired to the connector's handler.

Specified by:

connect0 in class AbstractIoConnector

Parameters:

remoteAddress - the remote address to connect to

localAddress - the local address

sessionInitializer - the session initializer

Returns:

ConnectFuture that will tell the result of the connection attempt

cancelConnectFuture

public void cancelConnectFuture()

Cancels the real connection when reconnection is in use.

fireConnected

protected ConnectFuture fireConnected(IoSession session)

Fires the connection event on the real future to notify the client.

Parameters:

session - the current session

Returns:

the future holding the connected session

getConnector

public final SocketConnector getConnector()

Returns:

the SocketConnector to be used for connections to the proxy server.

setConnector

private void setConnector(SocketConnector connector)

Sets the SocketConnector to be used for connections to the proxy server.

Parameters:

connector - the connector to use

dispose0

protected void dispose0()
                 throws Exception

Implement this method to release any acquired resources. This method is invoked only once by AbstractIoService.dispose().

Specified by:

dispose0 in class AbstractIoService

Throws:

Exception - If the dispose failed

getTransportMetadata

public TransportMetadata getTransportMetadata()

Returns:

the TransportMetadata that this service runs on.