Top Description Fields Constructors Methods
com.sun.net.httpserver

public abstract Class HttpsParameters

extends Object
Class Inheritance
Known Direct Subclasses
sun.net.httpserver.SSLStreams.Parameters
Imports
java.net.InetSocketAddress, javax.net.ssl.SSLContext, .SSLParameters
Represents the set of parameters for each https connection negotiated with clients. One of these is created and passed to HttpsConfigurator#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 javax.net.ssl.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.

Since
1.6

Field Summary

Modifier and TypeField and Description
private String[]
cipherSuites

private boolean
needClientAuth

private String[]
protocols

private boolean
wantClientAuth

Constructor Summary

AccessConstructor and Description
protected
HttpsParameters()

Constructor for subclasses to call.

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

a copy of the array of ciphersuites or null if none have been set
getCipherSuites()
Deprecated since 23. It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

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

public abstract InetSocketAddress

Returns:

address of the remote client initiating the connection
getClientAddress()

Returns the address of the remote client initiating the connection.

public abstract HttpsConfigurator

Returns:

HttpsConfigurator for this instance of HttpsParameters
getHttpsConfigurator()

Returns the HttpsConfigurator for this HttpsParameters.

public boolean

Returns:

whether client authentication should be required
getNeedClientAuth()
Deprecated since 23. It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

Returns whether client authentication should be required.

public String[]

Returns:

a copy of the array of protocols or null if none have been set
getProtocols()
Deprecated since 23. It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

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

public boolean

Returns:

whether client authentication should be requested
getWantClientAuth()
Deprecated since 23. It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

Returns whether client authentication should be requested.

public void
setCipherSuites(String[]
the array of ciphersuites (or null)
cipherSuites)
Deprecated since 23. It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

Sets the array of ciphersuites.

public void
setNeedClientAuth(boolean
whether client authentication should be required
needClientAuth)
Deprecated since 23. It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

Sets whether client authentication should be required.

public void
setProtocols(String[]
the array of protocols (or null)
protocols)
Deprecated since 23. It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

Sets the array of protocols.

public abstract void
setSSLParameters(SSLParameters
the SSLParameters to set. If null then the existing parameters (if any) remain unchanged
params)

Sets the SSLParameters to use for this HttpsParameters.

public void
setWantClientAuth(boolean
whether client authentication should be requested
wantClientAuth)
Deprecated since 23. It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

Sets whether client authentication should be requested.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cipherSuitesback to summary
private String[] cipherSuites
needClientAuthback to summary
private boolean needClientAuth
protocolsback to summary
private String[] protocols
wantClientAuthback to summary
private boolean wantClientAuth

Constructor Detail

HttpsParametersback to summary
protected HttpsParameters()

Constructor for subclasses to call.

Method Detail

getCipherSuitesback to summary
public String[] getCipherSuites()

Deprecated

since 23.

It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

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

Returns:String[]

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

Annotations
@Deprecated
since:23
getClientAddressback to summary
public abstract InetSocketAddress getClientAddress()

Returns the address of the remote client initiating the connection.

Returns:InetSocketAddress

address of the remote client initiating the connection

getHttpsConfiguratorback to summary
public abstract HttpsConfigurator getHttpsConfigurator()

Returns the HttpsConfigurator for this HttpsParameters.

Returns:HttpsConfigurator

HttpsConfigurator for this instance of HttpsParameters

getNeedClientAuthback to summary
public boolean getNeedClientAuth()

Deprecated

since 23.

It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

Returns whether client authentication should be required.

Returns:boolean

whether client authentication should be required

Annotations
@Deprecated
since:23
getProtocolsback to summary
public String[] getProtocols()

Deprecated

since 23.

It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

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

Returns:String[]

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

Annotations
@Deprecated
since:23
getWantClientAuthback to summary
public boolean getWantClientAuth()

Deprecated

since 23.

It is recommended that the SSL parameters be configured and read through the use of SSLParameters.

Returns whether client authentication should be requested.

Returns:boolean

whether client authentication should be requested

Annotations
@Deprecated
since:23
setCipherSuitesback to summary
public void setCipherSuites(String[] cipherSuites)

Deprecated

since 23.

It is recommended that the SSL parameters be configured and read through the use of SSLParameters. Use SSLParameters#setCipherSuites(String[]) instead.

Sets the array of ciphersuites.

Parameters
cipherSuites:String[]

the array of ciphersuites (or null)

Annotations
@Deprecated
since:23
setNeedClientAuthback to summary
public void setNeedClientAuth(boolean needClientAuth)

Deprecated

since 23.

It is recommended that the SSL parameters be configured and read through the use of SSLParameters. Use SSLParameters#setNeedClientAuth(boolean) instead.

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

Parameters
needClientAuth:boolean

whether client authentication should be required

Annotations
@Deprecated
since:23
setProtocolsback to summary
public void setProtocols(String[] protocols)

Deprecated

since 23.

It is recommended that the SSL parameters be configured and read through the use of SSLParameters. Use SSLParameters#setProtocols(String[]) instead.

Sets the array of protocols.

Parameters
protocols:String[]

the array of protocols (or null)

Annotations
@Deprecated
since:23
setSSLParametersback to summary
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:SSLParameters

the SSLParameters to set. If null then the existing parameters (if any) remain unchanged

Exceptions
IllegalArgumentException:
if any of the parameters are invalid or unsupported
setWantClientAuthback to summary
public void setWantClientAuth(boolean wantClientAuth)

Deprecated

since 23.

It is recommended that the SSL parameters be configured and read through the use of SSLParameters. Use SSLParameters#setWantClientAuth(boolean) instead.

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

Parameters
wantClientAuth:boolean

whether client authentication should be requested

Annotations
@Deprecated
since:23