Package org.apache.activemq.artemis.core.remoting.impl.ssl

Class CachingSSLContextFactory

java.lang.Object

org.apache.activemq.artemis.core.remoting.impl.ssl.DefaultSSLContextFactory

org.apache.activemq.artemis.core.remoting.impl.ssl.CachingSSLContextFactory

All Implemented Interfaces:

Comparable<SSLContextFactory>, SSLContextFactory

public class CachingSSLContextFactory
extends DefaultSSLContextFactory

SSLContextFactory providing a cache of SSLContext. Since SSLContext should be reused instead of recreated and are thread safe. To activate it you need to allow this Service to be discovered by having a META-INF/services/org.apache.activemq.artemis.spi.core.remoting.ssl.SSLContextFactory file with org.apache.activemq.artemis.core.remoting.impl.ssl.CachingSSLContextFactory as value.

Field Summary

Fields inherited from interface org.apache.activemq.artemis.spi.core.remoting.ssl.SSLContextFactory

log

Constructor Summary

Constructors

Constructor	Description
CachingSSLContextFactory()

Method Summary

Modifier and Type	Method	Description
void	clearSSLContexts()
protected Object	getCacheKey(SSLContextConfig config, Map<String,Object> additionalOpts)	Obtains/calculates a cache key for the corresponding SslContext.
int	getPriority()	The priority for the SSLContextFactory when resolving the service to get the implementation.
SSLContext	getSSLContext(SSLContextConfig config, Map<String,Object> additionalOpts)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.spi.core.remoting.ssl.SSLContextFactory

compareTo, getSSLContext

Constructor Detail

CachingSSLContextFactory

public CachingSSLContextFactory()

Method Detail

clearSSLContexts

public void clearSSLContexts()

getSSLContext

public SSLContext getSSLContext(SSLContextConfig config,
                                Map<String,Object> additionalOpts)
                         throws Exception

Specified by:

getSSLContext in interface SSLContextFactory

Overrides:

getSSLContext in class DefaultSSLContextFactory

additionalOpts - implementation specific additional options.

Returns:

an SSLContext for the given configuration.

Throws:

Exception

getCacheKey

protected Object getCacheKey(SSLContextConfig config,
                             Map<String,Object> additionalOpts)

Obtains/calculates a cache key for the corresponding SslContext.

1. If config contains an entry with key "sslContext", the associated value is returned
2. Otherwise, the provided SSLContextConfig is used as cache key.

Returns:

the SSL context name to cache/retrieve the SslContext.

getPriority

public int getPriority()

Description copied from interface: SSLContextFactory

The priority for the SSLContextFactory when resolving the service to get the implementation. This is used when selecting the implementation when several implementations are loaded. The highest priority implementation will be used.

Specified by:

getPriority in interface SSLContextFactory

Overrides:

getPriority in class DefaultSSLContextFactory

Returns:

the priority.