KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > instrument > manager > InstrumentSampleDescriptorLocalImpl


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;
51
52 import org.apache.excalibur.instrument.manager.interfaces.InstrumentSampleSnapshot;
53
54 /**
55  * Describes an InstrumentSample and acts as a Proxy to protect the original
56  * InstrumentSample object.
57  *
58  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
59  * @version CVS $Revision: 1.3 $ $Date: 2003/02/20 17:08:18 $
60  * @since 4.1
61  */
62 public class InstrumentSampleDescriptorLocalImpl
63     implements InstrumentSampleDescriptorLocal
64 {
65     /** The InstrumentSample. */
66     private InstrumentSample m_instrumentSample;
67     
68     /*---------------------------------------------------------------
69      * Constructors
70      *-------------------------------------------------------------*/
71     /**
72      * Creates a new InstrumentSampleDescriptor.
73      *
74      * @param InstrumentSample InstrumentSample being described.
75      */
76     InstrumentSampleDescriptorLocalImpl( InstrumentSample InstrumentSample )
77     {
78         m_instrumentSample = InstrumentSample;
79     }
80     
81     /*---------------------------------------------------------------
82      * Methods InstrumentSampleDescriptor
83      *-------------------------------------------------------------*/
84     /**
85      * Returns true if the InstrumentSample was configured in the instrumentables
86      * section of the configuration.
87      *
88      * @return True if configured.
89      */
90     public boolean isConfigured()
91     {
92         return m_instrumentSample.isConfigured();
93     }
94     
95     /**
96      * Returns the name of the sample.
97      *
98      * @return The name of the sample.
99      */
100     public String JavaDoc getName()
101     {
102         return m_instrumentSample.getName();
103     }
104     
105     /**
106      * Returns the sample interval. The period of each sample in millisends.
107      *
108      * @return The sample interval.
109      */
110     public long getInterval()
111     {
112         return m_instrumentSample.getInterval();
113     }
114     
115     /**
116      * Returns the number of samples in the sample history.
117      *
118      * @return The size of the sample history.
119      */
120     public int getSize()
121     {
122         return m_instrumentSample.getSize();
123     }
124     
125     /**
126      * Returns the description of the sample.
127      *
128      * @return The description of the sample.
129      */
130     public String JavaDoc getDescription()
131     {
132         return m_instrumentSample.getDescription();
133     }
134     
135     /**
136      * Returns the type of the Instrument Sample. Possible values include
137      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER,
138      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MAXIMUM,
139      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MEAN, or
140      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MINIMUM.
141      *
142      * @return The type of the Instrument Sample.
143      */
144     public int getType()
145     {
146         return m_instrumentSample.getType();
147     }
148     
149     /**
150      * Obtain the value of the sample. All samples are integers, so the profiled
151      * objects must measure quantity (numbers of items), rate (items/period), time in
152      * milliseconds, etc.
153      *
154      * @return The sample value.
155      */
156     public int getValue()
157     {
158         return m_instrumentSample.getValue();
159     }
160     
161     /**
162      * Obtain the UNIX time of the beginning of the sample.
163      *
164      * @return The UNIX time of the beginning of the sample.
165      */
166     public long getTime()
167     {
168         return m_instrumentSample.getTime();
169     }
170     
171     /**
172      * Returns the Type of the Instrument which can use the sample. This
173      * should be the same for all instances of a class.
174      * <p>
175      * Should be one of the following: InstrumentManager.PROFILE_POINT_TYPE_COUNTER
176      * or InstrumentManager.PROFILE_POINT_TYPE_VALUE
177      *
178      * @return The Type of the Instrument which can use the sample.
179      */
180     public int getInstrumentType()
181     {
182         return m_instrumentSample.getInstrumentType();
183     }
184     
185     /**
186      * Returns the time that the current lease expires. Permanent samples will
187      * return a value of 0.
188      *
189      * @return The time that the current lease expires.
190      */
191     public long getLeaseExpirationTime()
192     {
193         return m_instrumentSample.getLeaseExpirationTime();
194     }
195     
196     /**
197      * Extends the lease to be lease milliseconds from the current time.
198      *
199      * @param lease The length of the lease in milliseconds.
200      *
201      * @return The new lease expiration time. Returns 0 if the sample is
202      * permanent.
203      */
204     public long extendLease( long lease )
205     {
206         return m_instrumentSample.extendLease( lease );
207     }
208     
209     /**
210      * Obtains a static snapshot of the InstrumentSample.
211      *
212      * @return A static snapshot of the InstrumentSample.
213      */
214     public InstrumentSampleSnapshot getSnapshot()
215     {
216         return m_instrumentSample.getSnapshot();
217     }
218     
219     /**
220      * Returns the stateVersion of the sample. The state version will be
221      * incremented each time any of the configuration of the sample is
222      * modified.
223      * Clients can use this value to tell whether or not anything has
224      * changed without having to do an exhaustive comparison.
225      *
226      * @return The state version of the sample.
227      */
228     public int getStateVersion()
229     {
230         return m_instrumentSample.getStateVersion();
231     }
232     
233     /*---------------------------------------------------------------
234      * Methods InstrumentSampleDescriptorLocal
235      *-------------------------------------------------------------*/
236     /**
237      * Registers a InstrumentSampleListener with a InstrumentSample given a name.
238      *
239      * @param listener The listener which should start receiving updates from the
240      * InstrumentSample.
241      */
242     public void addInstrumentSampleListener( InstrumentSampleListener listener )
243     {
244         m_instrumentSample.addInstrumentSampleListener( listener );
245     }
246     
247     /**
248      * Unregisters a InstrumentSampleListener from a InstrumentSample given a name.
249      *
250      * @param listener The listener which should stop receiving updates from the
251      * InstrumentSample.
252      */
253     public void removeInstrumentSampleListener( InstrumentSampleListener listener )
254     {
255         m_instrumentSample.removeInstrumentSampleListener( listener );
256     }
257 }
258
259
Popular Tags