org.italiangrid.utils.jetty

Class TLSServerConnectorBuilder

java.lang.Object

org.italiangrid.utils.jetty.TLSServerConnectorBuilder

public class TLSServerConnectorBuilder
extends Object

A builder that configures a Jetty server TLS connector integrated with CANL X509CertChainValidatorExt certificate validation services.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CERTIFICATE_FILE Default service certificate file.
static String	DEFAULT_CERTIFICATE_KEY_FILE Default service certificate private key file.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jetty.server.ServerConnector	build() Builds a ServerConnector based on the TLSServerConnectorBuilder parameters
org.eclipse.jetty.server.HttpConfiguration	httpConfiguration() Gives access to the HttpConfiguration used for the TLS-enabled connector being created.
static TLSServerConnectorBuilder	instance(org.eclipse.jetty.server.Server s, eu.emi.security.authn.x509.X509CertChainValidatorExt certificateValidator) Returns an instance of the TLSServerConnectorBuilder.
TLSServerConnectorBuilder	withCertificateFile(String certificateFile) Sets the certificate file for the connector being created.
TLSServerConnectorBuilder	withCertificateKeyFile(String certificateKeyFile) Sets the certificate key file for the connector being created.
TLSServerConnectorBuilder	withCertificateKeyPassword(char[] certificateKeyPassword) The the certificate key password for the connector being built
TLSServerConnectorBuilder	withExcludeCipherSuites(String... excludeCipherSuites) Sets the SSL ecluded cipher suites.
TLSServerConnectorBuilder	withExcludeProtocols(String... excludeProtocols) Sets SSL excluded protocols.
TLSServerConnectorBuilder	withHttpConfiguration(org.eclipse.jetty.server.HttpConfiguration conf) Sets the HttpConfiguration for the connector being built.
TLSServerConnectorBuilder	withIncludeCipherSuites(String... includeCipherSuites) Sets the SSL included cipher suites.
TLSServerConnectorBuilder	withIncludeProtocols(String... includeProtocols) Sets SSL included protocols.
TLSServerConnectorBuilder	withKeyManager(KeyManager km) Sets the KeyManager for the connector being built.
TLSServerConnectorBuilder	withNeedClientAuth(boolean needClientAuth) Sets the SslContextFactory.setNeedClientAuth(boolean) parameter for the connector being created.
TLSServerConnectorBuilder	withPort(int port) Sets the port for the connector being created.
TLSServerConnectorBuilder	withWantClientAuth(boolean wantClientAuth) Sets the SslContextFactory.setWantClientAuth(boolean) parameter for the connector being created.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CERTIFICATE_FILE

public static final String DEFAULT_CERTIFICATE_FILE

Default service certificate file.

See Also:

Constant Field Values

DEFAULT_CERTIFICATE_KEY_FILE

public static final String DEFAULT_CERTIFICATE_KEY_FILE

Default service certificate private key file.

See Also:

Constant Field Values

Method Detail

instance

public static TLSServerConnectorBuilder instance(org.eclipse.jetty.server.Server s,
                                                 eu.emi.security.authn.x509.X509CertChainValidatorExt certificateValidator)

Returns an instance of the TLSServerConnectorBuilder.

Parameters:

s - the Server for which the connector is being created

certificateValidator - a X509CertChainValidatorExt used to validate certificates

Returns:

an instance of the TLSServerConnectorBuilder

httpConfiguration

public org.eclipse.jetty.server.HttpConfiguration httpConfiguration()

Gives access to the HttpConfiguration used for the TLS-enabled connector being created. If the configuration is not set, it creates it using defaultHttpConfiguration().

Returns:

the HttpConfiguration being used for the TLS-enabled connector.

withPort

public TLSServerConnectorBuilder withPort(int port)

Sets the port for the connector being created.

Parameters:

port - the port for the connector

Returns:

this builder

withCertificateFile

public TLSServerConnectorBuilder withCertificateFile(String certificateFile)

Sets the certificate file for the connector being created.

Parameters:

certificateFile - the certificate file

Returns:

this builder

withCertificateKeyFile

public TLSServerConnectorBuilder withCertificateKeyFile(String certificateKeyFile)

Sets the certificate key file for the connector being created.

Parameters:

certificateKeyFile - the certificate key file

Returns:

this builder

withCertificateKeyPassword

public TLSServerConnectorBuilder withCertificateKeyPassword(char[] certificateKeyPassword)

The the certificate key password for the connector being built

Parameters:

certificateKeyPassword - the certificate key password

Returns:

this builder

withNeedClientAuth

public TLSServerConnectorBuilder withNeedClientAuth(boolean needClientAuth)

Sets the SslContextFactory.setNeedClientAuth(boolean) parameter for the connector being created.

Parameters:

needClientAuth - true if client authentication is required

Returns:

this builder

withWantClientAuth

public TLSServerConnectorBuilder withWantClientAuth(boolean wantClientAuth)

Sets the SslContextFactory.setWantClientAuth(boolean) parameter for the connector being created.

Parameters:

wantClientAuth - true if client authentication is wanted

Returns:

this builder

withIncludeProtocols

public TLSServerConnectorBuilder withIncludeProtocols(String... includeProtocols)

Sets SSL included protocols. See SslContextFactory.setIncludeProtocols(String...).

Parameters:

includeProtocols - the array of included protocol names

Returns:

this builder

withExcludeProtocols

public TLSServerConnectorBuilder withExcludeProtocols(String... excludeProtocols)

Sets SSL excluded protocols. See SslContextFactory.setExcludeProtocols(String...).

Parameters:

excludeProtocols - the array of excluded protocol names

Returns:

this builder

withIncludeCipherSuites

public TLSServerConnectorBuilder withIncludeCipherSuites(String... includeCipherSuites)

Sets the SSL included cipher suites.

Parameters:

includeCipherSuites - the array of included cipher suites.

Returns:

this builder

withExcludeCipherSuites

public TLSServerConnectorBuilder withExcludeCipherSuites(String... excludeCipherSuites)

Sets the SSL ecluded cipher suites.

Parameters:

excludeCipherSuites - the array of excluded cipher suites.

Returns:

this builder

withHttpConfiguration

public TLSServerConnectorBuilder withHttpConfiguration(org.eclipse.jetty.server.HttpConfiguration conf)

Sets the HttpConfiguration for the connector being built.

Parameters:

conf - the HttpConfiguration to use

Returns:

this builder

withKeyManager

public TLSServerConnectorBuilder withKeyManager(KeyManager km)

Sets the KeyManager for the connector being built.

Parameters:

km - the KeyManager to use

Returns:

this builder

build

public org.eclipse.jetty.server.ServerConnector build()

Builds a ServerConnector based on the TLSServerConnectorBuilder parameters

Returns:

a ServerConnector