opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/AbstractUntypedActor.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.cluster.common.actor;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.UntypedActor;
  13 import org.slf4j.Logger;
  14 import org.slf4j.LoggerFactory;
  15
  16 public abstract class AbstractUntypedActor extends UntypedActor {
  17     protected final Logger LOG = LoggerFactory.getLogger(getClass());
  18
  19     protected AbstractUntypedActor() {
  20         LOG.debug("Actor created {}", getSelf());
  21         getContext().system().actorSelection("user/termination-monitor").tell(new Monitor(getSelf()), getSelf());
  22     }
  23
  24     @Override
  25     public final void onReceive(Object message) throws Exception {
  26         handleReceive(message);
  27     }
  28
  29     /**
  30      * Receive and handle an incoming message. If the implementation does not handle this particular message,
  31      * it should call {@link #ignoreMessage(Object)} or {@link #unknownMessage(Object)}.
  32      *
  33      * @param message Incoming message
  34      * @throws Exception
  35      */
  36     protected abstract void handleReceive(Object message) throws Exception;
  37
  38     protected final void ignoreMessage(Object message) {
  39         LOG.debug("Ignoring unhandled message {}", message);
  40     }
  41
  42     protected final void unknownMessage(Object message) {
  43         LOG.debug("Received unhandled message {}", message);
  44         unhandled(message);
  45     }
  46
  47     protected boolean isValidSender(ActorRef sender) {
  48         // If the caller passes in a null sender (ActorRef.noSender()), akka translates that to the
  49         // deadLetters actor.
  50         return sender != null && !getContext().system().deadLetters().equals(sender);
  51     }
  52 }