sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/impl/src/net/jxta/impl/meter/GenericServiceMonitor.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.impl.meter;
  58
  59
  60 import net.jxta.document.Advertisement;
  61 import net.jxta.exception.JxtaException;
  62 import net.jxta.id.ID;
  63 import net.jxta.meter.MonitorResources;
  64 import net.jxta.meter.ServiceMetric;
  65 import net.jxta.meter.ServiceMonitorFilter;
  66 import net.jxta.peergroup.PeerGroup;
  67 import net.jxta.platform.Module;
  68 import net.jxta.platform.ModuleClassID;
  69 import net.jxta.protocol.ModuleImplAdvertisement;
  70
  71
  72 public abstract class GenericServiceMonitor implements ServiceMonitorImpl, Module {
  73     private ModuleClassID moduleClassID;
  74     protected MonitorManager monitorManager;
  75
  76     protected long reportRate;
  77     protected int reportRateIndex;
  78     protected ServiceMetric cumulativeServiceMetric;
  79     protected ServiceMetric deltaServiceMetrics[];
  80     protected ModuleImplAdvertisement implAdvertisement;
  81
  82     public GenericServiceMonitor() {}
  83
  84     // public void init(MonitorManager monitorManager, ModuleClassID moduleClassID) {
  85
  86     public void init(PeerGroup group, ID assignedID, Advertisement advertisement) {
  87         group.unref(); // We do not use the group. These are not quite real modules.
  88         this.implAdvertisement = (ModuleImplAdvertisement) advertisement;
  89         this.moduleClassID = (ModuleClassID) assignedID;
  90     }
  91
  92     public void init(MonitorManager monitorManager) {
  93         this.monitorManager = monitorManager;
  94
  95         if (MeterBuildSettings.METERING) {
  96             cumulativeServiceMetric = createServiceMetric();
  97             deltaServiceMetrics = new ServiceMetric[monitorManager.getReportRatesCount()];
  98             init();
  99         }
 100     }
 101
 102     /*
 103      public void init(MonitorManager monitorManager) {
 104      this.monitorManager = monitorManager;
 105      }
 106      */
 107
 108     public int startApp(java.lang.String[] args) {
 109         return 0;
 110     } // fix-me: what's the right return?
 111
 112     public void stopApp() {}
 113
 114     protected void init() {}
 115
 116     public ModuleClassID getModuleClassID() {
 117         return moduleClassID;
 118     }
 119
 120     public PeerGroup getPeerGroup() {
 121         return monitorManager.getPeerGroup();
 122     }
 123
 124     protected ServiceMetric getCumulativeServiceMetric() {
 125         return cumulativeServiceMetric;
 126     }
 127
 128     public void resetPulseRate(ServiceMonitorPulseInfo pulseInfo, int oldPulseRateIndex) {
 129         this.reportRate = pulseInfo.getPulseRate();
 130         this.reportRateIndex = pulseInfo.getPulseRateIndex();
 131     }
 132
 133     public void validateCumulativeServiceMonitorFilter(ServiceMonitorFilter serviceMonitorFilter) {// base implementation is to accept
 134     }
 135
 136     public ServiceMonitorFilter createSupportedCumulativeServiceMonitorFilter(ServiceMonitorFilter serviceMonitorFilter) {
 137         // base implementation is to accept
 138         return serviceMonitorFilter;
 139     }
 140
 141     public void validateServiceMonitorFilter(ServiceMonitorFilter serviceMonitorFilter, long reportRate) {// base implementation is to accept
 142     }
 143
 144     public ServiceMonitorFilter createSupportedServiceMonitorFilter(ServiceMonitorFilter serviceMonitorFilter, long reportRate) {
 145         // base implementation is to accept
 146         return serviceMonitorFilter;
 147     }
 148
 149     protected ServiceMetric createServiceMetric() {
 150         try {
 151             return MonitorResources.createServiceMetric(moduleClassID);
 152         } catch (JxtaException e) { // this will always succeed since we were able to lad the monitor
 153             return null;
 154         }
 155     }
 156
 157     /**
 158      * Get the service metrics accrued since the last pulse
 159      *
 160      * @return null if there were no metrices since the last call
 161      */
 162     protected abstract ServiceMetric collectServiceMetrics();
 163
 164     public synchronized void beginPulse(ServiceMonitorPulseInfo pulseInfo) {
 165         ServiceMetric baseDeltaServiceMetric = collectServiceMetrics();
 166
 167         deltaServiceMetrics[reportRateIndex] = baseDeltaServiceMetric;
 168
 169         if (baseDeltaServiceMetric != null) {
 170             for (int reportRate = reportRateIndex + 1; reportRate < deltaServiceMetrics.length; reportRate++) {
 171
 172                 if (pulseInfo.isRegisteredFilterForRate(reportRate)) {
 173
 174                     if (deltaServiceMetrics[reportRate] == null) {
 175                         deltaServiceMetrics[reportRate] = createServiceMetric();
 176                     }
 177
 178                     deltaServiceMetrics[reportRate].mergeMetrics(baseDeltaServiceMetric);
 179                 }
 180             }
 181         }
 182     }
 183
 184     public void endPulse(ServiceMonitorPulseInfo pulseInfo) {
 185         for (int reportRateIndex = 0; reportRateIndex < monitorManager.getReportRatesCount(); reportRateIndex++) {
 186             if (pulseInfo.isEvenPulseForRateIndex(reportRateIndex)) {
 187                 deltaServiceMetrics[reportRateIndex] = null;
 188             }
 189         }
 190     }
 191
 192     public void beginCumulativeReport() {}
 193
 194     public void endCumulativeReport() {}
 195
 196     public ServiceMetric getServiceMetric(ServiceMonitorFilter serviceMonitorFilter, long fromTime, long toTime, int reportIndex, long reportRate) {
 197         int deltaReportRateIndex = monitorManager.getReportRateIndex(reportRate);
 198
 199         // Fix-Me: For now we are not yet  supporting filters
 200
 201         return deltaServiceMetrics[deltaReportRateIndex];
 202     }
 203
 204     public ServiceMetric getCumulativeServiceMetric(ServiceMonitorFilter serviceMonitorFilter, long fromTime, long toTime) {
 205         // Fix-Me: For now we are not yet  supporting filters
 206
 207         return cumulativeServiceMetric;
 208     }
 209
 210     public void serviceMonitorFilterRegistered(ServiceMonitorFilter serviceMonitorFilter, int reportRateIndex, long reportRate, boolean newRate) {
 211         if (newRate) {
 212             deltaServiceMetrics[reportRateIndex] = createServiceMetric();
 213         }
 214     }
 215
 216     public void serviceMonitorFilterDeregistered(ServiceMonitorFilter serviceMonitorFilter, int reportRateIndex, long reportRate, boolean retiredRate) {
 217         if (retiredRate) {
 218             deltaServiceMetrics[reportRateIndex] = null;
 219         }
 220     }
 221
 222     public void destroy() {}
 223 }