org.grails.plugins.DefaultGrailsPlugin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of grails-core Show documentation
Show all versions of grails-core Show documentation
Grails Web Application Framework
/*
* Copyright 2004-2005 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.grails.plugins;
import grails.plugins.GrailsPlugin;
import grails.plugins.GrailsPluginManager;
import grails.plugins.Plugin;
import grails.spring.BeanBuilder;
import grails.util.BuildScope;
import grails.util.CollectionUtils;
import grails.util.Environment;
import grails.util.GrailsUtil;
import grails.util.Metadata;
import groovy.lang.*;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import grails.core.ArtefactHandler;
import grails.core.GrailsApplication;
import grails.util.GrailsArrayUtils;
import grails.util.GrailsClassUtils;
import org.grails.core.io.CachingPathMatchingResourcePatternResolver;
import org.grails.core.legacy.LegacyGrailsApplication;
import org.grails.core.io.SpringResource;
import org.grails.core.exceptions.GrailsConfigurationException;
import org.grails.spring.RuntimeSpringConfiguration;
import grails.plugins.exceptions.PluginException;
import org.grails.plugins.support.WatchPattern;
import org.grails.plugins.support.WatchPatternParser;
import grails.core.support.GrailsApplicationAware;
import grails.core.support.ParentApplicationContextAware;
import org.codehaus.groovy.runtime.DefaultGroovyMethods;
import org.springframework.beans.BeanWrapper;
import org.springframework.beans.BeanWrapperImpl;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ApplicationListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.type.filter.TypeFilter;
/**
* Implementation of the GrailsPlugin interface that wraps a Groovy plugin class
* and provides the magic to invoke its various methods from Java.
*
* @author Graeme Rocher
* @since 0.4
*/
@SuppressWarnings("rawtypes")
public class DefaultGrailsPlugin extends AbstractGrailsPlugin implements ParentApplicationContextAware {
private static final String PLUGIN_CHANGE_EVENT_CTX = "ctx";
private static final String PLUGIN_CHANGE_EVENT_APPLICATION = "application";
private static final String PLUGIN_CHANGE_EVENT_PLUGIN = "plugin";
private static final String PLUGIN_CHANGE_EVENT_SOURCE = "source";
private static final String PLUGIN_CHANGE_EVENT_MANAGER = "manager";
protected static final Log LOG = LogFactory.getLog(DefaultGrailsPlugin.class);
private static final String INCLUDES = "includes";
private static final String EXCLUDES = "excludes";
private GrailsPluginClass pluginGrailsClass;
private GroovyObject plugin;
protected BeanWrapper pluginBean;
private Closure onChangeListener;
private Resource[] watchedResources = {};
private PathMatchingResourcePatternResolver resolver;
private String[] watchedResourcePatternReferences;
private String[] loadAfterNames = {};
private String[] loadBeforeNames = {};
private String status = STATUS_ENABLED;
private String[] observedPlugins;
private Closure onConfigChangeListener;
private Closure onShutdownListener;
private Class[] providedArtefacts = {};
private Collection profiles = null;
private Map pluginScopes;
private Map pluginEnvs;
private List pluginExcludes = new ArrayList();
private Collection typeFilters = new ArrayList();
private Resource pluginDescriptor;
private List watchedResourcePatterns;
public DefaultGrailsPlugin(Class pluginClass, Resource resource, GrailsApplication application) {
super(pluginClass, application);
// create properties
dependencies = Collections.emptyMap();
pluginDescriptor = resource;
resolver = CachingPathMatchingResourcePatternResolver.INSTANCE;
try {
initialisePlugin(pluginClass);
} catch (Throwable e) {
throw new PluginException("Error initialising plugin for class ["+pluginClass.getName()+"]:" + e.getMessage(), e);
}
}
@Override
public boolean isEnabled(String[] activeProfiles) {
if(profiles == null) return true;
else {
for (String activeProfile : activeProfiles) {
if(profiles.contains(activeProfile)) return true;
}
}
return false;
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
super.setApplicationContext(applicationContext);
if(this.plugin instanceof ApplicationContextAware) {
((ApplicationContextAware)plugin).setApplicationContext(applicationContext);
}
if(this.plugin instanceof ApplicationListener) {
((ConfigurableApplicationContext)applicationContext).addApplicationListener((ApplicationListener)plugin);
}
}
@Override
public List getWatchedResourcePatterns() {
return watchedResourcePatterns;
}
@Override
public boolean hasInterestInChange(String path) {
if (watchedResourcePatterns != null) {
for (WatchPattern watchedResourcePattern : watchedResourcePatterns) {
if (watchedResourcePattern.matchesPath(path)) {
return true;
}
}
}
return false;
}
@Override
public void setManager(GrailsPluginManager manager) {
super.setManager(manager);
if(plugin instanceof Plugin) {
((Plugin)plugin).setPluginManager(manager);
}
}
private void initialisePlugin(Class clazz) {
pluginGrailsClass = new GrailsPluginClass(clazz);
plugin = (GroovyObject)pluginGrailsClass.newInstance();
if(plugin instanceof Plugin) {
Plugin p = (Plugin)plugin;
p.setApplicationContext(applicationContext);
p.setPlugin(this);
p.setGrailsApplication(((LegacyGrailsApplication)application).getGrailsApplication());
p.setPluginManager(manager);
}
else if(plugin instanceof GrailsApplicationAware) {
((GrailsApplicationAware)plugin).setGrailsApplication(((LegacyGrailsApplication)this.application).getGrailsApplication());
}
pluginBean = new BeanWrapperImpl(plugin);
// configure plugin
evaluatePluginVersion();
evaluatePluginDependencies();
evaluatePluginLoadAfters();
evaluateProvidedArtefacts();
evaluatePluginEvictionPolicy();
evaluateOnChangeListener();
evaluateObservedPlugins();
evaluatePluginStatus();
evaluatePluginScopes();
evaluatePluginExcludes();
evaluateTypeFilters();
}
@SuppressWarnings("unchecked")
private void evaluateTypeFilters() {
Object result = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(plugin, TYPE_FILTERS);
if (result instanceof List) {
typeFilters = (List) result;
}
}
@SuppressWarnings("unchecked")
private void evaluatePluginExcludes() {
Object result = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(plugin, PLUGIN_EXCLUDES);
if (result instanceof List) {
pluginExcludes = (List) result;
}
}
private void evaluatePluginScopes() {
// Damn I wish Java had closures
pluginScopes = evaluateIncludeExcludeProperty(SCOPES, new Closure(this) {
private static final long serialVersionUID = 1;
@Override
public Object call(Object arguments) {
final String scopeName = ((String) arguments).toUpperCase();
try {
return BuildScope.valueOf(scopeName);
}
catch (IllegalArgumentException e) {
throw new GrailsConfigurationException("Plugin " + this + " specifies invalid scope [" + scopeName + "]");
}
}
});
pluginEnvs = evaluateIncludeExcludeProperty(ENVIRONMENTS, new Closure(this) {
private static final long serialVersionUID = 1;
@Override
public Object call(Object arguments) {
String envName = (String)arguments;
Environment env = Environment.getEnvironment(envName);
if (env != null) return env.getName();
return arguments;
}
});
}
private Map evaluateIncludeExcludeProperty(String name, Closure converter) {
Map resultMap = new HashMap();
Object propertyValue = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(plugin, name);
if (propertyValue instanceof Map) {
Map containedMap = (Map)propertyValue;
Object includes = containedMap.get(INCLUDES);
evaluateAndAddIncludeExcludeObject(resultMap, includes, true, converter);
Object excludes = containedMap.get(EXCLUDES);
evaluateAndAddIncludeExcludeObject(resultMap, excludes, false, converter);
}
else {
evaluateAndAddIncludeExcludeObject(resultMap, propertyValue, true, converter);
}
return resultMap;
}
private void evaluateAndAddIncludeExcludeObject(Map targetMap, Object includeExcludeObject, boolean include, Closure converter) {
if (includeExcludeObject instanceof String) {
final String includeExcludeString = (String) includeExcludeObject;
evaluateAndAddToIncludeExcludeSet(targetMap,includeExcludeString, include, converter);
}
else if (includeExcludeObject instanceof List) {
List includeExcludeList = (List) includeExcludeObject;
evaluateAndAddListOfValues(targetMap,includeExcludeList, include, converter);
}
}
private void evaluateAndAddListOfValues(Map targetMap, List includeExcludeList, boolean include, Closure converter) {
for (Object value : includeExcludeList) {
if (value instanceof String) {
final String scopeName = (String) value;
evaluateAndAddToIncludeExcludeSet(targetMap, scopeName, include, converter);
}
}
}
@SuppressWarnings("unchecked")
private void evaluateAndAddToIncludeExcludeSet(Map targetMap, String includeExcludeString, boolean include, Closure converter) {
Set set = lazilyCreateIncludeOrExcludeSet(targetMap,include);
set.add(converter.call(includeExcludeString));
}
@SuppressWarnings("unchecked")
private Set lazilyCreateIncludeOrExcludeSet(Map targetMap, boolean include) {
String key = include ? INCLUDES : EXCLUDES;
Set set = (Set) targetMap.get(key);
if (set == null) {
set = new HashSet();
targetMap.put(key, set);
}
return set;
}
@SuppressWarnings("unchecked")
private void evaluateProvidedArtefacts() {
Object result = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(pluginBean, plugin, PROVIDED_ARTEFACTS);
if (result instanceof Collection) {
final Collection artefactList = (Collection) result;
providedArtefacts = (Class[])artefactList.toArray(new Class[artefactList.size()]);
}
}
private void evaluateProfiles() {
Object result = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(pluginBean, plugin, PROFILES);
if (result instanceof Collection) {
profiles = (Collection) result;
}
}
public DefaultGrailsPlugin(Class pluginClass, GrailsApplication application) {
this(pluginClass, null, application);
}
private void evaluateObservedPlugins() {
if (pluginBean.isReadableProperty(OBSERVE)) {
Object observeProperty = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(pluginBean, plugin, OBSERVE);
if (observeProperty instanceof Collection) {
Collection observeList = (Collection)observeProperty;
observedPlugins = new String[observeList.size()];
int j = 0;
for (Object anObserveList : observeList) {
String pluginName = anObserveList.toString();
observedPlugins[j++] = pluginName;
}
}
}
if (observedPlugins == null) {
observedPlugins = new String[0];
}
}
private void evaluatePluginStatus() {
if (!pluginBean.isReadableProperty(STATUS)) {
return;
}
Object statusObj = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(plugin, STATUS);
if (statusObj != null) {
status = statusObj.toString().toLowerCase();
}
}
private void evaluateOnChangeListener() {
if (pluginBean.isReadableProperty(ON_SHUTDOWN)) {
onShutdownListener = (Closure)GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(plugin, ON_SHUTDOWN);
}
if (pluginBean.isReadableProperty(ON_CONFIG_CHANGE)) {
onConfigChangeListener = (Closure)GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(plugin, ON_CONFIG_CHANGE);
}
if (pluginBean.isReadableProperty(ON_CHANGE)) {
onChangeListener = (Closure) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(plugin, ON_CHANGE);
}
Environment env = Environment.getCurrent();
final boolean warDeployed = env.isWarDeployed();
final boolean reloadEnabled = env.isReloadEnabled();
if (!((reloadEnabled || !warDeployed))) {
return;
}
Object referencedResources = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(plugin, WATCHED_RESOURCES);
try {
List resourceList = null;
if (referencedResources instanceof String) {
if (LOG.isDebugEnabled()) {
LOG.debug("Configuring plugin "+this+" to watch resources with pattern: " + referencedResources);
}
resourceList = Collections.singletonList(referencedResources.toString());
}
else if (referencedResources instanceof List) {
resourceList = (List)referencedResources;
}
if (resourceList == null) {
return;
}
List resourceListTmp = new ArrayList();
final String baseLocation = env.getReloadLocation();
for (Object ref : resourceList) {
String stringRef = ref.toString();
if (warDeployed) {
addBaseLocationPattern(resourceListTmp, baseLocation, stringRef);
}
else {
addBaseLocationPattern(resourceListTmp, baseLocation, stringRef);
}
}
watchedResourcePatternReferences = new String[resourceListTmp.size()];
for (int i = 0; i < watchedResourcePatternReferences.length; i++) {
String resRef = resourceListTmp.get(i);
watchedResourcePatternReferences[i] = resRef;
}
watchedResourcePatterns = new WatchPatternParser().getWatchPatterns(Arrays.asList(watchedResourcePatternReferences));
}
catch (IllegalArgumentException e) {
if (GrailsUtil.isDevelopmentEnv()) {
LOG.debug("Cannot load plug-in resource watch list from [" + GrailsArrayUtils.toString(watchedResourcePatternReferences) +
"]. This means that the plugin " + this +
", will not be able to auto-reload changes effectively. Try running grails upgrade.: " + e.getMessage());
}
}
}
private void addBaseLocationPattern(List resourceList, final String baseLocation, String pattern) {
resourceList.add(baseLocation == null ? pattern : getResourcePatternForBaseLocation(baseLocation, pattern));
}
private String getResourcePatternForBaseLocation(String baseLocation, String resourcePath) {
String location = baseLocation;
if (!location.endsWith(File.separator)) location = location + File.separator;
if (resourcePath.startsWith("./")) {
return "file:" + location + resourcePath.substring(2); }
else if (resourcePath.startsWith("file:./")) {
return "file:" + location + resourcePath.substring(7);
}
return resourcePath;
}
private void evaluatePluginVersion() {
if (!pluginBean.isReadableProperty(VERSION)) {
throw new PluginException("Plugin [" + getName() + "] must specify a version!");
}
Object vobj = plugin.getProperty(VERSION);
if (vobj == null) {
throw new PluginException("Plugin " + this + " must specify a version. eg: def version = 0.1");
}
version = vobj.toString();
}
private void evaluatePluginEvictionPolicy() {
if (!pluginBean.isReadableProperty(EVICT)) {
return;
}
List pluginsToEvict = (List) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(pluginBean, plugin, EVICT);
if (pluginsToEvict == null) {
return;
}
evictionList = new String[pluginsToEvict.size()];
int index = 0;
for (Object o : pluginsToEvict) {
evictionList[index++] = o == null ? "" : o.toString();
}
}
@SuppressWarnings("unchecked")
private void evaluatePluginLoadAfters() {
if (pluginBean.isReadableProperty(PLUGIN_LOAD_AFTER_NAMES)) {
List loadAfterNamesList = (List) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(pluginBean, plugin, PLUGIN_LOAD_AFTER_NAMES);
if (loadAfterNamesList != null) {
loadAfterNames = (String[])loadAfterNamesList.toArray(new String[loadAfterNamesList.size()]);
}
}
if (pluginBean.isReadableProperty(PLUGIN_LOAD_BEFORE_NAMES)) {
List loadBeforeNamesList = (List) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(pluginBean, plugin, PLUGIN_LOAD_BEFORE_NAMES);
if (loadBeforeNamesList != null) {
loadBeforeNames = (String[])loadBeforeNamesList.toArray(new String[loadBeforeNamesList.size()]);
}
}
}
@SuppressWarnings("unchecked")
private void evaluatePluginDependencies() {
if (!pluginBean.isReadableProperty(DEPENDS_ON)) {
return;
}
dependencies = (Map) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(pluginBean, plugin, DEPENDS_ON);
dependencyNames = dependencies.keySet().toArray(new String[dependencies.size()]);
}
@Override
public String[] getLoadAfterNames() {
return loadAfterNames;
}
@Override
public String[] getLoadBeforeNames() {
return loadBeforeNames;
}
/**
* @return the resolver
*/
public PathMatchingResourcePatternResolver getResolver() {
return resolver;
}
public ApplicationContext getParentCtx() {
return application.getParentContext();
}
public BeanBuilder beans(Closure closure) {
BeanBuilder bb = new BeanBuilder(getParentCtx(), new GroovyClassLoader(application.getClassLoader()));
bb.invokeMethod("beans", new Object[]{closure});
return bb;
}
public void doWithApplicationContext(ApplicationContext ctx) {
if(plugin instanceof Plugin) {
Plugin pluginObject = (Plugin) plugin;
pluginObject.setApplicationContext(ctx);
pluginObject.doWithApplicationContext();
}
else {
Object[] args = {ctx};
invokePluginHook(DO_WITH_APPLICATION_CONTEXT, args, ctx);
}
}
private void invokePluginHook(String methodName, Object[] args, ApplicationContext ctx) {
if (pluginBean.isReadableProperty(methodName)) {
Closure c = (Closure)plugin.getProperty(methodName);
c.setDelegate(this);
c.call(args);
}
else {
MetaClass pluginMetaClass = pluginGrailsClass.getMetaClass();
if(!pluginMetaClass.respondsTo(plugin, methodName, args).isEmpty()) {
pluginMetaClass.invokeMethod(plugin, methodName, ctx);
}
}
}
public void doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig) {
Binding b = new Binding();
b.setVariable("application", grailsApplication);
b.setVariable(GrailsApplication.APPLICATION_ID, grailsApplication);
b.setVariable("manager", getManager());
b.setVariable("plugin", this);
b.setVariable("parentCtx", getParentCtx());
b.setVariable("resolver", getResolver());
if(plugin instanceof Plugin) {
Closure c = ((Plugin) plugin).doWithSpring();
if(c != null) {
BeanBuilder bb = new BeanBuilder(getParentCtx(),springConfig, grailsApplication.getClassLoader());
bb.setBinding(b);
bb.invokeMethod("beans", new Object[]{c});
}
}
else {
if (!pluginBean.isReadableProperty(DO_WITH_SPRING)) {
return;
}
if (LOG.isDebugEnabled()) {
LOG.debug("Plugin " + this + " is participating in Spring configuration...");
}
Closure c = (Closure)plugin.getProperty(DO_WITH_SPRING);
BeanBuilder bb = new BeanBuilder(getParentCtx(),springConfig, grailsApplication.getClassLoader());
bb.setBinding(b);
c.setDelegate(bb);
bb.invokeMethod("beans", new Object[]{c});
}
}
@Override
public String getName() {
return pluginGrailsClass.getLogicalPropertyName();
}
public void addExclude(BuildScope buildScope) {
addExcludeRuleInternal(pluginScopes, buildScope);
}
@SuppressWarnings("unchecked")
private void addExcludeRuleInternal(Map map, Object o) {
Collection excludes = (Collection) map.get(EXCLUDES);
if (excludes == null) {
excludes = new ArrayList();
map.put(EXCLUDES, excludes);
}
Collection includes = (Collection) map.get(INCLUDES);
if (includes != null) includes.remove(o);
excludes.add(o);
}
public void addExclude(Environment env) {
addExcludeRuleInternal(pluginEnvs, env);
}
public boolean supportsScope(BuildScope buildScope) {
return supportsValueInIncludeExcludeMap(pluginScopes, buildScope);
}
public boolean supportsEnvironment(Environment environment) {
return supportsValueInIncludeExcludeMap(pluginEnvs, environment.getName());
}
public boolean supportsCurrentScopeAndEnvironment() {
BuildScope bs = BuildScope.getCurrent();
Environment e = Environment.getCurrent();
return supportsEnvironment(e) && supportsScope(bs);
}
private boolean supportsValueInIncludeExcludeMap(Map includeExcludeMap, Object value) {
if (includeExcludeMap.isEmpty()) {
return true;
}
Set includes = (Set) includeExcludeMap.get(INCLUDES);
if (includes != null) {
return includes.contains(value);
}
Set excludes = (Set)includeExcludeMap.get(EXCLUDES);
return !(excludes != null && excludes.contains(value));
}
/**
* @deprecated Dynamic document generation no longer supported
* @param text
*/
@Deprecated
public void doc(String text) {
// no-op
}
@Override
public String[] getDependencyNames() {
return dependencyNames;
}
/**
* @return the watchedResources
*/
public Resource[] getWatchedResources() {
if (watchedResources.length == 0 && watchedResourcePatternReferences != null) {
for (String resourcesReference : watchedResourcePatternReferences) {
try {
Resource[] resources = resolver.getResources(resourcesReference);
if (resources.length > 0) {
watchedResources = (Resource[])GrailsArrayUtils.addAll(watchedResources, resources);
}
}
catch (Exception ignored) {
// ignore
}
}
}
return watchedResources;
}
@Override
public String getDependentVersion(String name) {
Object dependentVersion = dependencies.get(name);
if (dependentVersion == null) {
throw new PluginException("Plugin [" + getName() + "] referenced dependency [" + name + "] with no version!");
}
return dependentVersion.toString();
}
@Override
public String toString() {
return "[" + getName() + ":" + getVersion() + "]";
}
/**
* Monitors the plugin resources defined in the watchResources property for changes and
* fires onChange events by calling an onChange closure defined in the plugin (if it exists)
*
* @deprecated
*/
@Override
@Deprecated
public boolean checkForChanges() {
return false; // do nothing
}
/**
* Restarts the container
*
* @deprecated Not needed any more due to the reload agent
*/
@Deprecated
public void restartContainer() {
// do nothing
}
public void setWatchedResources(Resource[] watchedResources) throws IOException {
this.watchedResources = watchedResources;
}
/*
* These two properties help the closures to resolve a log and plugin variable during executing
*/
public Log getLog() {
return LOG;
}
public GrailsPlugin getPlugin() {
return this;
}
public void setParentApplicationContext(ApplicationContext parent) {
// do nothing for the moment
}
/* (non-Javadoc)
* @see org.grails.plugins.AbstractGrailsPlugin#refresh()
*/
@Override
public void refresh() {
// do nothing
org.grails.io.support.Resource descriptor = getDescriptor();
if (application == null || descriptor == null) {
return;
}
ClassLoader parent = application.getClassLoader();
GroovyClassLoader gcl = new GroovyClassLoader(parent);
try {
initialisePlugin(gcl.parseClass(descriptor.getFile()));
} catch (Exception e) {
LOG.error("Error refreshing plugin: " + e.getMessage(), e);
}
}
public GroovyObject getInstance() {
return plugin;
}
public void doWithDynamicMethods(ApplicationContext ctx) {
if(plugin instanceof Plugin) {
((Plugin)plugin).doWithDynamicMethods();
}
else {
Object[] args = {ctx};
invokePluginHook(DO_WITH_DYNAMIC_METHODS, args, ctx);
}
}
public boolean isEnabled() {
if(plugin instanceof Plugin) {
return ((Plugin)plugin).isEnabled();
}
else {
return STATUS_ENABLED.equals(status);
}
}
public String[] getObservedPluginNames() {
return observedPlugins;
}
public void notifyOfEvent(Map event) {
if(plugin instanceof Plugin) {
((Plugin)plugin).onChange(event);
}
else if(onChangeListener != null) {
invokeOnChangeListener(event);
}
}
public Map notifyOfEvent(int eventKind, final Object source) {
@SuppressWarnings("unchecked")
Map event = CollectionUtils.newMap(
PLUGIN_CHANGE_EVENT_SOURCE, source,
PLUGIN_CHANGE_EVENT_PLUGIN, plugin,
PLUGIN_CHANGE_EVENT_APPLICATION, application,
PLUGIN_CHANGE_EVENT_MANAGER, getManager(),
PLUGIN_CHANGE_EVENT_CTX, applicationContext);
switch (eventKind) {
case EVENT_ON_CHANGE:
if(plugin instanceof Plugin) {
((Plugin)plugin).onChange(event);
}
else {
notifyOfEvent(event);
}
getManager().informObservers(getName(), event);
break;
case EVENT_ON_SHUTDOWN:
if(plugin instanceof Plugin) {
((Plugin)plugin).onShutdown(event);
}
else {
invokeOnShutdownEventListener(event);
}
break;
case EVENT_ON_CONFIG_CHANGE:
if(plugin instanceof Plugin) {
((Plugin)plugin).onConfigChange(event);
}
else {
invokeOnConfigChangeListener(event);
}
break;
default:
notifyOfEvent(event);
}
return event;
}
private void invokeOnShutdownEventListener(Map event) {
callEvent(onShutdownListener,event);
}
private void invokeOnConfigChangeListener(Map event) {
callEvent(onConfigChangeListener,event);
}
private void callEvent(Closure closureHook, Map event) {
if (closureHook == null) {
return;
}
closureHook.setDelegate(this);
closureHook.call(new Object[]{event});
}
private void invokeOnChangeListener(Map event) {
onChangeListener.setDelegate(this);
onChangeListener.call(new Object[]{event});
if (!(applicationContext instanceof GenericApplicationContext)) {
return;
}
// Apply any factory post processors in case the change listener has changed any
// bean definitions (GRAILS-5763)
GenericApplicationContext ctx = (GenericApplicationContext) applicationContext;
ConfigurableListableBeanFactory beanFactory = ctx.getBeanFactory();
for (BeanFactoryPostProcessor postProcessor : ctx.getBeanFactoryPostProcessors()) {
try {
postProcessor.postProcessBeanFactory(beanFactory);
} catch (IllegalStateException e) {
// post processor doesn't allow running again, just continue
}
}
}
public void doArtefactConfiguration() {
if (!pluginBean.isReadableProperty(ARTEFACTS)) {
return;
}
List l;
if(plugin instanceof Plugin) {
l = ((Plugin)plugin).getArtefacts();
}
else {
l = (List)plugin.getProperty(ARTEFACTS);
}
for (Object artefact : l) {
if (artefact instanceof Class) {
Class artefactClass = (Class) artefact;
if (ArtefactHandler.class.isAssignableFrom(artefactClass)) {
try {
((LegacyGrailsApplication)application).getGrailsApplication().registerArtefactHandler((ArtefactHandler) artefactClass.newInstance());
}
catch (InstantiationException e) {
LOG.error("Cannot instantiate an Artefact Handler:" + e.getMessage(), e);
}
catch (IllegalAccessException e) {
LOG.error("The constructor of the Artefact Handler is not accessible:" + e.getMessage(), e);
}
}
else {
LOG.error("This class is not an ArtefactHandler:" + artefactClass.getName());
}
}
else if (artefact instanceof ArtefactHandler) {
((LegacyGrailsApplication)application).getGrailsApplication().registerArtefactHandler((ArtefactHandler) artefact);
}
else {
LOG.error("This object is not an ArtefactHandler:" + artefact + "[" + artefact.getClass().getName() + "]");
}
}
}
public Class[] getProvidedArtefacts() {
return providedArtefacts;
}
public List getPluginExcludes() {
return pluginExcludes;
}
public Collection getTypeFilters() {
return typeFilters;
}
public String getFullName() {
return getName() + '-' + getVersion();
}
public org.grails.io.support.Resource getDescriptor() {
return new SpringResource(pluginDescriptor);
}
public void setDescriptor(Resource descriptor) {
pluginDescriptor = descriptor;
}
public org.grails.io.support.Resource getPluginDir() {
try {
return new SpringResource(pluginDescriptor.createRelative("."));
}
catch (IOException e) {
return null;
}
}
public Map getProperties() {
return DefaultGroovyMethods.getProperties(plugin);
}
}