KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > codehaus > loom > components > extensions > DefaultExtensionManager


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.extensions;
88
89 import java.io.File JavaDoc;
90 import java.util.ArrayList JavaDoc;
91
92 import org.codehaus.loom.components.extensions.pkgmgr.ExtensionManager;
93 import org.codehaus.loom.components.extensions.pkgmgr.OptionalPackage;
94 import org.codehaus.spice.salt.i18n.ResourceManager;
95 import org.codehaus.spice.salt.i18n.Resources;
96 import org.codehaus.dna.Active;
97 import org.codehaus.dna.Configurable;
98 import org.codehaus.dna.Configuration;
99 import org.codehaus.dna.ConfigurationException;
100 import org.codehaus.dna.LogEnabled;
101 import org.codehaus.dna.Logger;
102
103 /**
104  * @author Peter Donald
105  * @version $Revision: 1.3 $ $Date: 2004/08/17 23:14:32 $
106  * @dna.component
107  * @mx.component
108  */
109 public class DefaultExtensionManager
110     extends org.codehaus.loom.components.extensions.pkgmgr.impl.DefaultExtensionManager
111     implements LogEnabled, Configurable, Active, ExtensionManager
112 {
113     private final static Resources REZ =
114         ResourceManager.getPackageResources( DefaultExtensionManager.class );
115
116     private Logger m_logger;
117     private File JavaDoc m_extDir;
118
119     public void enableLogging( final Logger logger )
120     {
121         m_logger = logger;
122     }
123
124     public void configure( Configuration configuration )
125         throws ConfigurationException
126     {
127         final String JavaDoc extDir =
128             configuration.getChild( "extensions-dir" ).getValue();
129         m_extDir = new File JavaDoc( extDir );
130     }
131
132     public void initialize()
133         throws Exception JavaDoc
134     {
135         setPath( new File JavaDoc[]{m_extDir} );
136         rescanPath();
137     }
138
139     public void dispose()
140     {
141         clearCache();
142     }
143
144     /**
145      * Retrieve an array of paths where each element in array represents a
146      * directory in which the ExtensionManager will look for Extensions.
147      *
148      * @return the list of paths to search in
149      * @mx.attribute description="The list of paths to search in"
150      */
151     public File JavaDoc[] getPaths()
152     {
153         return super.getPaths();
154     }
155
156     /**
157      * Force the ExtensionManager to rescan the paths to discover new Extensions
158      * that have been added or remove old Extensions that have been removed.
159      *
160      * @mx.operation description="Force the ExtensionManager to rescan the paths
161      * to discover new Extensions that have been added or remove old Extensions
162      * that have been removed."
163      */
164     public void rescanPath()
165     {
166         super.scanPath();
167
168         //Display a list of packages once they have been added.
169 if( m_logger.isDebugEnabled() )
170         {
171             final ArrayList JavaDoc list = new ArrayList JavaDoc();
172             final OptionalPackage[] optionalPackages = getAllOptionalPackages();
173             for( int i = 0; i < optionalPackages.length; i++ )
174             {
175                 list.add( optionalPackages[ i ].getFile() );
176             }
177
178             final String JavaDoc message =
179                 REZ.format( "extension.packages.notice", list );
180             m_logger.debug( message );
181         }
182     }
183
184     protected void debug( final String JavaDoc message )
185     {
186         m_logger.debug( message );
187     }
188 }
189
Popular Tags