public class

SSLParameters

extends Object
java.lang.Object
   ↳ javax.net.ssl.SSLParameters

Class Overview

Encapsulates parameters for an SSL/TLS connection. The parameters are the list of ciphersuites to be accepted in an SSL/TLS handshake, the list of protocols to be allowed, and whether SSL/TLS servers should request or require client authentication.

SSLParameters can be created via the constructors in this class. Objects can also be obtained using the getSSLParameters() methods in SSLSocket and SSLEngine or the getDefaultSSLParameters() and getSupportedSSLParameters() methods in SSLContext.

SSLParameters can be applied to a connection via the methods SSLSocket.setSSLParameters() and SSLEngine.getSSLParameters().

See Also

Summary

Public Constructors
SSLParameters()
Constructs SSLParameters.
SSLParameters(String[] cipherSuites)
Constructs SSLParameters from the specified array of ciphersuites.
SSLParameters(String[] cipherSuites, String[] protocols)
Constructs SSLParameters from the specified array of ciphersuites and protocols.
Public Methods
String[] getCipherSuites()
Returns a copy of the array of ciphersuites or null if none have been set.
boolean getNeedClientAuth()
Returns whether client authentication should be required.
String[] getProtocols()
Returns a copy of the array of protocols or null if none have been set.
boolean getWantClientAuth()
Returns whether client authentication should be requested.
void setCipherSuites(String[] cipherSuites)
Sets the array of ciphersuites.
void setNeedClientAuth(boolean needClientAuth)
Sets whether client authentication should be required.
void setProtocols(String[] protocols)
Sets the array of protocols.
void setWantClientAuth(boolean wantClientAuth)
Sets whether client authentication should be requested.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SSLParameters ()

Constructs SSLParameters.

The cipherSuites and protocols values are set to null, wantClientAuth and needClientAuth are set to false.

public SSLParameters (String[] cipherSuites)

Constructs SSLParameters from the specified array of ciphersuites. Calling this constructor is equivalent to calling the no-args constructor followed by setCipherSuites(cipherSuites);.

Parameters
cipherSuites the array of ciphersuites (or null)

public SSLParameters (String[] cipherSuites, String[] protocols)

Constructs SSLParameters from the specified array of ciphersuites and protocols. Calling this constructor is equivalent to calling the no-args constructor followed by setCipherSuites(cipherSuites); setProtocols(protocols);.

Parameters
cipherSuites the array of ciphersuites (or null)
protocols the array of protocols (or null)

Public Methods

public String[] getCipherSuites ()

Returns a copy of the array of ciphersuites or null if none have been set.

Returns
  • a copy of the array of ciphersuites or null if none have been set.

public boolean getNeedClientAuth ()

Returns whether client authentication should be required.

Returns
  • whether client authentication should be required.

public String[] getProtocols ()

Returns a copy of the array of protocols or null if none have been set.

Returns
  • a copy of the array of protocols or null if none have been set.

public boolean getWantClientAuth ()

Returns whether client authentication should be requested.

Returns
  • whether client authentication should be requested.

public void setCipherSuites (String[] cipherSuites)

Sets the array of ciphersuites.

Parameters
cipherSuites the array of ciphersuites (or null)

public void setNeedClientAuth (boolean needClientAuth)

Sets whether client authentication should be required. Calling this method clears the wantClientAuth flag.

Parameters
needClientAuth whether client authentication should be required

public void setProtocols (String[] protocols)

Sets the array of protocols.

Parameters
protocols the array of protocols (or null)

public void setWantClientAuth (boolean wantClientAuth)

Sets whether client authentication should be requested. Calling this method clears the needClientAuth flag.

Parameters
wantClientAuth whether client authentication should be requested