java.lang.Object
jdk.net.Sockets
Deprecated.
Java SE 9 added standard methods to set/get socket options, and retrieve the per-Socket
supported options effectively rendering this API redundant. Please refer to the corresponding
socket's class for the equivalent method to set/get a socket option or retrieve available socket options.
Defines static methods to set and get socket options defined by the
SocketOption
interface. All of the standard options defined
by Socket
, ServerSocket
, and
DatagramSocket
can be set this way, as well as additional
or platform specific options supported by each socket type.
The supportedOptions(Class)
method can be called to determine
the complete set of options available (per socket type) on the
current system.
When a security manager is installed, some non-standard socket options
may require a security permission before being set or get.
The details are specified in ExtendedSocketOptions
. No permission
is required for StandardSocketOptions
.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic <T> T
getOption
(DatagramSocket s, SocketOption<T> name) Deprecated.useDatagramSocket.getOption(SocketOption)
instead.static <T> T
getOption
(ServerSocket s, SocketOption<T> name) Deprecated.useServerSocket.getOption(SocketOption)
instead.static <T> T
getOption
(Socket s, SocketOption<T> name) Deprecated.useSocket.getOption(SocketOption)
instead.static <T> void
setOption
(DatagramSocket s, SocketOption<T> name, T value) Deprecated.useDatagramSocket.setOption(SocketOption, Object)
instead.static <T> void
setOption
(ServerSocket s, SocketOption<T> name, T value) Deprecated.useServerSocket.setOption(SocketOption, Object)
instead.static <T> void
setOption
(Socket s, SocketOption<T> name, T value) Deprecated.useSocket.setOption(SocketOption, Object)
instead.static Set
<SocketOption<?>> supportedOptions
(Class<?> socketType) Deprecated, for removal: This API element is subject to removal in a future version.
-
Method Details
-
setOption
@Deprecated(since="16") public static <T> void setOption(Socket s, SocketOption<T> name, T value) throws IOException Deprecated.useSocket.setOption(SocketOption, Object)
instead.Sets the value of a socket option on aSocket
- Type Parameters:
T
- The type of the socket option- Parameters:
s
- the socketname
- The socket optionvalue
- The value of the socket option. May be null for some options.- Throws:
UnsupportedOperationException
- if the socket does not support the option.IllegalArgumentException
- if the value is not valid for the option.IOException
- if an I/O error occurs, or socket is closed.SecurityException
- if a security manager is set and the caller does not have any required permission.NullPointerException
- if name is null- See Also:
-
getOption
@Deprecated(since="16") public static <T> T getOption(Socket s, SocketOption<T> name) throws IOException Deprecated.useSocket.getOption(SocketOption)
instead.Returns the value of a socket option from aSocket
- Type Parameters:
T
- The type of the socket option- Parameters:
s
- the socketname
- The socket option- Returns:
- The value of the socket option.
- Throws:
UnsupportedOperationException
- if the socket does not support the option.IOException
- if an I/O error occursSecurityException
- if a security manager is set and the caller does not have any required permission.NullPointerException
- if name is null- See Also:
-
setOption
@Deprecated(since="16") public static <T> void setOption(ServerSocket s, SocketOption<T> name, T value) throws IOException Deprecated.useServerSocket.setOption(SocketOption, Object)
instead.Sets the value of a socket option on aServerSocket
- Type Parameters:
T
- The type of the socket option- Parameters:
s
- the socketname
- The socket optionvalue
- The value of the socket option- Throws:
UnsupportedOperationException
- if the socket does not support the option.IllegalArgumentException
- if the value is not valid for the option.IOException
- if an I/O error occursNullPointerException
- if name is nullSecurityException
- if a security manager is set and the caller does not have any required permission.- See Also:
-
getOption
@Deprecated(since="16") public static <T> T getOption(ServerSocket s, SocketOption<T> name) throws IOException Deprecated.useServerSocket.getOption(SocketOption)
instead.Returns the value of a socket option from aServerSocket
- Type Parameters:
T
- The type of the socket option- Parameters:
s
- the socketname
- The socket option- Returns:
- The value of the socket option.
- Throws:
UnsupportedOperationException
- if the socket does not support the option.IOException
- if an I/O error occursNullPointerException
- if name is nullSecurityException
- if a security manager is set and the caller does not have any required permission.- See Also:
-
setOption
@Deprecated(since="16") public static <T> void setOption(DatagramSocket s, SocketOption<T> name, T value) throws IOException Deprecated.useDatagramSocket.setOption(SocketOption, Object)
instead.Sets the value of a socket option on aDatagramSocket
orMulticastSocket
- Type Parameters:
T
- The type of the socket option- Parameters:
s
- the socketname
- The socket optionvalue
- The value of the socket option- Throws:
UnsupportedOperationException
- if the socket does not support the option.IllegalArgumentException
- if the value is not valid for the option.IOException
- if an I/O error occursNullPointerException
- if name is nullSecurityException
- if a security manager is set and the caller does not have any required permission.- See Also:
-
getOption
@Deprecated(since="16") public static <T> T getOption(DatagramSocket s, SocketOption<T> name) throws IOException Deprecated.useDatagramSocket.getOption(SocketOption)
instead.Returns the value of a socket option from aDatagramSocket
orMulticastSocket
- Type Parameters:
T
- The type of the socket option- Parameters:
s
- the socketname
- The socket option- Returns:
- The value of the socket option.
- Throws:
UnsupportedOperationException
- if the socket does not support the option.IOException
- if an I/O error occursNullPointerException
- if name is nullSecurityException
- if a security manager is set and the caller does not have any required permission.- See Also:
-
supportedOptions
@Deprecated(since="16", forRemoval=true) public static Set<SocketOption<?>> supportedOptions(Class<?> socketType) Deprecated, for removal: This API element is subject to removal in a future version.Returns a set ofSocketOption
s supported by the given socket type. This set may include standard options and also non standard extended options.- Parameters:
socketType
- the type of java.net socket- Returns:
- A set of socket options
- Throws:
IllegalArgumentException
- if socketType is not a valid socket type from the java.net package.
-