InstrumentDescriptor


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 a Instrument and acts as a Proxy to protect the original
54   *  Instrument.
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 InstrumentDescriptor
61  {
62      /**
63       * Returns true if the Instrument was configured in the instrumentables
64       *  section of the configuration.
65       *
66       * @return True if configured.
67       */
68      boolean isConfigured();
69  
70      /**
71       * Returns true if the Instrument was registered with the Instrument
72       *  Manager.
73       *
74       * @return True if registered.
75       */
76      boolean isRegistered();
77  
78      
79      /**
80       * Gets the name for the Instrument.  The Instrument Name is used to
81       *  uniquely identify the Instrument during the configuration of the
82       *  Profiler.  The value should be a string which does not contain spaces
83       *  or periods.
84       *
85       * @return The name used to identify a Instrument.
86       */
87      String   getName();
88      
89      /**
90       * Gets the description of the Instrument.
91       *
92       * @return The description of the Instrument.
93       */
94      String   getDescription();
95      
96      /**
97       * Returns the type of the Instrument.  Possible values include
98       *  InstrumentManagerClient.INSTRUMENT_TYPE_COUNTER,
99       *  InstrumentManagerClient.INSTRUMENT_TYPE_VALUE or
100      *  InstrumentManagerClient.INSTRUMENT_TYPE_NONE, if the type was never set.
101      *
102      * @return The type of the Instrument.
103      */
104     int getType();
105     
106     /**
107      * Returns a InstrumentSampleDescriptor based on its name.
108      *
109      * @param instrumentSampleName Name of the InstrumentSample being requested.
110      *
111      * @return A Descriptor of the requested InstrumentSample.
112      *
113      * @throws NoSuchInstrumentSampleException If the specified InstrumentSample
114      *                                      does not exist.
115      */
116     InstrumentSampleDescriptor getInstrumentSampleDescriptor( String   instrumentSampleName )
117         throws NoSuchInstrumentSampleException;
118     
119     /**
120      * Returns a InstrumentSampleDescriptor based on its name.  If the requested
121      *  sample is invalid in any way, then an expired Descriptor will be
122      *  returned.
123      *
124      * @param sampleDescription Description to assign to the new Sample.
125      * @param sampleInterval Sample interval to use in the new Sample.
126      * @param sampleLease Requested lease time for the new Sample in
127      *                    milliseconds.  The InstrumentManager may grant a
128      *                    lease which is shorter or longer than the requested
129      *                    period.
130      * @param sampleType Type of sample to request.  Must be one of the
131      *                   following:  InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER,
132      *                   InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MINIMUM,
133      *                   InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MAXIMUM,
134      *                   InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MEAN.
135      *
136      * @return A Descriptor of the requested InstrumentSample.
137      *
138      * @throws NoSuchInstrumentSampleException If the specified InstrumentSample
139      *                                      does not exist.
140      */
141     InstrumentSampleDescriptor createInstrumentSample( String   sampleDescription,
142                                                        long sampleInterval,
143                                                        int sampleSize,
144                                                        long sampleLease,
145                                                        int sampleType );
146     
147     /**
148      * Returns an array of Descriptors for the InstrumentSamples configured for this
149      *  Instrument.
150      *
151      * @return An array of Descriptors for the InstrumentSamples configured for this
152      *  Instrument.
153      */
154     InstrumentSampleDescriptor[] getInstrumentSampleDescriptors();
155     
156     /**
157      * Returns the stateVersion of the instrument.  The state version will be
158      *  incremented each time any of the configuration of the instrument or
159      *  any of its children is modified.
160      * Clients can use this value to tell whether or not anything has
161      *  changed without having to do an exhaustive comparison.
162      *
163      * @return The state version of the instrument.
164      */
165     int getStateVersion();
166 }
167
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags