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.InstrumentManagerClient; 53 import org.apache.excalibur.instrument.manager.interfaces.NoSuchInstrumentException; 54 import org.apache.excalibur.instrument.manager.interfaces.NoSuchInstrumentSampleException; 55 import org.apache.excalibur.instrument.manager.interfaces.NoSuchInstrumentableException; 56 57 /** 58 * Methods defined by the Local interface should 59 * only be accessed from within the same JVM for performance reasons. 60 * 61 * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a> 62 * @version CVS $Revision: 1.4 $ $Date: 2003/02/25 16:28:16 $ 63 * @since 4.1 64 */ 65 public interface InstrumentManagerClientLocal 66 extends InstrumentManagerClient 67 { 68 /** 69 * Returns a InstrumentableDescriptorLocal based on its name or the name 70 * of any of its children. 71 * 72 * @param instrumentableName Name of the Instrumentable being requested. 73 * 74 * @return A Descriptor of the requested Instrumentable. 75 * 76 * @throws NoSuchInstrumentableException If the specified Instrumentable does 77 * not exist. 78 */ 79 InstrumentableDescriptorLocal getInstrumentableDescriptorLocal( String instrumentableName ) 80 throws NoSuchInstrumentableException; 81 82 /** 83 * Returns an array of Descriptors for the Instrumentables managed by this 84 * InstrumentManager. 85 * 86 * @return An array of Descriptors for the Instrumentables managed by this 87 * InstrumentManager. 88 */ 89 InstrumentableDescriptorLocal[] getInstrumentableDescriptorLocals(); 90 91 /** 92 * Searches the entire instrument tree an instrumentable with the given 93 * name. 94 * 95 * @param instrumentableName Name of the Instrumentable being requested. 96 * 97 * @return A Descriptor of the requested Instrumentable. 98 * 99 * @throws NoSuchInstrumentableException If the specified Instrumentable does 100 * not exist. 101 */ 102 InstrumentableDescriptorLocal locateInstrumentableDescriptorLocal( String instrumentableName ) 103 throws NoSuchInstrumentableException; 104 105 /** 106 * Searches the entire instrument tree an instrument with the given name. 107 * 108 * @param instrumentName Name of the Instrument being requested. 109 * 110 * @return A Descriptor of the requested Instrument. 111 * 112 * @throws NoSuchInstrumentException If the specified Instrument does 113 * not exist. 114 */ 115 InstrumentDescriptorLocal locateInstrumentDescriptorLocal( String instrumentName ) 116 throws NoSuchInstrumentException; 117 118 /** 119 * Searches the entire instrument tree an instrument sample with the given 120 * name. 121 * 122 * @param sampleName Name of the Instrument Sample being requested. 123 * 124 * @return A Descriptor of the requested Instrument Sample. 125 * 126 * @throws NoSuchInstrumentSampleException If the specified Instrument 127 * Sample does not exist. 128 */ 129 InstrumentSampleDescriptorLocal locateInstrumentSampleDescriptorLocal( String sampleName ) 130 throws NoSuchInstrumentSampleException; 131 } 132 133