File	Doc	Category	Size	Date	Package
SslRMIServerSocketFactory.java	API Doc	Java SE 5 API	15146	Fri Aug 26 14:57:46 BST 2005	javax.rmi.ssl

SslRMIServerSocketFactory

• java.lang.Object

Fields Summary
private static SSLSocketFactory	defaultSSLSocketFactory
private final String[]	enabledCipherSuites
private final String[]	enabledProtocols
private final boolean	needClientAuth
private List	enabledCipherSuitesList
private List	enabledProtocolsList

Constructors Summary
public SslRMIServerSocketFactory() Creates a new SslRMIServerSocketFactory with 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. this(null, null, false);
public SslRMIServerSocketFactory(String[] enabledCipherSuites, String[] enabledProtocols, boolean needClientAuth) Creates a new SslRMIServerSocketFactory with the specified SSL socket configuration. param enabledCipherSuites names of all the cipher suites to enable on SSL connections accepted by server sockets created by this factory, or null to use the cipher suites that are enabled by default param enabledProtocols names of all the protocol versions to enable on SSL connections accepted by server sockets created by this factory, or null to use the protocol versions that are enabled by default param needClientAuth true to require client authentication on SSL connections accepted by server sockets created by this factory; false to not require client authentication exception IllegalArgumentException when one or more of the cipher suites named by the enabledCipherSuites parameter is not supported, when one or more of the protocols named by the enabledProtocols parameter 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 SSLSocket#setEnabledCipherSuites see SSLSocket#setEnabledProtocols see SSLSocket#setNeedClientAuth // Initialize the configuration parameters. // this.enabledCipherSuites = enabledCipherSuites == null ? null : (String[]) enabledCipherSuites.clone(); this.enabledProtocols = enabledProtocols == null ? null : (String[]) enabledProtocols.clone(); this.needClientAuth = needClientAuth; // Force the initialization of the default at construction time, // rather than delaying it to the first time createServerSocket() // is called. // final SSLSocketFactory sslSocketFactory = getDefaultSSLSocketFactory(); SSLSocket sslSocket = null; if (this.enabledCipherSuites != null || this.enabledProtocols != null) { try { sslSocket = (SSLSocket) sslSocketFactory.createSocket(); } catch (Exception e) { final String msg = "Unable to check if the cipher suites " + "and protocols to enable are supported"; throw (IllegalArgumentException) new IllegalArgumentException(msg).initCause(e); } } // Check if all the cipher suites and protocol versions to enable // are supported by the underlying SSL/TLS implementation and if // true create lists from arrays. // if (this.enabledCipherSuites != null) { sslSocket.setEnabledCipherSuites(this.enabledCipherSuites); enabledCipherSuitesList = Arrays.asList((String[]) this.enabledCipherSuites); } if (this.enabledProtocols != null) { sslSocket.setEnabledProtocols(this.enabledProtocols); enabledProtocolsList = Arrays.asList((String[]) this.enabledProtocols); }

Methods Summary
private boolean	checkParameters(javax.rmi.ssl.SslRMIServerSocketFactory that) // needClientAuth flag // if (needClientAuth != that.needClientAuth) return false; // enabledCipherSuites // if ((enabledCipherSuites == null && that.enabledCipherSuites != null) || (enabledCipherSuites != null && that.enabledCipherSuites == null)) return false; if (enabledCipherSuites != null && that.enabledCipherSuites != null) { List thatEnabledCipherSuitesList = Arrays.asList((String[]) that.enabledCipherSuites); if (!enabledCipherSuitesList.equals(thatEnabledCipherSuitesList)) return false; } // enabledProtocols // if ((enabledProtocols == null && that.enabledProtocols != null) || (enabledProtocols != null && that.enabledProtocols == null)) return false; if (enabledProtocols != null && that.enabledProtocols != null) { List thatEnabledProtocolsList = Arrays.asList((String[]) that.enabledProtocols); if (!enabledProtocolsList.equals(thatEnabledProtocolsList)) return false; } return true;
public java.net.ServerSocket	createServerSocket(int port) Creates a server socket that accepts SSL connections configured according to this factory's SSL socket configuration parameters. final SSLSocketFactory sslSocketFactory = getDefaultSSLSocketFactory(); return new ServerSocket(port) { public Socket accept() throws IOException { Socket socket = super.accept(); SSLSocket sslSocket = (SSLSocket) sslSocketFactory.createSocket( socket, socket.getInetAddress().getHostName(), socket.getPort(), true); sslSocket.setUseClientMode(false); if (enabledCipherSuites != null) { sslSocket.setEnabledCipherSuites(enabledCipherSuites); } if (enabledProtocols != null) { sslSocket.setEnabledProtocols(enabledProtocols); } sslSocket.setNeedClientAuth(needClientAuth); return sslSocket; } }; // If we do not instantiate the server socket class, but // instead must layer on top of an arbitrary server socket, // then this implementation would become uglier, like this // (given "serverSocket" to layer on top of): // // return new ForwardingServerSocket(serverSocket) { // public Socket accept() throws IOException { // Socket socket = serverSocket.accept(); // SSLSocket sslSocket = // (SSLSocket) sslSocketFactory.createSocket( // socket, // socket.getInetAddress().getHostName(), // socket.getPort(), // true); // sslSocket.setUseClientMode(false); // if (enabledProtocols != null) { // sslSocket.setEnabledProtocols(enabledProtocols); // } // if (enabledCipherSuites != null) { // sslSocket.setEnabledCipherSuites(enabledCipherSuites); // } // sslSocket.setNeedClientAuth(needClientAuth); // return sslSocket; // } // public ServerSocketChannel getChannel() { // return null; // } // public String toString() { // return serverSocket.toString(); // } // };
public boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one. Two SslRMIServerSocketFactory objects are equal if they have been constructed with the same SSL socket configuration parameters. A subclass should override this method (as well as {@link #hashCode()}) if it adds instance state that affects equality. if (obj == null) return false; if (obj == this) return true; if (!(obj instanceof SslRMIServerSocketFactory)) return false; SslRMIServerSocketFactory that = (SslRMIServerSocketFactory) obj; return (getClass().equals(that.getClass()) && checkParameters(that));
private static synchronized javax.net.ssl.SSLSocketFactory	getDefaultSSLSocketFactory() if (defaultSSLSocketFactory == null) defaultSSLSocketFactory = (SSLSocketFactory) SSLSocketFactory.getDefault(); return defaultSSLSocketFactory;
public final java.lang.String[]	getEnabledCipherSuites() Returns the names of the cipher suites enabled on SSL connections accepted by server sockets created by this factory, or null if this factory uses the cipher suites that are enabled by default. return an array of cipher suites enabled, or null see SSLSocket#setEnabledCipherSuites return enabledCipherSuites == null ? null : (String[]) enabledCipherSuites.clone();
public final java.lang.String[]	getEnabledProtocols() Returns the names of the protocol versions enabled on SSL connections accepted by server sockets created by this factory, or null if this factory uses the protocol versions that are enabled by default. return an array of protocol versions enabled, or null see SSLSocket#setEnabledProtocols return enabledProtocols == null ? null : (String[]) enabledProtocols.clone();
public final boolean	getNeedClientAuth() Returns true if client authentication is required on SSL connections accepted by server sockets created by this factory. return true if client authentication is required see SSLSocket#setNeedClientAuth return needClientAuth;
public int	hashCode() Returns a hash code value for this SslRMIServerSocketFactory. return a hash code value for this SslRMIServerSocketFactory. return getClass().hashCode() + (needClientAuth ? Boolean.TRUE.hashCode() : Boolean.FALSE.hashCode()) + (enabledCipherSuites == null ? 0 : enabledCipherSuitesList.hashCode()) + (enabledProtocols == null ? 0 : enabledProtocolsList.hashCode());