sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/meter/MonitorEvent.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.meter;
  58
  59
  60 import net.jxta.peergroup.*;
  61 import net.jxta.peer.*;
  62
  63
  64 /**
  65  *      Information regarding a Remote Monitor's Report
  66  **/
  67 public class MonitorEvent {
  68
  69     /** Report received and is available in the event **/
  70     public static final int OK = 200;
  71
  72     /** Report will not come because the registration was cancelled locally **/
  73     public static final int CANCELLED_LOCALLY = 201;
  74
  75     /** Report will not come because the registration was cancelled remotely **/
  76     public static final int CANCELLED_REMOTELY = 202;
  77
  78     /** Report will not come because the of a Timeout **/
  79     public static final int TIMEOUT = 203;
  80
  81     /** Report will not come because the Remote peer has refused it (for security, not supported or load reasons) **/
  82     public static final int REFUSED = 204;
  83
  84     /** Report will not come because the requested report rate is not supported/invalid **/
  85     public static final int INVALID_REPORT_RATE = 205;
  86
  87     /** Report will not come because the provided MonitorFilter was invalid **/
  88     public static final int INVALID_MONITOR_FILTER = 206;
  89
  90     /** Further Reports will not come because the lease was cancelled **/
  91     public static final int LEASE_CANCELLED = 207;
  92
  93     /** Further Reports will not come because the lease renewal request did not receive a response.
  94      * In all likelihood the remote peer has failed (ie crashed)
  95      **/
  96     public static final int LEASE_RENEWAL_TIMEOUT = 208;
  97
  98     /** Internal Error processing Reports, probably due to a bad Monitor Implementation **/
  99     public static final int ERROR = 209;
 100
 101     /** Further Reports will not come because this PeerGroup was destroyed locally **/
 102     public static final int PEERGROUP_DESTROYED = 210;
 103
 104     private int type;
 105     private int requestId;
 106     private PeerID peerID;
 107     private PeerGroupID peerGroupID;
 108     private MonitorFilter monitorFilter; // FIX-ME: Is this necessary?
 109     private long reportRate; // FIX-ME: Is this necessary?
 110     private long leaseTime; // FIX-ME: Is this necessary?
 111     private MonitorReport monitorReport;
 112
 113     private MonitorEvent() {}
 114
 115     public MonitorEvent(PeerGroupID peerGroupID, MonitorReport monitorReport) {
 116         this.peerGroupID = peerGroupID;
 117         this.monitorReport = monitorReport;
 118     }
 119
 120     /**
 121      * Get the Type of Event (one of the above constants)
 122      *
 123      */
 124     public int getType() {
 125         return type;
 126     }
 127
 128     /**
 129      * PeerID of reporting Peer.  My PeerID if local
 130      */
 131     public PeerID getPeerID() {
 132         return peerID;
 133     }
 134
 135     /**
 136      * PeerGroup of reported event
 137      */
 138     public PeerGroupID getPeerGroupID() {
 139         return peerGroupID;
 140     }
 141
 142     /**
 143      * MonitorFilter provided when the report was requested
 144      */
 145     public MonitorFilter getMonitorFilter() {
 146         return monitorFilter;
 147     }
 148
 149     /**
 150      * Reporting rate (unless Cumulative) specified when the report was requested
 151      */
 152     public long getReportRate() {
 153         return reportRate;
 154     }
 155
 156     /**
 157      * Most recent Lease time granted (not specified if a cumulative Report)
 158      */
 159     public long getLeaseTime() {
 160         return leaseTime;
 161     }
 162
 163     /**
 164      * Get the corresponding MonitorReport
 165      */
 166     public MonitorReport getMonitorReport() {
 167         return monitorReport;
 168     }
 169
 170     /**
 171      * The Validated MonitorFilter from the registration or query
 172      *
 173      * @return MonitorFilter
 174      */
 175     public MonitorFilter getValidMonitorFilter() {
 176         return monitorFilter;
 177     }
 178
 179     /**
 180      * Convenience factory method
 181      */
 182     public static MonitorEvent createRemoteMonitorReportEvent(PeerID peerID, int requestId, MonitorReport monitorReport) {
 183         MonitorEvent event = new MonitorEvent();
 184
 185         event.type = OK;
 186         event.peerID = peerID;
 187         event.requestId = requestId;
 188         event.monitorReport = monitorReport;
 189         return event;
 190     }
 191
 192     /**
 193      * Convenience factory method
 194      */
 195     public static MonitorEvent createFailureEvent(int type, PeerID peerID, int requestId) {
 196         MonitorEvent event = new MonitorEvent();
 197
 198         event.type = type;
 199         event.peerID = peerID;
 200         event.requestId = requestId;
 201         return event;
 202     }
 203 }