Ensure AbstractUntypedActor#unknownMessage() is called
[controller.git] / 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.UntypedActor;
12 import org.slf4j.Logger;
13 import org.slf4j.LoggerFactory;
14
15 public abstract class AbstractUntypedActor extends UntypedActor {
16     protected final Logger LOG = LoggerFactory.getLogger(getClass());
17
18     protected AbstractUntypedActor() {
19         LOG.debug("Actor created {}", getSelf());
20         getContext().system().actorSelection("user/termination-monitor").tell(new Monitor(getSelf()), getSelf());
21     }
22
23     @Override
24     public final void onReceive(Object message) throws Exception {
25         handleReceive(message);
26     }
27
28     /**
29      * Receive and handle an incoming message. If the implementation does not handle this particular message,
30      * it should call {@link #ignoreMessage(Object)} or {@link #unknownMessage(Object)}.
31      *
32      * @param message Incoming message
33      * @throws Exception
34      */
35     protected abstract void handleReceive(Object message) throws Exception;
36
37     protected final void ignoreMessage(Object message) {
38         LOG.debug("Ignoring unhandled message {}", message);
39     }
40
41     protected final void unknownMessage(Object message) {
42         LOG.debug("Received unhandled message {}", message);
43         unhandled(message);
44     }
45 }