KickJava   Java API By Example, From Geeks To Geeks.

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


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.InstrumentSampleDescriptor;
53 import org.apache.excalibur.instrument.manager.interfaces.NoSuchInstrumentSampleException;
54
55 /**
56  * Describes a Instrument and acts as a Proxy to protect the original
57  * Instrument.
58  *
59  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
60  * @version CVS $Revision: 1.3 $ $Date: 2003/02/20 17:08:18 $
61  * @since 4.1
62  */
63 public class InstrumentDescriptorLocalImpl
64     implements InstrumentDescriptorLocal
65 {
66     /** InstrumentProxy being described. */
67     private InstrumentProxy m_instrumentProxy;
68     
69     /*---------------------------------------------------------------
70      * Constructors
71      *-------------------------------------------------------------*/
72     /**
73      * Creates a new InstrumentDescriptor.
74      *
75      * @param instrumentProxy InstrumentProxy being described.
76      */
77     InstrumentDescriptorLocalImpl( InstrumentProxy instrumentProxy )
78     {
79         m_instrumentProxy = instrumentProxy;
80     }
81     
82     /*---------------------------------------------------------------
83      * InstrumentDescriptor Methods
84      *-------------------------------------------------------------*/
85     /**
86      * Returns true if the Instrument was configured in the instrumentables
87      * section of the configuration.
88      *
89      * @return True if configured.
90      */
91     public boolean isConfigured()
92     {
93         return m_instrumentProxy.isConfigured();
94     }
95
96     /**
97      * Returns true if the Instrument was registered with the Instrument
98      * Manager.
99      *
100      * @return True if registered.
101      */
102     public boolean isRegistered()
103     {
104         return m_instrumentProxy.isRegistered();
105     }
106     
107     /**
108      * Gets the name for the Instrument. The Instrument Name is used to
109      * uniquely identify the Instrument during the configuration of the
110      * Profiler. The value should be a string which does not contain spaces
111      * or periods.
112      *
113      * @return The name used to identify a Instrument.
114      */
115     public String JavaDoc getName()
116     {
117         return m_instrumentProxy.getName();
118     }
119     
120     /**
121      * Gets the description of the Instrument.
122      *
123      * @return The description of the Instrument.
124      */
125     public String JavaDoc getDescription()
126     {
127         return m_instrumentProxy.getDescription();
128     }
129     
130     /**
131      * Returns the type of the Instrument. Possible values include
132      * InstrumentManagerClient.INSTRUMENT_TYPE_COUNTER,
133      * InstrumentManagerClient.INSTRUMENT_TYPE_VALUE or
134      * InstrumentManagerClient.INSTRUMENT_TYPE_NONE, if the type was never set.
135      *
136      * @return The type of the Instrument.
137      */
138     public int getType()
139     {
140         return m_instrumentProxy.getType();
141     }
142     
143     /**
144      * Returns a InstrumentSampleDescriptor based on its name.
145      *
146      * @param instrumentSampleName Name of the InstrumentSample being requested.
147      *
148      * @return A Descriptor of the requested InstrumentSample.
149      *
150      * @throws NoSuchInstrumentSampleException If the specified InstrumentSample
151      * does not exist.
152      */
153     public InstrumentSampleDescriptor getInstrumentSampleDescriptor( String JavaDoc instrumentSampleName )
154         throws NoSuchInstrumentSampleException
155     {
156         return getInstrumentSampleDescriptorLocal( instrumentSampleName );
157     }
158     
159     /**
160      * Returns a InstrumentSampleDescriptor based on its name. If the requested
161      * sample is invalid in any way, then an expired Descriptor will be
162      * returned.
163      *
164      * @param sampleDescription Description to assign to the new Sample.
165      * @param sampleInterval Sample interval to use in the new Sample.
166      * @param sampleLease Requested lease time for the new Sample in
167      * milliseconds. The InstrumentManager may grant a
168      * lease which is shorter or longer than the requested
169      * period.
170      * @param sampleType Type of sample to request. Must be one of the
171      * following: InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER,
172      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MINIMUM,
173      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MAXIMUM,
174      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MEAN.
175      *
176      * @return A Descriptor of the requested InstrumentSample.
177      *
178      * @throws NoSuchInstrumentSampleException If the specified InstrumentSample
179      * does not exist.
180      */
181     public InstrumentSampleDescriptor createInstrumentSample( String JavaDoc sampleDescription,
182                                                               long sampleInterval,
183                                                               int sampleSize,
184                                                               long sampleLease,
185                                                               int sampleType )
186     {
187         return createInstrumentSampleLocal(
188             sampleDescription, sampleInterval, sampleSize, sampleLease, sampleType );
189     }
190     
191     /**
192      * Returns an array of Descriptors for the InstrumentSamples configured for this
193      * Instrument.
194      *
195      * @return An array of Descriptors for the InstrumentSamples configured for this
196      * Instrument.
197      */
198     public InstrumentSampleDescriptor[] getInstrumentSampleDescriptors()
199     {
200         return getInstrumentSampleDescriptorLocals();
201     }
202     
203     
204     /**
205      * Returns the stateVersion of the instrument. The state version will be
206      * incremented each time any of the configuration of the instrument or
207      * any of its children is modified.
208      * Clients can use this value to tell whether or not anything has
209      * changed without having to do an exhaustive comparison.
210      *
211      * @return The state version of the instrument.
212      */
213     public int getStateVersion()
214     {
215         return m_instrumentProxy.getStateVersion();
216     }
217     
218     /*---------------------------------------------------------------
219      * InstrumentDescriptorLocal Methods
220      *-------------------------------------------------------------*/
221     /**
222      * Adds a CounterInstrumentListener to the list of listeners which will
223      * receive updates of the value of the Instrument.
224      *
225      * @param listener CounterInstrumentListener which will start receiving
226      * profile updates.
227      *
228      * @throws IllegalStateException If the Instrument's type is not
229      * InstrumentManager.PROFILE_POINT_TYPE_COUNTER.
230      */
231     public void addCounterInstrumentListener( CounterInstrumentListener listener )
232     {
233         m_instrumentProxy.addCounterInstrumentListener( listener );
234     }
235     
236     /**
237      * Removes a InstrumentListener from the list of listeners which will
238      * receive profile events.
239      *
240      * @param listener InstrumentListener which will stop receiving profile
241      * events.
242      *
243      * @throws IllegalStateException If the Instrument's type is not
244      * InstrumentManager.PROFILE_POINT_TYPE_COUNTER.
245      */
246     public void removeCounterInstrumentListener( CounterInstrumentListener listener )
247     {
248         m_instrumentProxy.removeCounterInstrumentListener( listener );
249     }
250     
251     /**
252      * Adds a ValueInstrumentListener to the list of listeners which will
253      * receive updates of the value of the Instrument.
254      *
255      * @param listener ValueInstrumentListener which will start receiving
256      * profile updates.
257      *
258      * @throws IllegalStateException If the Instrument's type is not
259      * InstrumentManager.PROFILE_POINT_TYPE_VALUE.
260      */
261     public void addValueInstrumentListener( ValueInstrumentListener listener )
262     {
263         m_instrumentProxy.addValueInstrumentListener( listener );
264     }
265         
266     /**
267      * Removes a InstrumentListener from the list of listeners which will
268      * receive profile events.
269      *
270      * @param listener InstrumentListener which will stop receiving profile
271      * events.
272      *
273      * @throws IllegalStateException If the Instrument's type is not
274      * InstrumentManager.PROFILE_POINT_TYPE_VALUE.
275      */
276     public void removeValueInstrumentListener( ValueInstrumentListener listener )
277     {
278         m_instrumentProxy.removeValueInstrumentListener( listener );
279     }
280     
281     /**
282      * Returns a InstrumentSampleDescriptorLocal based on its name.
283      *
284      * @param instrumentSampleName Name of the InstrumentSample being requested.
285      *
286      * @return A Descriptor of the requested InstrumentSample.
287      *
288      * @throws NoSuchInstrumentSampleException If the specified InstrumentSample
289      * does not exist.
290      */
291     public InstrumentSampleDescriptorLocal getInstrumentSampleDescriptorLocal(
292                                                     String JavaDoc instrumentSampleName )
293         throws NoSuchInstrumentSampleException
294     {
295         InstrumentSample instrumentSample =
296             m_instrumentProxy.getInstrumentSample( instrumentSampleName );
297         if ( instrumentSample == null )
298         {
299             throw new NoSuchInstrumentSampleException(
300                 "No instrument sample can be found using name: " + instrumentSampleName );
301         }
302         
303         return instrumentSample.getDescriptor();
304     }
305     
306     /**
307      * Returns a InstrumentSampleDescriptorLocal based on its name. If the requested
308      * sample is invalid in any way, then an expired Descriptor will be
309      * returned.
310      *
311      * @param sampleDescription Description to assign to the new Sample.
312      * @param sampleInterval Sample interval to use in the new Sample.
313      * @param sampleLease Requested lease time for the new Sample in
314      * milliseconds. The InstrumentManager may grant a
315      * lease which is shorter or longer than the requested
316      * period.
317      * @param sampleType Type of sample to request. Must be one of the
318      * following: InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER,
319      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MINIMUM,
320      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MAXIMUM,
321      * InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MEAN.
322      *
323      * @return A Descriptor of the requested InstrumentSample.
324      *
325      * @throws NoSuchInstrumentSampleException If the specified InstrumentSample
326      * does not exist.
327      */
328     public InstrumentSampleDescriptorLocal createInstrumentSampleLocal( String JavaDoc sampleDescription,
329                                                                         long sampleInterval,
330                                                                         int sampleSize,
331                                                                         long sampleLease,
332                                                                         int sampleType )
333     {
334         InstrumentSample sample = m_instrumentProxy.createInstrumentSample(
335             sampleDescription, sampleInterval, sampleSize, sampleLease, sampleType );
336         return sample.getDescriptor();
337     }
338     
339     /**
340      * Returns an array of Descriptors for the InstrumentSamples configured for this
341      * Instrument.
342      *
343      * @return An array of Descriptors for the InstrumentSamples configured for this
344      * Instrument.
345      */
346     public InstrumentSampleDescriptorLocal[] getInstrumentSampleDescriptorLocals()
347     {
348         return m_instrumentProxy.getInstrumentSampleDescriptors();
349     }
350 }
351
Popular Tags