- java.lang.Object
-
- javax.rmi.ssl.SslRMIServerSocketFactory
-
- All Implemented Interfaces:
RMIServerSocketFactory
public class SslRMIServerSocketFactory extends Object implements RMIServerSocketFactory
An
SslRMIServerSocketFactoryinstance is used by the RMI runtime in order to obtain server sockets for RMI calls via SSL.This class implements
RMIServerSocketFactoryover the Secure Sockets Layer (SSL) or Transport Layer Security (TLS) protocols.This class creates SSL sockets using the default
SSLSocketFactory(seeSSLSocketFactory.getDefault()) or the defaultSSLServerSocketFactory(seeSSLServerSocketFactory.getDefault()) unless the constructor taking anSSLContextis used in which case the SSL sockets are created using theSSLSocketFactoryreturned bySSLContext.getSocketFactory()or theSSLServerSocketFactoryreturned bySSLContext.getServerSocketFactory(). When anSSLContextis not supplied all the instances of this class share the same keystore, and the same truststore (when client authentication is required by the server). This behavior can be modified by supplying an already initializedSSLContextinstance.- Since:
- 1.5
- See Also:
SSLSocketFactory,SSLServerSocketFactory,SslRMIClientSocketFactory
-
-
Constructor Summary
Constructors Constructor Description SslRMIServerSocketFactory()Creates a newSslRMIServerSocketFactorywith the default SSL socket configuration.SslRMIServerSocketFactory(String[] enabledCipherSuites, String[] enabledProtocols, boolean needClientAuth)Creates a newSslRMIServerSocketFactorywith the specified SSL socket configuration.SslRMIServerSocketFactory(SSLContext context, String[] enabledCipherSuites, String[] enabledProtocols, boolean needClientAuth)Creates a newSslRMIServerSocketFactorywith the specifiedSSLContextand SSL socket configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ServerSocketcreateServerSocket(int port)Creates a server socket that accepts SSL connections configured according to this factory's SSL socket configuration parameters.booleanequals(Object obj)Indicates whether some other object is "equal to" this one.String[]getEnabledCipherSuites()Returns the names of the cipher suites enabled on SSL connections accepted by server sockets created by this factory, ornullif this factory uses the cipher suites that are enabled by default.String[]getEnabledProtocols()Returns the names of the protocol versions enabled on SSL connections accepted by server sockets created by this factory, ornullif this factory uses the protocol versions that are enabled by default.booleangetNeedClientAuth()Returnstrueif client authentication is required on SSL connections accepted by server sockets created by this factory.inthashCode()Returns a hash code value for thisSslRMIServerSocketFactory.
-
-
-
Constructor Detail
-
SslRMIServerSocketFactory
public SslRMIServerSocketFactory()
Creates a new
SslRMIServerSocketFactorywith the default SSL socket configuration.SSL connections accepted by server sockets created by this factory have the default cipher suites and protocol versions enabled and do not require client authentication.
-
SslRMIServerSocketFactory
public SslRMIServerSocketFactory(String[] enabledCipherSuites, String[] enabledProtocols, boolean needClientAuth) throws IllegalArgumentException
Creates a new
SslRMIServerSocketFactorywith the specified SSL socket configuration.- Parameters:
enabledCipherSuites- names of all the cipher suites to enable on SSL connections accepted by server sockets created by this factory, ornullto use the cipher suites that are enabled by defaultenabledProtocols- names of all the protocol versions to enable on SSL connections accepted by server sockets created by this factory, ornullto use the protocol versions that are enabled by defaultneedClientAuth-trueto require client authentication on SSL connections accepted by server sockets created by this factory;falseto not require client authentication- Throws:
IllegalArgumentException- when one or more of the cipher suites named by theenabledCipherSuitesparameter is not supported, when one or more of the protocols named by theenabledProtocolsparameter is not supported or when a problem is encountered while trying to check if the supplied cipher suites and protocols to be enabled are supported.- See Also:
SSLSocket.setEnabledCipherSuites(java.lang.String[]),SSLSocket.setEnabledProtocols(java.lang.String[]),SSLSocket.setNeedClientAuth(boolean)
-
SslRMIServerSocketFactory
public SslRMIServerSocketFactory(SSLContext context, String[] enabledCipherSuites, String[] enabledProtocols, boolean needClientAuth) throws IllegalArgumentException
Creates a new
SslRMIServerSocketFactorywith the specifiedSSLContextand SSL socket configuration.- Parameters:
context- the SSL context to be used for creating SSL sockets. Ifcontextis null the defaultSSLSocketFactoryor the defaultSSLServerSocketFactorywill be used to create SSL sockets. Otherwise, the socket factory returned bySSLContext.getSocketFactory()orSSLContext.getServerSocketFactory()will be used instead.enabledCipherSuites- names of all the cipher suites to enable on SSL connections accepted by server sockets created by this factory, ornullto use the cipher suites that are enabled by defaultenabledProtocols- names of all the protocol versions to enable on SSL connections accepted by server sockets created by this factory, ornullto use the protocol versions that are enabled by defaultneedClientAuth-trueto require client authentication on SSL connections accepted by server sockets created by this factory;falseto not require client authentication- Throws:
IllegalArgumentException- when one or more of the cipher suites named by theenabledCipherSuitesparameter is not supported, when one or more of the protocols named by theenabledProtocolsparameter is not supported or when a problem is encountered while trying to check if the supplied cipher suites and protocols to be enabled are supported.- Since:
- 1.7
- See Also:
SSLSocket.setEnabledCipherSuites(java.lang.String[]),SSLSocket.setEnabledProtocols(java.lang.String[]),SSLSocket.setNeedClientAuth(boolean)
-
-
Method Detail
-
getEnabledCipherSuites
public final String[] getEnabledCipherSuites()
Returns the names of the cipher suites enabled on SSL connections accepted by server sockets created by this factory, or
nullif this factory uses the cipher suites that are enabled by default.- Returns:
- an array of cipher suites enabled, or
null - See Also:
SSLSocket.setEnabledCipherSuites(java.lang.String[])
-
getEnabledProtocols
public final String[] getEnabledProtocols()
Returns the names of the protocol versions enabled on SSL connections accepted by server sockets created by this factory, or
nullif this factory uses the protocol versions that are enabled by default.- Returns:
- an array of protocol versions enabled, or
null - See Also:
SSLSocket.setEnabledProtocols(java.lang.String[])
-
getNeedClientAuth
public final boolean getNeedClientAuth()
Returns
trueif client authentication is required on SSL connections accepted by server sockets created by this factory.- Returns:
trueif client authentication is required- See Also:
SSLSocket.setNeedClientAuth(boolean)
-
createServerSocket
public ServerSocket createServerSocket(int port) throws IOException
Creates a server socket that accepts SSL connections configured according to this factory's SSL socket configuration parameters.
- Specified by:
createServerSocketin interfaceRMIServerSocketFactory- Parameters:
port- the port number- Returns:
- the server socket on the specified port
- Throws:
IOException- if an I/O error occurs during server socket creation
-
equals
public boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
Two
SslRMIServerSocketFactoryobjects are equal if they have been constructed with the same SSL context and SSL socket configuration parameters.A subclass should override this method (as well as
hashCode()) if it adds instance state that affects equality.- Overrides:
equalsin classObject- Parameters:
obj- Object the object to compare with this object.- Returns:
- boolean
trueif the object is the same as this objectfalseif it is different from this object. - See Also:
Object.hashCode()
-
hashCode
public int hashCode()
Returns a hash code value for this
SslRMIServerSocketFactory.- Overrides:
hashCodein classObject- Returns:
- a hash code value for this
SslRMIServerSocketFactory. - See Also:
Object.equals(java.lang.Object)
-
-