BUG 2221 : Add metering to ShardTransaction actor
[controller.git] / opendaylight / md-sal / sal-clustering-commons / src / main / java / org / opendaylight / controller / cluster / common / actor / AbstractUntypedActorWithMetering.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 package org.opendaylight.controller.cluster.common.actor;
9
10 /**
11  * Actor with its behaviour metered. Metering is enabled by configuration.
12  */
13 public abstract class AbstractUntypedActorWithMetering extends AbstractUntypedActor {
14
15     //this is used in the metric name. Some transient actors do not have defined names
16     private String actorNameOverride;
17
18     public AbstractUntypedActorWithMetering() {
19         if (isMetricsCaptureEnabled())
20             getContext().become(new MeteringBehavior(this));
21     }
22
23     public AbstractUntypedActorWithMetering(String actorNameOverride){
24         this.actorNameOverride = actorNameOverride;
25         if (isMetricsCaptureEnabled())
26             getContext().become(new MeteringBehavior(this));
27     }
28
29     private boolean isMetricsCaptureEnabled(){
30         CommonConfig config = new CommonConfig(getContext().system().settings().config());
31         return config.isMetricCaptureEnabled();
32     }
33
34     public String getActorNameOverride() {
35         return actorNameOverride;
36     }
37 }