Package org.apache.camel.support.jsse

Class SSLContextServerParameters

java.lang.Object

org.apache.camel.support.jsse.JsseParameters

org.apache.camel.support.jsse.BaseSSLContextParameters

org.apache.camel.support.jsse.SSLContextServerParameters

All Implemented Interfaces:

CamelContextAware, HasCamelContext

public class SSLContextServerParameters
extends BaseSSLContextParameters

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.camel.support.jsse.BaseSSLContextParameters

BaseSSLContextParameters.Configurer<T>, BaseSSLContextParameters.SSLContextDecorator, BaseSSLContextParameters.SSLContextSpiDecorator, BaseSSLContextParameters.SSLServerSocketFactoryDecorator, BaseSSLContextParameters.SSLSocketFactoryDecorator

Field Summary

Fields

Modifier and Type	Field	Description
protected String	clientAuthentication	The optional configuration options for server-side client-authentication requirements.

Fields inherited from class org.apache.camel.support.jsse.BaseSSLContextParameters

DEFAULT_CIPHER_SUITES_FILTER_EXCLUDE, DEFAULT_CIPHER_SUITES_FILTER_INCLUDE, DEFAULT_SECURE_SOCKET_PROTOCOLS_FILTER_EXCLUDE, DEFAULT_SECURE_SOCKET_PROTOCOLS_FILTER_INCLUDE

Constructor Summary

Constructors

Constructor	Description
SSLContextServerParameters()

Method Summary

Modifier and Type	Method	Description
protected void	configureSSLContext(SSLContext context)	Configures the actual SSLContext itself with direct setter calls.
protected boolean	getAllowPassthrough()	Returns a flag indicating if default values should be applied in the event that no other property of the instance configures a particular aspect of the entity produced by the instance.
String	getClientAuthentication()
protected List<BaseSSLContextParameters.Configurer<SSLEngine>>	getSSLEngineConfigurers(SSLContext context)	Returns the list of configurers to apply to an SSLEngine in order to fully configure it in compliance with the provided configuration options.
protected List<BaseSSLContextParameters.Configurer<SSLServerSocket>>	getSSLServerSocketFactorySSLServerSocketConfigurers(SSLContext context)	Returns the list of configurers to apply to an SSLServerSocket in order to fully configure it in compliance with the provided configuration options.
protected List<BaseSSLContextParameters.Configurer<SSLSocketFactory>>	getSSLSocketFactoryConfigurers(SSLContext context)	This class has no bearing on SSLSocketFactory instances and therefore provides no configurers for that purpose.
void	setClientAuthentication(String value)	Sets the configuration options for server-side client-authentication requirements.
String	toString()

Methods inherited from class org.apache.camel.support.jsse.BaseSSLContextParameters

configureSessionContext, filter, filter, getCipherSuites, getCipherSuitesFilter, getDefaultCipherSuitesFilter, getDefaultSecureSocketProcotolFilter, getSecureSocketProtocols, getSecureSocketProtocolsFilter, getSessionTimeout, getSNIHostNames, getSSLServerSocketFactoryConfigurers, getSSLSocketFactorySSLSocketConfigurers, matchesOneOf, setCipherSuites, setCipherSuitesFilter, setSecureSocketProtocols, setSecureSocketProtocolsFilter, setSessionTimeout

Methods inherited from class org.apache.camel.support.jsse.JsseParameters

getCamelContext, parsePropertyValue, parsePropertyValues, resolveResource, setCamelContext

Methods inherited from class java.lang.Object

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

Field Details

clientAuthentication

protected String clientAuthentication

The optional configuration options for server-side client-authentication requirements.

Constructor Details

SSLContextServerParameters

public SSLContextServerParameters()

Method Details

getClientAuthentication

public String getClientAuthentication()

See Also:

• setClientAuthentication(String)

setClientAuthentication

public void setClientAuthentication(String value)

Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE as defined in ClientAuthentication.

Parameters:

value - the desired configuration options or null to use the defaults

getAllowPassthrough

protected boolean getAllowPassthrough()

Description copied from class: BaseSSLContextParameters

Returns a flag indicating if default values should be applied in the event that no other property of the instance configures a particular aspect of the entity produced by the instance. This flag is used to allow instances of this class to produce a configurer that simply passes through the current configuration of a configured entity when the instance of this class would otherwise only apply some default configuration.

Overrides:

getAllowPassthrough in class BaseSSLContextParameters

See Also:

• SSLContextClientParameters
• SSLContextServerParameters

configureSSLContext

protected void configureSSLContext(SSLContext context)
                            throws GeneralSecurityException

Description copied from class: BaseSSLContextParameters

Configures the actual SSLContext itself with direct setter calls. This method differs from configuration options that are handled by a configurer instance in that the options are part of the context itself and are not part of some factory or instance object returned by the context.

Overrides:

configureSSLContext in class BaseSSLContextParameters

Parameters:

context - the context to configure

Throws:

GeneralSecurityException - if there is an error configuring the context

getSSLEngineConfigurers

protected List<BaseSSLContextParameters.Configurer<SSLEngine>> getSSLEngineConfigurers(SSLContext context)

Returns the list of configurers to apply to an SSLEngine in order to fully configure it in compliance with the provided configuration options. The configurers are to be applied in the order in which they appear in the list.

This implementation allows for configuration of the need and want settings for client authentication, but ignores the enabled cipher suites and protocols as they are not client and server side specific in an SSLEngine. Consequently, overriding them here would be a bit odd as the server side specific configuration shouldn't really override a shared client/server configuration option.

Overrides:

getSSLEngineConfigurers in class BaseSSLContextParameters

Parameters:

context - the context that serves as the factory for SSLEngine instances

Returns:

the needed configurers

getSSLServerSocketFactorySSLServerSocketConfigurers

protected List<BaseSSLContextParameters.Configurer<SSLServerSocket>> getSSLServerSocketFactorySSLServerSocketConfigurers(SSLContext context)

Description copied from class: BaseSSLContextParameters

Returns the list of configurers to apply to an SSLServerSocket in order to fully configure it in compliance with the provided configuration options. These configurers are intended for sockets produced by a SSLServerSocketFactory, see BaseSSLContextParameters.getSSLSocketFactorySSLSocketConfigurers(SSLContext) for configurers related to sockets produced by a SSLSocketFactory. The configurers are to be applied in the order in which they appear in the list.

Overrides:

getSSLServerSocketFactorySSLServerSocketConfigurers in class BaseSSLContextParameters

Parameters:

context - the context that serves as the factory for SSLServerSocketFactory instances

Returns:

the needed configurers

getSSLSocketFactoryConfigurers

protected List<BaseSSLContextParameters.Configurer<SSLSocketFactory>> getSSLSocketFactoryConfigurers(SSLContext context)

This class has no bearing on SSLSocketFactory instances and therefore provides no configurers for that purpose.

Overrides:

getSSLSocketFactoryConfigurers in class BaseSSLContextParameters

Parameters:

context - the context that serves as the factory for SSLSocketFactory instances

Returns:

the needed configurers

See Also:

• BaseSSLContextParameters.getSSLSocketFactorySSLSocketConfigurers(SSLContext)

toString

public String toString()

Overrides:

toString in class Object