public abstract class SocketClient extends Object
setSocketFactory
method, which allows you to control the type of Socket the SocketClient creates for initiating network connections. This is especially useful for adding SSL
or proxy support as well as better support for applets. For example, you could create a SocketFactory
that requests browser security
capabilities before creating a socket. All classes derived from SocketClient should use the _socketFactory_
member variable to
create Socket and ServerSocket instances rather than instantiating them by directly invoking a constructor. By honoring this contract you guarantee that a
user will always be able to provide his own Socket implementations by substituting his own SocketFactory.SocketFactory
Modifier and Type | Field and Description |
---|---|
protected int |
_defaultPort_
The default port the client should connect to.
|
protected String |
_hostname_
The hostname used for the connection (null = no hostname supplied).
|
protected InputStream |
_input_
The socket's InputStream.
|
protected OutputStream |
_output_
The socket's OutputStream.
|
protected ServerSocketFactory |
_serverSocketFactory_
The socket's ServerSocket Factory.
|
protected Socket |
_socket_
The socket used for the connection.
|
protected SocketFactory |
_socketFactory_
The socket's SocketFactory.
|
protected int |
_timeout_
The timeout to use after opening a socket.
|
protected int |
connectTimeout |
static String |
NETASCII_EOL
The end of line character sequence used by most IETF protocols.
|
Constructor and Description |
---|
SocketClient()
Default constructor for SocketClient.
|
Modifier and Type | Method and Description |
---|---|
protected void |
_connectAction_()
Because there are so many connect() methods, the _connectAction_() method is provided as a means of performing some action immediately after establishing
a connection, rather than reimplementing all of the connect() methods.
|
void |
addProtocolCommandListener(ProtocolCommandListener listener)
Adds a ProtocolCommandListener.
|
protected void |
applySocketAttributes()
Applies socket attributes.
|
void |
connect(InetAddress host)
Opens a Socket connected to a remote host at the current default port and originating from the current host at a system assigned port.
|
void |
connect(InetAddress host,
int port)
Opens a Socket connected to a remote host at the specified port and originating from the current host at a system assigned port.
|
void |
connect(InetAddress host,
int port,
InetAddress localAddr,
int localPort)
Opens a Socket connected to a remote host at the specified port and originating from the specified local address and port.
|
void |
connect(String hostname)
Opens a Socket connected to a remote host at the current default port and originating from the current host at a system assigned port.
|
void |
connect(String hostname,
int port)
Opens a Socket connected to a remote host at the specified port and originating from the current host at a system assigned port.
|
void |
connect(String hostname,
int port,
InetAddress localAddr,
int localPort)
Opens a Socket connected to a remote host at the specified port and originating from the specified local address and port.
|
protected void |
createCommandSupport()
Create the CommandSupport instance if required
|
void |
disconnect()
Disconnects the socket connection.
|
protected void |
fireCommandSent(String command,
String message)
If there are any listeners, send them the command details.
|
protected void |
fireReplyReceived(int replyCode,
String reply)
If there are any listeners, send them the reply details.
|
Charset |
getCharset()
Gets the charset.
|
String |
getCharsetName()
Deprecated.
Since the code now requires Java 1.6 as a mininmum
|
protected ProtocolCommandSupport |
getCommandSupport()
Subclasses can override this if they need to provide their own instance field for backwards compatibilty.
|
int |
getConnectTimeout()
Get the underlying socket connection timeout.
|
int |
getDefaultPort()
Returns the current value of the default port (stored in
_defaultPort_ ). |
int |
getDefaultTimeout()
Returns the default timeout in milliseconds that is used when opening a socket.
|
boolean |
getKeepAlive()
Returns the current value of the SO_KEEPALIVE flag on the currently opened socket.
|
InetAddress |
getLocalAddress()
Returns the local address to which the client's socket is bound.
|
int |
getLocalPort()
Returns the port number of the open socket on the local host used for the connection.
|
Proxy |
getProxy()
Gets the proxy for use with all the connections.
|
protected int |
getReceiveBufferSize()
Get the current receivedBuffer size
|
InetAddress |
getRemoteAddress() |
int |
getRemotePort()
Returns the port number of the remote host to which the client is connected.
|
protected int |
getSendBufferSize()
Get the current sendBuffer size
|
ServerSocketFactory |
getServerSocketFactory()
Get the underlying
ServerSocketFactory |
int |
getSoLinger()
Returns the current SO_LINGER timeout of the currently opened socket.
|
int |
getSoTimeout()
Returns the timeout in milliseconds of the currently opened socket.
|
boolean |
getTcpNoDelay()
Returns true if Nagle's algorithm is enabled on the currently opened socket.
|
boolean |
isAvailable()
Make various checks on the socket to test if it is available for use.
|
boolean |
isConnected()
Returns true if the client is currently connected to a server.
|
void |
removeProtocolCommandListener(ProtocolCommandListener listener)
Removes a ProtocolCommandListener.
|
void |
setCharset(Charset charset)
Sets the charset.
|
void |
setConnectTimeout(int connectTimeout)
Sets the connection timeout in milliseconds, which will be passed to the
Socket object's connect() method. |
void |
setDefaultPort(int port)
Sets the default port the SocketClient should connect to when a port is not specified.
|
void |
setDefaultTimeout(int timeout)
Set the default timeout in milliseconds to use when opening a socket.
|
void |
setKeepAlive(boolean keepAlive)
Sets the SO_KEEPALIVE flag on the currently opened socket.
|
void |
setProxy(Proxy proxy)
Sets the proxy for use with all the connections.
|
void |
setReceiveBufferSize(int size)
Sets the underlying socket receive buffer size.
|
void |
setSendBufferSize(int size)
Set the underlying socket send buffer size.
|
void |
setServerSocketFactory(ServerSocketFactory factory)
Sets the ServerSocketFactory used by the SocketClient to open ServerSocket connections.
|
void |
setSocketFactory(SocketFactory factory)
Sets the SocketFactory used by the SocketClient to open socket connections.
|
void |
setSoLinger(boolean on,
int val)
Sets the SO_LINGER timeout on the currently opened socket.
|
void |
setSoTimeout(int timeout)
Set the timeout in milliseconds of a currently open connection.
|
void |
setTcpNoDelay(boolean on)
Enables or disables the Nagle's algorithm (TCP_NODELAY) on the currently opened socket.
|
boolean |
verifyRemote(Socket socket)
Verifies that the remote end of the given socket is connected to the the same host that the SocketClient is currently connected to.
|
public static final String NETASCII_EOL
protected int _timeout_
protected String _hostname_
protected int _defaultPort_
protected InputStream _input_
protected OutputStream _output_
protected SocketFactory _socketFactory_
protected ServerSocketFactory _serverSocketFactory_
protected int connectTimeout
public SocketClient()
Charset.defaultCharset()
and _socketFactory_ to a shared instance of DefaultSocketFactory
.protected void _connectAction_() throws IOException
This method sets the timeout on the just opened socket to the default timeout set by setDefaultTimeout()
, sets _input_ and
_output_ to the socket's InputStream and OutputStream respectively, and sets _isConnected_ to true.
Subclasses overriding this method should start by calling super._connectAction_()
first to ensure the initialization of the aforementioned
protected variables.
IOException
- (SocketException) if a problem occurs with the socketpublic void addProtocolCommandListener(ProtocolCommandListener listener)
listener
- The ProtocolCommandListener to add.protected void applySocketAttributes() throws SocketException
SocketException
- if there is an error in the underlying protocol, such as a TCP error.public void connect(InetAddress host) throws SocketException, IOException
_connectAction_()
is called to perform connection initialization actions.host
- The remote host.SocketException
- If the socket timeout could not be set.IOException
- If the socket could not be opened. In most cases you will only want to catch IOException since SocketException is derived from
it.public void connect(InetAddress host, int port) throws SocketException, IOException
_connectAction_()
is called to perform connection initialization actions.host
- The remote host.port
- The port to connect to on the remote host.SocketException
- If the socket timeout could not be set.IOException
- If the socket could not be opened. In most cases you will only want to catch IOException since SocketException is derived from
it.public void connect(InetAddress host, int port, InetAddress localAddr, int localPort) throws SocketException, IOException
_connectAction_()
is called to perform connection initialization actions.host
- The remote host.port
- The port to connect to on the remote host.localAddr
- The local address to use.localPort
- The local port to use.SocketException
- If the socket timeout could not be set.IOException
- If the socket could not be opened. In most cases you will only want to catch IOException since SocketException is derived from
it.public void connect(String hostname) throws SocketException, IOException
_connectAction_()
is called to perform connection initialization actions.hostname
- The name of the remote host.SocketException
- If the socket timeout could not be set.IOException
- If the socket could not be opened. In most cases you will only want to catch IOException since SocketException is
derived from it.UnknownHostException
- If the hostname cannot be resolved.public void connect(String hostname, int port) throws SocketException, IOException
_connectAction_()
is called to perform connection initialization actions.hostname
- The name of the remote host.port
- The port to connect to on the remote host.SocketException
- If the socket timeout could not be set.IOException
- If the socket could not be opened. In most cases you will only want to catch IOException since SocketException is
derived from it.UnknownHostException
- If the hostname cannot be resolved.public void connect(String hostname, int port, InetAddress localAddr, int localPort) throws SocketException, IOException
_connectAction_()
is called to perform connection initialization actions.hostname
- The name of the remote host.port
- The port to connect to on the remote host.localAddr
- The local address to use.localPort
- The local port to use.SocketException
- If the socket timeout could not be set.IOException
- If the socket could not be opened. In most cases you will only want to catch IOException since SocketException is
derived from it.UnknownHostException
- If the hostname cannot be resolved.protected void createCommandSupport()
public void disconnect() throws IOException
connect()
again. _isConnected_ is set to false, _socket_ is set to null, _input_ is set to null, and _output_ is set to null.IOException
- If there is an error closing the socket.protected void fireCommandSent(String command, String message)
command
- the command namemessage
- the complete message, including command nameprotected void fireReplyReceived(int replyCode, String reply)
replyCode
- the code extracted from the replyreply
- the full reply textpublic Charset getCharset()
@Deprecated public String getCharsetName()
protected ProtocolCommandSupport getCommandSupport()
null
public int getConnectTimeout()
public int getDefaultPort()
_defaultPort_
).public int getDefaultTimeout()
public boolean getKeepAlive() throws SocketException
Socket.getKeepAlive()
SocketException
- if there is a problem with the socketNullPointerException
- if the socket is not currently openpublic InetAddress getLocalAddress()
Socket.getLocalAddress()
NullPointerException
- if the socket is not currently openpublic int getLocalPort()
Socket.getLocalPort()
NullPointerException
- if the socket is not currently openpublic Proxy getProxy()
protected int getReceiveBufferSize()
public InetAddress getRemoteAddress()
Socket.getInetAddress()
NullPointerException
- if the socket is not currently openpublic int getRemotePort()
Socket.getPort()
NullPointerException
- if the socket is not currently openprotected int getSendBufferSize()
public ServerSocketFactory getServerSocketFactory()
ServerSocketFactory
public int getSoLinger() throws SocketException
SocketException
- If the operation fails.NullPointerException
- if the socket is not currently openpublic int getSoTimeout() throws SocketException
SocketException
- If the operation fails.NullPointerException
- if the socket is not currently openpublic boolean getTcpNoDelay() throws SocketException
SocketException
- If the operation fails.NullPointerException
- if the socket is not currently openpublic boolean isAvailable()
true
if the socket appears to be available for usepublic boolean isConnected()
Socket.isConnected()
public void removeProtocolCommandListener(ProtocolCommandListener listener)
listener
- The ProtocolCommandListener to remove.public void setCharset(Charset charset)
charset
- the charset.public void setConnectTimeout(int connectTimeout)
Socket
object's connect() method.connectTimeout
- The connection timeout to use (in ms)public void setDefaultPort(int port)
_defaultPort_
variable stores this
value. If never set, the default port is equal to zero.port
- The default port to set.public void setDefaultTimeout(int timeout)
connect()
and should
not be confused with setSoTimeout()
which operates on an the currently opened socket. _timeout_ contains the new timeout value.timeout
- The timeout in milliseconds to use for the socket connection.public void setKeepAlive(boolean keepAlive) throws SocketException
keepAlive
- If true, keepAlive is turned onSocketException
- if there is a problem with the socketNullPointerException
- if the socket is not currently openpublic void setProxy(Proxy proxy)
proxy
- the new proxy for connections.public void setReceiveBufferSize(int size) throws SocketException
size
- The size of the buffer in bytes.SocketException
- never (but subclasses may wish to do so)public void setSendBufferSize(int size) throws SocketException
size
- The size of the buffer in bytes.SocketException
- never thrown, but subclasses might want to do sopublic void setServerSocketFactory(ServerSocketFactory factory)
factory
- The new ServerSocketFactory the SocketClient should use.public void setSocketFactory(SocketFactory factory)
factory
- The new SocketFactory the SocketClient should use.public void setSoLinger(boolean on, int val) throws SocketException
on
- True if linger is to be enabled, false if not.val
- The linger timeout (in hundredths of a second?)SocketException
- If the operation fails.NullPointerException
- if the socket is not currently openpublic void setSoTimeout(int timeout) throws SocketException
connect()
.
To set the initial timeout, use setDefaultTimeout(int)
instead.
timeout
- The timeout in milliseconds to use for the currently open socket connection.SocketException
- If the operation fails.NullPointerException
- if the socket is not currently openpublic void setTcpNoDelay(boolean on) throws SocketException
on
- True if Nagle's algorithm is to be enabled, false if not.SocketException
- If the operation fails.NullPointerException
- if the socket is not currently openpublic boolean verifyRemote(Socket socket)
socket
- the item to check againstCopyright © 2001–2022 The Apache Software Foundation. All rights reserved.