Class SaslTransportPlugin

java.lang.Object
org.apache.storm.security.auth.sasl.SaslTransportPlugin
All Implemented Interfaces:
Closeable, AutoCloseable, ITransportPlugin
Direct Known Subclasses:
DigestSaslTransportPlugin, KerberosSaslTransportPlugin, PlainSaslTransportPlugin

public abstract class SaslTransportPlugin extends Object implements ITransportPlugin, Closeable
Base class for SASL authentication plugin.
  • Field Details

  • Constructor Details

    • SaslTransportPlugin

      public SaslTransportPlugin()
  • Method Details

    • prepare

      public void prepare(ThriftConnectionType type, Map<String,Object> conf)
      Description copied from interface: ITransportPlugin
      Invoked once immediately after construction.
      Specified by:
      prepare in interface ITransportPlugin
      Parameters:
      type - the type of connection this will process.
      conf - Storm configuration
    • getServer

      public org.apache.storm.thrift.server.TServer getServer(org.apache.storm.thrift.TProcessor processor) throws IOException, org.apache.storm.thrift.transport.TTransportException
      Description copied from interface: ITransportPlugin
      Create a server associated with a given port, service handler, and purpose.
      Specified by:
      getServer in interface ITransportPlugin
      Parameters:
      processor - service handler
      Returns:
      server
      Throws:
      IOException
      org.apache.storm.thrift.transport.TTransportException
    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
    • getServerTransportFactory

      protected abstract org.apache.storm.thrift.transport.TTransportFactory getServerTransportFactory(boolean impersonationAllowed) throws IOException
      Create the transport factory needed for serving. All subclass must implement this method.
      Parameters:
      impersonationAllowed - true if SASL impersonation should be allowed, else false.
      Returns:
      server transport factory
      Throws:
      IOException - on any error.
    • getPort

      public int getPort()
      Description copied from interface: ITransportPlugin
      Get port.
      Specified by:
      getPort in interface ITransportPlugin
      Returns:
      The port this transport is using. This is not known until ITransportPlugin.getServer(org.apache.storm.thrift.TProcessor) has been called