File: StandardPluginLifecycleHandler.java

package info (click to toggle)
libjpf-java 1.5.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,280 kB
  • ctags: 2,079
  • sloc: java: 13,449; xml: 337; sh: 48; makefile: 10
file content (188 lines) | stat: -rw-r--r-- 8,734 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*****************************************************************************
 * Java Plug-in Framework (JPF)
 * Copyright (C) 2004-2007 Dmitry Olshansky
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *****************************************************************************/
package org.java.plugin.standard;

import java.security.AccessController;
import java.security.PrivilegedAction;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.java.plugin.Plugin;
import org.java.plugin.PluginLifecycleException;
import org.java.plugin.PluginManager;
import org.java.plugin.registry.PluginDescriptor;
import org.java.plugin.util.ExtendedProperties;

/**
 * Standard implementation of plug-in life cycle handler.
 * <p>
 * <b>Configuration parameters</b>
 * </p>
 * <p>
 * This life cycle handler implementation supports following configuration
 * parameters:
 * <dl>
 *   <dt>probeParentLoaderLast</dt>
 *   <dd>If <code>true</code>, plug-in classloader will try loading classes from
 *     system (boot) classpath <b>after</b> trying to load them from plug-in
 *     classpath. Otherwise system classpath will be used <b>first</b>. Default
 *     value is <code>false</code> that corresponds to standard delegation model
 *     for classloaders hierarchy that corresponds to JLS.</dd>
 *   <dt>stickySynchronizing</dt>
 *   <dd>Allows advanced configuring of classloaders synchronization in
 *     multy-threaded environment. If <code>true</code> then class loading will
 *     be synchronized with initial plug-in classloader instance. Otherwise
 *     <code>this</code> instance will be used as synchronizing monitor. Default
 *     value is <code>false</code>.</dd>
 *   <dt>localClassLoadingOptimization</dt>
 *   <dd>If <code>true</code> then plug-in classloader will collect local
 *     packages statistics to predict class location. This allow to optimize
 *     class look-up procedure for classes that belong to the requested plug-in.
 *     Default value is <code>true</code>.</dd>
 *   <dt>foreignClassLoadingOptimization</dt>
 *   <dd>If <code>true</code> then plug-in classloader will collect statistics
 *     for "foreign" classes - those which belong to depending plug-ins. This
 *     allow to optimize class look-up procedure when enumerating depending
 *     plug-ins. Default value is <code>true</code>.</dd>
 * </dl>
 * </p>
 * @version $Id: StandardPluginLifecycleHandler.java,v 1.5 2007/04/07 12:39:50 ddimon Exp $
 */
public class StandardPluginLifecycleHandler extends PluginLifecycleHandler {
    private final Log log = LogFactory.getLog(getClass());
    private boolean probeParentLoaderLast;
    private boolean stickySynchronizing;
    private boolean localClassLoadingOptimization;
    private boolean foreignClassLoadingOptimization;

    /**
     * Creates standard implementation of plug-in class loader.
     * @see org.java.plugin.standard.PluginLifecycleHandler#createPluginClassLoader(
     *      org.java.plugin.registry.PluginDescriptor)
     */
    @Override
    protected org.java.plugin.PluginClassLoader createPluginClassLoader(
            final PluginDescriptor descr) {
        /*StandardPluginClassLoader result = new StandardPluginClassLoader(
                getPluginManager(), descr, getClass().getClassLoader());*/
        StandardPluginClassLoader result = AccessController.doPrivileged(
                    new PrivilegedAction<StandardPluginClassLoader>() {
            public StandardPluginClassLoader run() {
                return new StandardPluginClassLoader(getPluginManager(), descr,
                        StandardPluginLifecycleHandler.this.getClass()
                        .getClassLoader());
            }
        });
        result.setProbeParentLoaderLast(probeParentLoaderLast);
        result.setStickySynchronizing(stickySynchronizing);
        result.setLocalClassLoadingOptimization(localClassLoadingOptimization);
        result.setForeignClassLoadingOptimization(
                foreignClassLoadingOptimization);
        return result;
    }

    /**
     * Creates instance of plug-in class calling it's default (no-arguments)
     * constructor. Class look-up is done with
     * {@link PluginManager#getPluginClassLoader(PluginDescriptor) plug-in's class loader}.
     * @see org.java.plugin.standard.PluginLifecycleHandler#createPluginInstance(
     *      org.java.plugin.registry.PluginDescriptor)
     */
    @Override
    protected Plugin createPluginInstance(final PluginDescriptor descr)
            throws PluginLifecycleException {
        String className = descr.getPluginClassName();
        Class<?> pluginClass;
        try {
            pluginClass =
                getPluginManager().getPluginClassLoader(descr).loadClass(
                        className);
        } catch (ClassNotFoundException cnfe) {
            throw new PluginLifecycleException(
                    StandardObjectFactory.PACKAGE_NAME,
                    "pluginClassNotFound", className, cnfe); //$NON-NLS-1$
        }
        try {
            return (Plugin) pluginClass.newInstance();
        } catch (InstantiationException ie) {
            throw new PluginLifecycleException(
                    StandardObjectFactory.PACKAGE_NAME,
                    "pluginClassInstantiationFailed", descr.getId(), ie); //$NON-NLS-1$
        } catch (IllegalAccessException iae) {
            throw new PluginLifecycleException(
                    StandardObjectFactory.PACKAGE_NAME,
                    "pluginClassInstantiationFailed", descr.getId(), iae); //$NON-NLS-1$
        }
    }
    
    /**
     * This method does nothing in this implementation.
     * @see org.java.plugin.standard.PluginLifecycleHandler#beforePluginStart(
     *      org.java.plugin.Plugin)
     */
    @Override
    protected void beforePluginStart(final Plugin plugin) {
        // no-op
    }

    /**
     * This method does nothing in this implementation.
     * @see org.java.plugin.standard.PluginLifecycleHandler#afterPluginStop(
     *      org.java.plugin.Plugin)
     */
    @Override
    protected void afterPluginStop(final Plugin plugin) {
        // no-op
    }

    /**
     * This method does nothing in this implementation.
     * @see org.java.plugin.standard.PluginLifecycleHandler#dispose()
     */
    @Override
    protected void dispose() {
        // no-op
    }

    /**
     * @see org.java.plugin.standard.PluginLifecycleHandler#configure(
     *      ExtendedProperties)
     */
    @Override
    public void configure(ExtendedProperties config) {
        probeParentLoaderLast = "true".equalsIgnoreCase( //$NON-NLS-1$
                config.getProperty("probeParentLoaderLast", "false")); //$NON-NLS-1$ //$NON-NLS-2$
        log.debug("probeParentLoaderLast parameter value is " //$NON-NLS-1$
                + probeParentLoaderLast);
        stickySynchronizing = "true".equalsIgnoreCase( //$NON-NLS-1$
                config.getProperty("stickySynchronizing", "false")); //$NON-NLS-1$ //$NON-NLS-2$
        log.debug("stickySynchronizing parameter value is " //$NON-NLS-1$
                + stickySynchronizing);
        localClassLoadingOptimization = !"false".equalsIgnoreCase( //$NON-NLS-1$
                config.getProperty("localClassLoadingOptimization", //$NON-NLS-1$
                        "true")); //$NON-NLS-1$
        log.debug("localLoadingClassOptimization parameter value is " //$NON-NLS-1$
                + localClassLoadingOptimization);
        foreignClassLoadingOptimization = !"false".equalsIgnoreCase( //$NON-NLS-1$
                config.getProperty("foreignClassLoadingOptimization", //$NON-NLS-1$
                        "true")); //$NON-NLS-1$
        log.debug("foreignClassLoadingOptimization parameter value is " //$NON-NLS-1$
                + foreignClassLoadingOptimization);
    }
}