appc-metric/appc-metric-bundle/src/main/java/org/openecomp/appc/metricservice/policy/PublishingPolicy.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : APP-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                                              reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.openecomp.appc.metricservice.policy;
  23
  24 import org.openecomp.appc.exceptions.APPCException;
  25 import org.openecomp.appc.metricservice.metric.Metric;
  26
  27 /**
  28  *
  29  * A custom logic that determines strategy of exposing metric values.
  30  * Policy is associated with a specific registry and its implementation can very from the simplest options, such as 'real-time' behavior (upon each value change) to more sophisticated approaches such as thresholds or recurrent scheduling rules.
  31  * The policy can also decide whether or not to publish the entire metric registry or just a subset of the it (e.g. changed ones).
  32  * Policy supports execution of one or more Publishers.
  33  *
  34  */
  35 public interface PublishingPolicy {
  36     void        onMetricChange(Metric meric) throws APPCException;
  37     Metric[]    metrics();
  38
  39     void init();
  40 }