KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > instrument > manager > interfaces > InstrumentSampleDescriptor


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */
50 package org.apache.excalibur.instrument.manager.interfaces;
51
52 /**
53  * Describes an InstrumentSample and acts as a Proxy to protect the original
54  * InstrumentSample object.
55  *
56  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
57  * @version CVS $Revision: 1.3 $ $Date: 2003/02/20 17:08:19 $
58  * @since 4.1
59  */
60 public interface InstrumentSampleDescriptor
61 {
62     /**
63      * Returns true if the InstrumentSample was configured in the instrumentables
64      * section of the configuration.
65      *
66      * @return True if configured.
67      */
68     boolean isConfigured();
69     
70     /**
71      * Returns the name of the sample.
72      *
73      * @return The name of the sample.
74      */
75     String JavaDoc getName();
76     
77     /**
78      * Returns the sample interval. The period of each sample in millisends.
79      *
80      * @return The sample interval.
81      */
82     long getInterval();
83     
84     /**
85      * Returns the number of samples in the sample history.
86      *
87      * @return The size of the sample history.
88      */
89     int getSize();
90     
91     /**
92      * Returns the description of the sample.
93      *
94      * @return The description of the sample.
95      */
96     String JavaDoc getDescription();
97     
98     /**
99      * Returns the type of the Instrument Sample. Possible values include
100      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER,
101      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MAXIMUM,
102      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MEAN, or
103      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MINIMUM.
104      *
105      * @return The type of the Instrument Sample.
106      */
107     int getType();
108     
109     /**
110      * Obtain the value of the sample. All samples are integers, so the profiled
111      * objects must measure quantity (numbers of items), rate (items/period), time in
112      * milliseconds, etc.
113      *
114      * @return The sample value.
115      */
116     int getValue();
117     
118     /**
119      * Obtain the UNIX time of the beginning of the sample.
120      *
121      * @return The UNIX time of the beginning of the sample.
122      */
123     long getTime();
124     
125     /**
126      * Returns the Type of the Instrument which can use the sample. This
127      * should be the same for all instances of a class.
128      * <p>
129      * Should be one of the following: InstrumentManager.PROFILE_POINT_TYPE_COUNTER
130      * or InstrumentManager.PROFILE_POINT_TYPE_VALUE
131      *
132      * @return The Type of the Instrument which can use the sample.
133      */
134     int getInstrumentType();
135     
136     /**
137      * Returns the time that the current lease expires. Permanent samples will
138      * return a value of 0.
139      *
140      * @return The time that the current lease expires.
141      */
142     long getLeaseExpirationTime();
143     
144     /**
145      * Extends the lease to be lease milliseconds from the current time.
146      *
147      * @param lease The length of the lease in milliseconds.
148      *
149      * @return The new lease expiration time. Returns 0 if the sample is
150      * permanent.
151      */
152     long extendLease( long lease );
153     
154     /**
155      * Obtains a static snapshot of the InstrumentSample.
156      *
157      * @return A static snapshot of the InstrumentSample.
158      */
159     InstrumentSampleSnapshot getSnapshot();
160     
161     /**
162      * Returns the stateVersion of the sample. The state version will be
163      * incremented each time any of the configuration of the sample is
164      * modified.
165      * Clients can use this value to tell whether or not anything has
166      * changed without having to do an exhaustive comparison.
167      *
168      * @return The state version of the sample.
169      */
170     int getStateVersion();
171 }
172
173
Popular Tags