Home » synapse-1.2-src » org.apache.synapse.statistics » [javadoc | source]

    1   /*
    2    *  Licensed to the Apache Software Foundation (ASF) under one
    3    *  or more contributor license agreements.  See the NOTICE file
    4    *  distributed with this work for additional information
    5    *  regarding copyright ownership.  The ASF licenses this file
    6    *  to you under the Apache License, Version 2.0 (the
    7    *  "License"); you may not use this file except in compliance
    8    *  with the License.  You may obtain a copy of the License at
    9    *
   10    *   http://www.apache.org/licenses/LICENSE-2.0
   11    *
   12    *  Unless required by applicable law or agreed to in writing,
   13    *  software distributed under the License is distributed on an
   14    *   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   15    *  KIND, either express or implied.  See the License for the
   16    *  specific language governing permissions and limitations
   17    *  under the License.
   18    */
   19   package org.apache.synapse.statistics;
   20   
   21   /**
   22    *  This interface need to be implemented by each of the entry that
   23    *  need to collect statistics
   24    *
   25    */
   26   
   27   public interface StatisticsStack {
   28   
   29       /**
   30        * This method is used to put current statistics
   31        * @param key
   32        * @param initTime
   33        * @param isInFlow
   34        * @param isStatisticsEnable
   35        * @param isFault
   36        */
   37       public void put(String key,long initTime, boolean isInFlow, boolean isStatisticsEnable,
   38                       boolean isFault);
   39   
   40       /**
   41        * This method used to report the latest  statistics to the StatisticsCollector
   42        * @param statisticsCollector
   43        * @param isFault
   44        */
   45       public void reportToStatisticsCollector(StatisticsCollector statisticsCollector,
   46                                               boolean isFault);
   47   
   48       /**
   49        * Report the particular statistics to the StatisticsCollector
   50        *
   51        * @param statisticsCollector
   52        * @param isFault
   53        * @param name
   54        */
   55       public void reportToStatisticsCollector(StatisticsCollector statisticsCollector,
   56                                               boolean isFault, String name);
   57   
   58       /**
   59        * This method  used to unreported all statistics to the StatisticsCollector
   60        * @param statisticsCollector
   61        * @param isFault
   62        */
   63       public void reportAllToStatisticsCollector(StatisticsCollector statisticsCollector,
   64                                                  boolean isFault);
   65   
   66   }

Home » synapse-1.2-src » org.apache.synapse.statistics » [javadoc | source]