Packages

c

org.apache.spark.network.sasl

SaslRpcHandler

class SaslRpcHandler extends AbstractAuthRpcHandler

RPC Handler which performs SASL authentication before delegating to a child RPC handler. The delegate will only receive messages if the given connection has been successfully authenticated. A connection may be authenticated at most once.

Note that the authentication process consists of multiple challenge-response pairs, each of which are individual RPCs.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SaslRpcHandler
  2. AbstractAuthRpcHandler
  3. RpcHandler
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SaslRpcHandler(conf: TransportConf, channel: Channel, delegate: RpcHandler, secretKeyHolder: SecretKeyHolder)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def channelActive(client: TransportClient): Unit

    Invoked when the channel associated with the given client is active.

    Invoked when the channel associated with the given client is active.

    Definition Classes
    AbstractAuthRpcHandlerRpcHandler
    Annotations
    @Override()
  6. def channelInactive(client: TransportClient): Unit

    Invoked when the channel associated with the given client is inactive.

    Invoked when the channel associated with the given client is inactive. No further requests will come from this client.

    Definition Classes
    SaslRpcHandlerAbstractAuthRpcHandlerRpcHandler
    Annotations
    @Override()
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def doAuthChallenge(client: TransportClient, message: ByteBuffer, callback: RpcResponseCallback): Boolean

    Responds to an authentication challenge.

    Responds to an authentication challenge.

    returns

    Whether the client is authenticated.

    Definition Classes
    SaslRpcHandlerAbstractAuthRpcHandler
    Annotations
    @Override()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def exceptionCaught(cause: Throwable, client: TransportClient): Unit
    Definition Classes
    AbstractAuthRpcHandlerRpcHandler
    Annotations
    @Override()
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getMergedBlockMetaReqHandler(): MergedBlockMetaReqHandler
    Definition Classes
    AbstractAuthRpcHandlerRpcHandler
    Annotations
    @Override()
  15. def getStreamManager(): StreamManager

    Returns the StreamManager which contains the state about which streams are currently being fetched by a TransportClient.

    Returns the StreamManager which contains the state about which streams are currently being fetched by a TransportClient.

    Definition Classes
    AbstractAuthRpcHandlerRpcHandler
    Annotations
    @Override()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def isAuthenticated(): Boolean
    Definition Classes
    AbstractAuthRpcHandler
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def receive(client: TransportClient, message: ByteBuffer): Unit

    Receives an RPC message that does not expect a reply.

    Receives an RPC message that does not expect a reply. The default implementation will call "ByteBuffer, RpcResponseCallback)" and log a warning if any of the callback methods are called.

    client

    A channel client which enables the handler to make requests back to the sender of this RPC. This will always be the exact same object for a particular channel.

    message

    The serialized bytes of the RPC.

    Definition Classes
    AbstractAuthRpcHandlerRpcHandler
    Annotations
    @Override()
  23. final def receive(client: TransportClient, message: ByteBuffer, callback: RpcResponseCallback): Unit

    Receive a single RPC message.

    Receive a single RPC message. Any exception thrown while in this method will be sent back to the client in string form as a standard RPC failure.

    Neither this method nor #receiveStream will be called in parallel for a single TransportClient (i.e., channel).

    client

    A channel client which enables the handler to make requests back to the sender of this RPC. This will always be the exact same object for a particular channel.

    message

    The serialized bytes of the RPC.

    callback

    Callback which should be invoked exactly once upon success or failure of the RPC.

    Definition Classes
    AbstractAuthRpcHandlerRpcHandler
    Annotations
    @Override()
  24. final def receiveStream(client: TransportClient, message: ByteBuffer, callback: RpcResponseCallback): StreamCallbackWithID

    Receive a single RPC message which includes data that is to be received as a stream.

    Receive a single RPC message which includes data that is to be received as a stream. Any exception thrown while in this method will be sent back to the client in string form as a standard RPC failure.

    Neither this method nor #receive will be called in parallel for a single TransportClient (i.e., channel).

    An error while reading data from the stream (ByteBuffer)) will fail the entire channel. A failure in "post-processing" the stream in org.apache.spark.network.client.StreamCallback#onComplete(String) will result in an rpcFailure, but the channel will remain active.

    client

    A channel client which enables the handler to make requests back to the sender of this RPC. This will always be the exact same object for a particular channel.

    callback

    Callback which should be invoked exactly once upon success or failure of the RPC.

    returns

    a StreamCallback for handling the accompanying streaming data

    Definition Classes
    AbstractAuthRpcHandlerRpcHandler
    Annotations
    @Override()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AbstractAuthRpcHandler

Inherited from RpcHandler

Inherited from AnyRef

Inherited from Any

Ungrouped