KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > servicemix > common > packaging > ServiceUnitAnalyzer


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */

17 package org.apache.servicemix.common.packaging;
18
19 import java.io.File JavaDoc;
20 import java.util.List JavaDoc;
21
22 /**
23  * Provides a interface that components can implement, if they implement this
24  * interface and expose the name of the analyzer in their Maven Project Object
25  * Model then the tooling can use this to analyze a Service Unit for the
26  * component during packaging to generate the consumes and provides elements for
27  * the service unit's jbi.xml
28  *
29  * @author Philip Dodds
30  * @version $Revision: 426415 $
31  * @since 3.0
32  *
33  * @see Consumes, {@link Consumes}
34  * @see Provides, {@link Provides}
35  */

36 public interface ServiceUnitAnalyzer {
37
38     /**
39      * Initializes the analyzer based on the root directory of an exploded
40      * service unit
41      *
42      * @param explodedServiceUnitRoot
43      */

44     public void init(File JavaDoc explodedServiceUnitRoot);
45
46     /**
47      * Returns a list of Consumes representing the service unit being analyzed
48      *
49      * @return A list of Consumes
50      */

51     public List JavaDoc getConsumes();
52
53     /**
54      * Returns a list of Provides representing the service unit being analyzed
55      *
56      * @return A list of provides
57      */

58     public List JavaDoc getProvides();
59
60 }
61
Popular Tags