W3cubDocs

/OpenJDK 21

Class HttpsConfigurator

java.lang.Object
com.sun.net.httpserver.HttpsConfigurator
public class HttpsConfigurator extends Object
This class is used to configure the https parameters for each incoming https connection on a HttpsServer. Applications need to override the configure(HttpsParameters) method in order to change the default configuration.

The following example shows how this may be done:

 SSLContext sslContext = SSLContext.getInstance (....);
 HttpsServer server = HttpsServer.create();

 server.setHttpsConfigurator (new HttpsConfigurator(sslContext) {
     public void configure (HttpsParameters params) {

         // get the remote address if needed
         InetSocketAddress remote = params.getClientAddress();

         SSLContext c = getSSLContext();

         // get the default parameters
         SSLParameters sslparams = c.getDefaultSSLParameters();
         if (remote.equals (...) ) {
             // modify the default set for client x
         }

         params.setSSLParameters(sslparams);
     }
 });
 
Since:
1.6

Constructor Summary

Constructor Description
HttpsConfigurator(SSLContext context)
Creates a Https configuration, with the given SSLContext.

Method Summary

Modifier and Type Method Description
void configure(HttpsParameters params)
Called by the HttpsServer to configure the parameters for a https connection currently being established.
SSLContext getSSLContext()
Returns the SSLContext for this HttpsConfigurator.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpsConfigurator

public HttpsConfigurator(SSLContext context)
Creates a Https configuration, with the given SSLContext.
Parameters:
context - the SSLContext to use for this configurator
Throws:
NullPointerException - if no SSLContext supplied

Method Details

getSSLContext

public SSLContext getSSLContext()
Returns the SSLContext for this HttpsConfigurator.
Returns:
the SSLContext

configure

public void configure(HttpsParameters params)
Called by the HttpsServer to configure the parameters for a https connection currently being established. The implementation of configure() must call HttpsParameters.setSSLParameters(SSLParameters) in order to set the SSL parameters for the connection.

The default implementation of this method uses the SSLParameters returned from:

getSSLContext().getDefaultSSLParameters()

configure() may be overridden in order to modify this behavior. See example above.

Parameters:
params - the HttpsParameters to be configured
Since:
1.6

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.httpserver/com/sun/net/httpserver/HttpsConfigurator.html