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.datastore.actors.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}. Exposes
20 * @param <C> Type of associated context
22 * @author Robert Varga
25 public abstract class AbstractClientActorBehavior<C extends AbstractClientActorContext> {
26 private final C context;
28 AbstractClientActorBehavior(final @Nonnull C context) {
29 // Hidden to prevent outside subclasses. Users instantiated this via ClientActorBehavior
30 this.context = Preconditions.checkNotNull(context);
34 * Return an {@link AbstractClientActorContext} associated with this {@link AbstractClientActor}.
36 * @return A client actor context instance.
38 protected final @Nonnull 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
48 protected final @Nonnull String persistenceId() {
49 return context.persistenceId();
53 * Return an {@link ActorRef} of this ClientActor.
57 public final @Nonnull ActorRef self() {
58 return context.self();
62 * Implementation-internal method for handling an incoming command message.
64 * @param command Command message
65 * @return Behavior which should be used with the next message. Return null if this actor should shut down.
67 abstract @Nullable AbstractClientActorBehavior<?> onReceiveCommand(@Nonnull Object command);
70 * Implementation-internal method for handling an incoming recovery message coming from persistence.
72 * @param recover Recover message
73 * @return Behavior which should be used with the next message. Return null if this actor should shut down.
75 abstract @Nullable AbstractClientActorBehavior<?> onReceiveRecover(@Nonnull Object recover);