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

Constructors

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 Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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