ResourceProvider


1   /* ====================================================================
2    * Loom Software License, version 1.1
3    *
4    * Copyright (c) 2003, Loom Group. All rights reserved.
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    * 1. Redistributions of source code must retain the above copyright
10   *    notice, this list of conditions and the following disclaimer.
11   *
12   * 2. Redistributions in binary form must reproduce the above copyright
13   *    notice, this list of conditions and the following disclaimer in
14   *    the documentation and/or other materials provided with the
15   *    distribution.
16   *
17   * 3. Neither the name of the Loom Group nor the name "Loom" nor
18   *    the names of its contributors may be used to endorse or promote
19   *    products derived from this software without specific prior
20   *    written permission.
21   *
22   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25   * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26   * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27   * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28   * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32   * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33   * POSSIBILITY OF SUCH DAMAGE.
34   *
35   * ====================================================================
36   *
37   * Loom includes code from the Apache Software Foundation
38   *
39   * ====================================================================
40   * The Apache Software License, Version 1.1
41   *
42   * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
43   * reserved.
44   *
45   * Redistribution and use in source and binary forms, with or without
46   * modification, are permitted provided that the following conditions
47   * are met:
48   *
49   * 1. Redistributions of source code must retain the above copyright
50   *    notice, this list of conditions and the following disclaimer.
51   *
52   * 2. Redistributions in binary form must reproduce the above copyright
53   *    notice, this list of conditions and the following disclaimer in
54   *    the documentation and/or other materials provided with the
55   *    distribution.
56   *
57   * 3. The end-user documentation included with the redistribution,
58   *    if any, must include the following acknowledgment:
59   *    "This product includes software developed by the
60   *    Apache Software Foundation (http://www.apache.org/)."
61   *    Alternately, this acknowledgment may appear in the software
62   *    itself, if and wherever such third-party acknowledgments
63   *    normally appear.
64   *
65   * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
66   *    must not be used to endorse or promote products derived from this
67   *    software without prior written permission. For written
68   *    permission, please contact apache@apache.org.
69   *
70   * 5. Products derived from this software may not be called "Apache",
71   *    nor may "Apache" appear in their name, without prior written
72   *    permission of the Apache Software Foundation.
73   *
74   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
75   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
76   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
77   * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
78   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
79   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
80   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
81   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
82   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
83   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
84   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
85   * SUCH DAMAGE.
86   */
87  package org.codehaus.loom.components.util.lifecycle;
88  
89  import org.apache.avalon.framework.component.ComponentManager;
90  import org.apache.avalon.framework.configuration.Configuration;
91  import org.apache.avalon.framework.context.Context;
92  import org.apache.avalon.framework.logger.Logger;
93  import org.apache.avalon.framework.parameters.Parameters;
94  import org.apache.avalon.framework.service.ServiceManager;
95  import org.apache.excalibur.instrument.InstrumentManager;
96  
97  /**
98   * The interface via which resources required for a component are aquired.
99   *
100  * @author Peter Donald
101  * @version $Revision: 1.3 $ $Date: 2004/08/17 23:14:32 $
102  */
103 public interface ResourceProvider
104 {
105     /**
106      * Create the object specified by entry.
107      *
108      * @param entry the entry
109      * @return the new object
110      * @throws java.lang.Exception if unable to create resource
111      */
112     Object   createObject( Object   entry )
113         throws Exception  ;
114 
115     /**
116      * Create a new Logger for component.
117      *
118      * @param entry the entry
119      * @return a new Logger for component
120      * @throws java.lang.Exception if unable to create resource
121      */
122     Logger createLogger( Object   entry )
123         throws Exception  ;
124 
125     /**
126      * Create a new Context for component.
127      *
128      * @param entry the entry
129      * @return a new Context for component
130      * @throws java.lang.Exception if unable to create resource
131      */
132     Context createContext( Object   entry )
133         throws Exception  ;
134 
135     /**
136      * Create a new ComponentManager for component.
137      *
138      * @param entry the entry
139      * @return a new ComponentManager for component
140      * @throws java.lang.Exception if unable to create resource
141      */
142     ComponentManager createComponentManager( Object   entry )
143         throws Exception  ;
144 
145     /**
146      * Create a new ServiceManager for component.
147      *
148      * @param entry the entry
149      * @return a new ServiceManager for component
150      * @throws java.lang.Exception if unable to create resource
151      */
152     ServiceManager createServiceManager( Object   entry )
153         throws Exception  ;
154 
155     /**
156      * Create a new Configuration object for component.
157      *
158      * @param entry the entry
159      * @return a new Configuration object for component
160      * @throws java.lang.Exception if unable to create resource
161      */
162     Configuration createConfiguration( Object   entry )
163         throws Exception  ;
164 
165     /**
166      * Create a new Parameters object for component.
167      *
168      * @param entry the entry
169      * @return a new Parameters object for component
170      * @throws java.lang.Exception if unable to create resource
171      */
172     Parameters createParameters( Object   entry )
173         throws Exception  ;
174 
175     /**
176      * Create a new InstrumentMaanger object for component.
177      *
178      * @param entry the entry
179      * @return a new InstrumentManager object for component
180      * @throws java.lang.Exception if unable to create resource
181      */
182     InstrumentManager createInstrumentManager( Object   entry )
183         throws Exception  ;
184 
185     /**
186      * Create a name for this components instrumentables.
187      *
188      * @param entry the entry
189      * @return the String to use as the instrumentable name
190      * @throws java.lang.Exception if unable to create resource
191      */
192     String   createInstrumentableName( Object   entry )
193         throws Exception  ;
194 }
195
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags