2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.access.client;
10 import akka.actor.ActorRef;
11 import com.google.common.annotations.Beta;
12 import com.google.common.base.Preconditions;
13 import javax.annotation.Nonnull;
14 import javax.annotation.Nullable;
17 * Base behavior attached to {@link AbstractClientActor}.
19 * @param <C> Type of associated context
21 * @author Robert Varga
24 public abstract class AbstractClientActorBehavior<C extends AbstractClientActorContext> {
25 private final C context;
27 AbstractClientActorBehavior(@Nonnull final C context) {
28 // Hidden to prevent outside subclasses. Users instantiated this via ClientActorBehavior
29 this.context = Preconditions.checkNotNull(context);
33 * Return an {@link AbstractClientActorContext} associated with this {@link AbstractClientActor}.
35 * @return A client actor context instance.
38 protected final C context() {
43 * Return the persistence identifier associated with this {@link AbstractClientActor}. This identifier should be
44 * used in logging to identify this actor.
46 * @return Persistence identifier
49 protected final String persistenceId() {
50 return context.persistenceId();
54 * Return an {@link ActorRef} of this ClientActor.
56 * @return Actor associated with this behavior
59 public final ActorRef self() {
60 return context.self();
64 * Implementation-internal method for handling an incoming command message.
66 * @param command Command message
67 * @return Behavior which should be used with the next message. Return null if this actor should shut down.
70 abstract AbstractClientActorBehavior<?> onReceiveCommand(@Nonnull Object command);
73 * Implementation-internal method for handling an incoming recovery message coming from persistence.
75 * @param recover Recover message
76 * @return Behavior which should be used with the next message. Return null if this actor should shut down.
79 abstract AbstractClientActorBehavior<?> onReceiveRecover(@Nonnull Object recover);