Class SocketFactory
- Direct Known Subclasses:
SSLSocketFactory
Socket factories are a simple way to capture a variety of policies related to the sockets being constructed, producing such sockets in a way which does not require special configuration of the code which asks for the sockets:
- Due to polymorphism of both factories and sockets, different kinds of sockets can be used by the same application code just by passing it different kinds of factories.
- Factories can themselves be customized with parameters used in socket construction. So for example, factories could be customized to return sockets with different networking timeouts or security parameters already configured.
- The sockets returned to the application can be subclasses of java.net.Socket, so that they can directly expose new APIs for features such as compression, security, record marking, statistics collection, or firewall tunneling.
Factory classes are specified by environment-specific configuration mechanisms. For example, the getDefault method could return a factory that was appropriate for a particular application, and a framework could use a factory customized to its own purposes.
- Since:
- 1.4
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionCreates an unconnected socket.abstract Socket
createSocket
(String host, int port) Creates a socket and connects it to the specified remote host at the specified remote port.abstract Socket
createSocket
(String host, int port, InetAddress localHost, int localPort) Creates a socket and connects it to the specified remote host on the specified remote port.abstract Socket
createSocket
(InetAddress host, int port) Creates a socket and connects it to the specified port number at the specified address.abstract Socket
createSocket
(InetAddress address, int port, InetAddress localAddress, int localPort) Creates a socket and connect it to the specified remote address on the specified remote port.static SocketFactory
Returns a copy of the environment's default socket factory.
-
Constructor Details
-
SocketFactory
protected SocketFactory()Creates aSocketFactory
.
-
-
Method Details
-
getDefault
Returns a copy of the environment's default socket factory.- Returns:
- the default
SocketFactory
-
createSocket
Creates an unconnected socket.- Returns:
- the unconnected socket
- Throws:
IOException
- if the socket cannot be created- See Also:
-
createSocket
Creates a socket and connects it to the specified remote host at the specified remote port. This socket is configured using the socket options established for this factory.If there is a security manager, its
checkConnect
method is called with the host address andport
as its arguments. This could result in a SecurityException.- Parameters:
host
- the server host name with which to connect, ornull
for the loopback address.port
- the server port- Returns:
- the
Socket
- Throws:
IOException
- if an I/O error occurs when creating the socketSecurityException
- if a security manager exists and itscheckConnect
method doesn't allow the operation.UnknownHostException
- if the host is not knownIllegalArgumentException
- if the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive.- See Also:
-
createSocket
public abstract Socket createSocket(String host, int port, InetAddress localHost, int localPort) throws IOException, UnknownHostException Creates a socket and connects it to the specified remote host on the specified remote port. The socket will also be bound to the local address and port supplied. This socket is configured using the socket options established for this factory.If there is a security manager, its
checkConnect
method is called with the host address andport
as its arguments. This could result in a SecurityException.- Parameters:
host
- the server host name with which to connect, ornull
for the loopback address.port
- the server portlocalHost
- the local address the socket is bound tolocalPort
- the local port the socket is bound to- Returns:
- the
Socket
- Throws:
IOException
- if an I/O error occurs when creating the socketSecurityException
- if a security manager exists and itscheckConnect
method doesn't allow the operation.UnknownHostException
- if the host is not knownIllegalArgumentException
- if the port parameter or localPort parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive.- See Also:
-
createSocket
Creates a socket and connects it to the specified port number at the specified address. This socket is configured using the socket options established for this factory.If there is a security manager, its
checkConnect
method is called with the host address andport
as its arguments. This could result in a SecurityException.- Parameters:
host
- the server hostport
- the server port- Returns:
- the
Socket
- Throws:
IOException
- if an I/O error occurs when creating the socketSecurityException
- if a security manager exists and itscheckConnect
method doesn't allow the operation.IllegalArgumentException
- if the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive.NullPointerException
- ifhost
is null.- See Also:
-
createSocket
public abstract Socket createSocket(InetAddress address, int port, InetAddress localAddress, int localPort) throws IOException Creates a socket and connect it to the specified remote address on the specified remote port. The socket will also be bound to the local address and port supplied. The socket is configured using the socket options established for this factory.If there is a security manager, its
checkConnect
method is called with the host address andport
as its arguments. This could result in a SecurityException.- Parameters:
address
- the server network addressport
- the server portlocalAddress
- the client network addresslocalPort
- the client port- Returns:
- the
Socket
- Throws:
IOException
- if an I/O error occurs when creating the socketSecurityException
- if a security manager exists and itscheckConnect
method doesn't allow the operation.IllegalArgumentException
- if the port parameter or localPort parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive.NullPointerException
- ifaddress
is null.- See Also:
-