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

Interface OpenSSLContextFactory

All Superinterfaces:
Comparable<OpenSSLContextFactory>
All Known Implementing Classes:
CachingOpenSSLContextFactory, DefaultOpenSSLContextFactory
public interface OpenSSLContextFactory extends Comparable<OpenSSLContextFactory>
Service interface to create an SslContext for a configuration. This is ONLY used with OpenSSL. To create and use your own implementation you need to create a file META-INF/services/org.apache.activemq.artemis.spi.core.remoting.ssl.OpenSSLContextFactory in your jar and fill it with the full qualified name of your implementation.

  • Method Details

    • clearSslContexts

      default void clearSslContexts()
      Release any cached SslContext instances.

    • compareTo

      default int compareTo(OpenSSLContextFactory other)
      Specified by:
      compareTo in interface Comparable<OpenSSLContextFactory>

    • getClientSslContext

      io.netty.handler.ssl.SslContext getClientSslContext(SSLContextConfig config, Map<String,Object> additionalOpts) throws Exception
      Parameters:
      additionalOpts - implementation specific additional options.
      Returns:
      an SslContext instance for the given configuration
      Throws:
      Exception

    • getServerSslContext

      io.netty.handler.ssl.SslContext getServerSslContext(SSLContextConfig config, Map<String,Object> additionalOpts) throws Exception
      Parameters:
      additionalOpts - implementation specific additional options.
      Returns:
      an SslContext instance for the given configuration
      Throws:
      Exception

    • getPriority

      int getPriority()
      The priority for the OpenSSLContextFactory 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.