public abstract class

HttpsParameters

extends Object
java.lang.Object
   ↳ com.sun.net.httpserver.HttpsParameters

Class Overview

Represents the set of parameters for each https connection negotiated with clients. One of these is created and passed to configure(HttpsParameters) for every incoming https connection, in order to determine the parameters to use.

The underlying SSL parameters may be established either via the set/get methods of this class, or else via a SSLParameters object. SSLParameters is the preferred method, because in the future, additional configuration capabilities may be added to that class, and it is easier to determine the set of supported parameters and their default values with SSLParameters. Also, if an SSLParameters object is provided via setSSLParameters(SSLParameters) then those parameter settings are used, and any settings made in this object are ignored.

Summary

Protected Constructors
HttpsParameters()
Public Methods
String[] getCipherSuites()
Returns a copy of the array of ciphersuites or null if none have been set.
abstract InetSocketAddress getClientAddress()
Returns the address of the remote client initiating the connection.
abstract HttpsConfigurator getHttpsConfigurator()
Returns the HttpsConfigurator for this HttpsParameters.
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.
abstract void setSSLParameters(SSLParameters params)
Sets the SSLParameters to use for this HttpsParameters.
void setWantClientAuth(boolean wantClientAuth)
Sets whether client authentication should be requested.
[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected HttpsParameters ()

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 abstract InetSocketAddress getClientAddress ()

Returns the address of the remote client initiating the connection.

public abstract HttpsConfigurator getHttpsConfigurator ()

Returns the HttpsConfigurator for this HttpsParameters.

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 abstract void setSSLParameters (SSLParameters params)

Sets the SSLParameters to use for this HttpsParameters. The parameters must be supported by the SSLContext contained by the HttpsConfigurator associated with this HttpsParameters. If no parameters are set, then the default behavior is to use the default parameters from the associated SSLContext.

Parameters
params the SSLParameters to set. If null then the existing parameters (if any) remain unchanged.
Throws
IllegalArgumentException if any of the parameters are invalid or unsupported.

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