com.sshtools.synergy.nio

Class ProtocolContext

java.lang.Object

com.sshtools.synergy.nio.ProtocolContext

Direct Known Subclasses:

SshContext

public abstract class ProtocolContext
extends java.lang.Object

A protocol context defines the behavior for a listening interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	keepAlive
protected int	receiveBufferSize
protected boolean	reuseAddress
protected int	sendBufferSize
protected boolean	tcpNoDelay

Constructor Summary

Constructors

Constructor and Description
ProtocolContext()

Method Summary

Modifier and Type	Method and Description
protected abstract ProtocolEngine	createEngine(ConnectRequestFuture connectFuture) Create a protocol engine.
void	enableHTTPProxy(java.lang.String proxyHostname, int proxyPort)
void	enableHTTPProxy(java.lang.String proxyHostname, int proxyPort, java.lang.String proxyUsername, java.lang.String proxyPassword)
void	enableHTTPProxy(java.lang.String proxyHostname, int proxyPort, java.lang.String proxyUsername, java.lang.String proxyPassword, java.lang.String userAgent)
void	enableHTTPProxy(java.lang.String proxyHostname, int proxyPort, java.lang.String proxyUsername, java.lang.String proxyPassword, java.lang.String userAgent, java.util.Map<java.lang.String,java.lang.String> optionalHeaders)
void	enableSocks4Proxy(java.lang.String proxyHostname, int proxyPort, java.lang.String proxyUsername)
void	enableSocks5Proxy(java.lang.String proxyHostname, int proxyPort, java.lang.String proxyUsername, java.lang.String proxyPassword, boolean localLookup)
java.util.Map<java.lang.String,java.lang.String>	getOptionalHeaders()
java.lang.String	getProxyHostname()
java.lang.String	getProxyPassword()
int	getProxyPort()
ProxyType	getProxyType()
java.lang.String	getProxyUsername()
int	getReceiveBufferSize() Get the socket receive buffer size.
int	getSendBufferSize() Get the socket send buffer size.
SocketConnectionFactory	getSocketConnectionFactory()
boolean	getSocketOptionKeepAlive() Indicates whether the SO_KEEPALIVE socket option is set on connected sockets.
boolean	getSocketOptionReuseAddress() Indicates whether the SO_REUSEADDR socket option will be set on a server socket.
boolean	getSocketOptionTcpNoDelay() Indicates whether the TCP_NODELAY socket option is set on connected sockets.
java.lang.String	getUserAgent()
boolean	isProxyEnabled()
boolean	isResolveLocally()
void	setReceiveBufferSize(int receiveBufferSize) Set the receive buffer size for sockets.
void	setSendBufferSize(int sendBufferSize) Set the send buffer size for sockets.
void	setSocketConnectionFactory(SocketConnectionFactory socketConnectionFactory)
void	setSocketOptionKeepAlive(boolean keepAlive) Set the SO_KEEPALIVE socket option on connected sockets.
void	setSocketOptionReuseAddress(boolean reuseAddress) Indicates whether the SO_REUSEADDR socket option will be set on a server socket.
void	setSocketOptionTcpNoDelay(boolean tcpNoDelay) Set the TCP_NODELAY socket option on connected sockets.
abstract void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

keepAlive

protected boolean keepAlive

tcpNoDelay

protected boolean tcpNoDelay

reuseAddress

protected boolean reuseAddress

receiveBufferSize

protected int receiveBufferSize

sendBufferSize

protected int sendBufferSize

Constructor Detail

ProtocolContext

public ProtocolContext()

Method Detail

createEngine

protected abstract ProtocolEngine createEngine(ConnectRequestFuture connectFuture)
                                        throws java.io.IOException

Create a protocol engine.

Returns:

ProtocolEngine

Throws:

java.io.IOException

getSocketOptionKeepAlive

public boolean getSocketOptionKeepAlive()

Indicates whether the SO_KEEPALIVE socket option is set on connected sockets.

Returns:

boolean

getSocketOptionReuseAddress

public boolean getSocketOptionReuseAddress()

Indicates whether the SO_REUSEADDR socket option will be set on a server socket.

Returns:

boolean

setSocketOptionReuseAddress

public void setSocketOptionReuseAddress(boolean reuseAddress)

Indicates whether the SO_REUSEADDR socket option will be set on a server socket.

Parameters:

reuseAddress - boolean

setSocketOptionKeepAlive

public void setSocketOptionKeepAlive(boolean keepAlive)

Set the SO_KEEPALIVE socket option on connected sockets.

Parameters:

keepAlive - boolean

getSocketOptionTcpNoDelay

public boolean getSocketOptionTcpNoDelay()

Indicates whether the TCP_NODELAY socket option is set on connected sockets.

Returns:

boolean

setSocketOptionTcpNoDelay

public void setSocketOptionTcpNoDelay(boolean tcpNoDelay)

Set the TCP_NODELAY socket option on connected sockets.

Parameters:

tcpNoDelay - boolean

setReceiveBufferSize

public void setReceiveBufferSize(int receiveBufferSize)

Set the receive buffer size for sockets.

Parameters:

receiveBufferSize - int

setSendBufferSize

public void setSendBufferSize(int sendBufferSize)

Set the send buffer size for sockets.

Parameters:

sendBufferSize - int

getReceiveBufferSize

public int getReceiveBufferSize()

Get the socket receive buffer size.

Returns:

int

getSendBufferSize

public int getSendBufferSize()

Get the socket send buffer size.

Returns:

int

getSocketConnectionFactory

public SocketConnectionFactory getSocketConnectionFactory()

setSocketConnectionFactory

public void setSocketConnectionFactory(SocketConnectionFactory socketConnectionFactory)

shutdown

public abstract void shutdown()

enableSocks4Proxy

public void enableSocks4Proxy(java.lang.String proxyHostname,
                              int proxyPort,
                              java.lang.String proxyUsername)

enableSocks5Proxy

public void enableSocks5Proxy(java.lang.String proxyHostname,
                              int proxyPort,
                              java.lang.String proxyUsername,
                              java.lang.String proxyPassword,
                              boolean localLookup)

enableHTTPProxy

public void enableHTTPProxy(java.lang.String proxyHostname,
                            int proxyPort)

enableHTTPProxy

public void enableHTTPProxy(java.lang.String proxyHostname,
                            int proxyPort,
                            java.lang.String proxyUsername,
                            java.lang.String proxyPassword)

enableHTTPProxy

public void enableHTTPProxy(java.lang.String proxyHostname,
                            int proxyPort,
                            java.lang.String proxyUsername,
                            java.lang.String proxyPassword,
                            java.lang.String userAgent)

enableHTTPProxy

public void enableHTTPProxy(java.lang.String proxyHostname,
                            int proxyPort,
                            java.lang.String proxyUsername,
                            java.lang.String proxyPassword,
                            java.lang.String userAgent,
                            java.util.Map<java.lang.String,java.lang.String> optionalHeaders)

isProxyEnabled

public boolean isProxyEnabled()

getProxyHostname

public java.lang.String getProxyHostname()

getProxyPort

public int getProxyPort()

getProxyUsername

public java.lang.String getProxyUsername()

getProxyPassword

public java.lang.String getProxyPassword()

isResolveLocally

public boolean isResolveLocally()

getUserAgent

public java.lang.String getUserAgent()

getOptionalHeaders

public java.util.Map<java.lang.String,java.lang.String> getOptionalHeaders()

getProxyType

public ProxyType getProxyType()