org.apache.flink.runtime.akka

Class FlinkUntypedActor

java.lang.Object

akka.actor.UntypedActor

org.apache.flink.runtime.akka.FlinkUntypedActor

All Implemented Interfaces:

akka.actor.Actor

Direct Known Subclasses:

FlinkResourceManager, JobClientActor

public abstract class FlinkUntypedActor
extends akka.actor.UntypedActor

Base class for Flink's actors implemented with Java. Actors inheriting from this class automatically log received messages when the debug log level is activated. Furthermore, they filter out JobManagerMessages.LeaderSessionMessage with the wrong leader session ID. If a message of type RequiresLeaderSessionID without being wrapped in a LeaderSessionMessage is detected, then an Exception is thrown.

In order to implement the actor behavior, an implementing subclass has to override the method handleMessage, which defines how messages are processed. Furthermore, the subclass has to provide a leader session ID option which is returned by getLeaderSessionID.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

akka.actor.Actor.emptyBehavior$, akka.actor.Actor.ignoringBehavior$

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
FlinkUntypedActor()

Method Summary

Modifier and Type	Method and Description
protected Object	decorateMessage(Object message) This method should be called for every outgoing message.
protected abstract UUID	getLeaderSessionID() Returns the current leader session ID associated with this actor.
protected abstract void	handleMessage(Object message) This method contains the actor logic which defines how to react to incoming messages.
void	onReceive(Object message) This method is called by Akka if a new message has arrived for the actor.

Methods inherited from class akka.actor.UntypedActor

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, getContext, getSelf, getSender, postRestart, postStop, preRestart, preStart, receive, self, sender, supervisorStrategy, unhandled

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected final org.slf4j.Logger LOG

Constructor Detail

FlinkUntypedActor

public FlinkUntypedActor()

Method Detail

onReceive

public final void onReceive(Object message)
                     throws Exception

This method is called by Akka if a new message has arrived for the actor. It logs the processing time of the incoming message if the logging level is set to debug. After logging the handleLeaderSessionID method is called.

Important: This method cannot be overridden. The actor specific message handling logic is implemented by the method handleMessage.

Specified by:

onReceive in class akka.actor.UntypedActor

Parameters:

message - Incoming message

Throws:

Exception

handleMessage

protected abstract void handleMessage(Object message)
                               throws Exception

This method contains the actor logic which defines how to react to incoming messages.

Parameters:

message - Incoming message

Throws:

Exception

getLeaderSessionID

protected abstract UUID getLeaderSessionID()

Returns the current leader session ID associated with this actor.

Returns:

decorateMessage

protected Object decorateMessage(Object message)

This method should be called for every outgoing message. It wraps messages which require a leader session ID (indicated by RequiresLeaderSessionID) in a JobManagerMessages.LeaderSessionMessage with the actor's leader session ID.

This method can be overridden to implement a different decoration behavior.

Parameters:

message - Message to be decorated

Returns:

The decorated message