Class SSLSocketFactory
public abstract class SSLSocketFactory extends SocketFactory
SSLSocketFactory
s create SSLSocket
s.- Since:
- 1.4
- See Also:
Constructor Summary
Constructor | Description |
---|---|
SSLSocketFactory() |
Constructor is used only by subclasses. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
Socket |
createSocket |
Creates a server mode Socket layered over an existing connected socket, and is able to read data which has already been consumed/removed from the Socket 's underlying InputStream . |
abstract Socket |
createSocket |
Returns a socket layered over an existing socket connected to the named host, at the given port. |
static SocketFactory |
getDefault() |
Returns the default SSL socket factory. |
abstract String[] |
getDefaultCipherSuites() |
Returns the list of cipher suites which are enabled by default. |
abstract String[] |
getSupportedCipherSuites() |
Returns the names of the cipher suites which could be enabled for use on an SSL connection. |
Methods declared in class javax.net.SocketFactory
createSocket, createSocket, createSocket, createSocket, createSocket
Constructor Details
SSLSocketFactory
public SSLSocketFactory()
Method Details
getDefault
public static SocketFactory getDefault()
The first time this method is called, the security property "ssl.SocketFactory.provider" is examined. If it is non-null, a class by that name is loaded and instantiated. If that is successful and the object is an instance of SSLSocketFactory, it is made the default SSL socket factory.
Otherwise, this method returns SSLContext.getDefault().getSocketFactory()
. If that call fails, an inoperative factory is returned.
- Returns:
- the default
SocketFactory
- See Also:
getDefaultCipherSuites
public abstract String[] getDefaultCipherSuites()
The returned array includes cipher suites from the list of standard cipher suite names in the JSSE Cipher Suite Names section of the Java Cryptography Architecture Standard Algorithm Name Documentation, and may also include other cipher suites that the provider supports.
- Returns:
- array of the cipher suites enabled by default
- See Also:
getSupportedCipherSuites
public abstract String[] getSupportedCipherSuites()
The returned array includes cipher suites from the list of standard cipher suite names in the JSSE Cipher Suite Names section of the Java Cryptography Architecture Standard Algorithm Name Documentation, and may also include other cipher suites that the provider supports.
- Returns:
- an array of cipher suite names
- See Also:
createSocket
public abstract Socket createSocket(Socket s, String host, int port, boolean autoClose) throws IOException
- Parameters:
-
s
- the existing socket -
host
- the server host -
port
- the server port -
autoClose
- close the underlying socket when this socket is closed - Returns:
- a socket connected to the specified host and port
- Throws:
-
IOException
- if an I/O error occurs when creating the socket -
NullPointerException
- if the parameter s is null
createSocket
public Socket createSocket(Socket s, InputStream consumed, boolean autoClose) throws IOException
Socket
layered over an existing connected socket, and is able to read data which has already been consumed/removed from the Socket
's underlying InputStream
. This method can be used by a server application that needs to observe the inbound data but still create valid SSL/TLS connections: for example, inspection of Server Name Indication (SNI) extensions (See section 3 of TLS Extensions (RFC6066)). Data that has been already removed from the underlying InputStream
should be loaded into the consumed
stream before this method is called, perhaps using a ByteArrayInputStream
. When this Socket
begins handshaking, it will read all of the data in consumed
until it reaches EOF
, then all further data is read from the underlying InputStream
as usual.
The returned socket is configured using the socket options established for this factory, and is set to use server mode when handshaking (see SSLSocket.setUseClientMode(boolean)
).
- Parameters:
-
s
- the existing socket -
consumed
- the consumed inbound network data that has already been removed from the existingSocket
InputStream
. This parameter may benull
if no data has been removed. -
autoClose
- close the underlying socket when this socket is closed. - Returns:
- the
Socket
compliant with the socket options established for this factory - Throws:
-
IOException
- if an I/O error occurs when creating the socket -
UnsupportedOperationException
- if the underlying provider does not implement the operation -
NullPointerException
- ifs
isnull
- Since:
- 1.8
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLSocketFactory.html