DefaultGrailsPlugin.java
| Index Score | ||
|---|---|---|
 |
 |
org.codehaus.groovy.grails.plugins |
 |
 |
Grails |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| CYCLOMATIC | Cyclomatic complexity | |
| EXITS | Procedure exits | |
| BLOCKS | Number of blocks | |
| COMPARISONS | Number of comparison operators | |
| OPERATORS | Number of operators | |
| SIZE | Size of the file in bytes | |
| PROGRAM_LENGTH | Halstead program length | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOGICAL_LINES | Number of statements | |
| OPERANDS | Number of operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| RETURNS | Number of return points from functions | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| FUNCTIONS | Number of function declarations | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0077 | JAVA0077 Private field not used in declaring class | |
| LOOPS | Number of loops | |
| LINES | Number of lines in the source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| UNIQUE_OPERATORS | Number of unique operators | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0244 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| PROGRAM_VOLUME | Halstead program volume | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0029 | JAVA0029 Private method not used | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LINE_COMMENT | Number of line comments | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| COMMENTS | Comment lines | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* 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.codehaus.groovy.grails.plugins;
import grails.spring.BeanBuilder;
import grails.util.GrailsUtil;
import groovy.lang.*;
import groovy.util.slurpersupport.GPathResult;
import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.codehaus.groovy.grails.commons.ArtefactHandler;
import org.codehaus.groovy.grails.commons.GrailsApplication;
import org.codehaus.groovy.grails.commons.GrailsClassUtils;
import org.codehaus.groovy.grails.commons.GrailsResourceUtils;
import org.codehaus.groovy.grails.commons.spring.RuntimeSpringConfiguration;
import org.codehaus.groovy.grails.compiler.GrailsClassLoader;
import org.codehaus.groovy.grails.compiler.support.GrailsResourceLoader;
import org.codehaus.groovy.grails.compiler.support.GrailsResourceLoaderHolder;
import org.codehaus.groovy.grails.plugins.exceptions.PluginException;
import org.codehaus.groovy.grails.support.ParentApplicationContextAware;
import org.springframework.beans.BeanWrapper;
import org.springframework.beans.BeanWrapperImpl;
import org.springframework.context.ApplicationContext;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import java.io.IOException;
import java.io.File;
import java.lang.reflect.Modifier;
import java.net.URL;
import java.net.URLConnection;
import java.util.*;
/**
* 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
*
*/
public class DefaultGrailsPlugin extends AbstractGrailsPlugin implements GrailsPlugin, 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";
private static final String PLUGIN_LOAD_AFTER_NAMES = "loadAfter";
private static final String PLUGIN_OBSERVE = "observe";
private static final Log LOG = LogFactory.getLog(DefaultGrailsPlugin.class);
private GrailsPluginClass pluginGrailsClass;
private GroovyObject plugin;
protected BeanWrapper pluginBean;
private Closure onChangeListener;
private Resource[] watchedResources = new Resource[0];
private long[] modifiedTimes = new long[0];
private PathMatchingResourcePatternResolver resolver;
private String[] resourcesReferences;
private int[] resourceCount;
private String[] loadAfterNames = new String[0];
private String[] influencedPluginNames = new String[0];
private String status = STATUS_ENABLED;
private String[] observedPlugins;
private long pluginLastModified = Long.MAX_VALUE;
private URL pluginUrl;
private Closure onConfigChangeListener;
private Closure onShutdownListener;
private Class[] providedArtefacts = new Class[0];
public DefaultGrailsPlugin(Class pluginClass, Resource resource, GrailsApplication application) {
super(pluginClass, application);
// create properties
this.dependencies = Collections.EMPTY_MAP;
this.resolver = new PathMatchingResourcePatternResolver();
if(resource != null) {
try {
pluginUrl = resource.getURL();
this.pluginLastModified = pluginUrl
.openConnection()
.getLastModified();
} catch (IOException e) {
LOG.warn("I/O error reading last modified date of plug-in ["+pluginClass+"], you won't be able to reload changes: " + e.getMessage(),e);
}
}
initialisePlugin(pluginClass);
}
private void initialisePlugin(Class pluginClass) {
this.pluginGrailsClass = new GrailsPluginClass(pluginClass);
this.plugin = (GroovyObject)this.pluginGrailsClass.newInstance();
this.pluginBean = new BeanWrapperImpl(this.plugin);
// configure plugin
evaluatePluginVersion();
evaluatePluginDependencies();
evaluatePluginLoadAfters();
evaluateProvidedArtefacts();
evaluatePluginEvictionPolicy();
evaluatePluginInfluencePolicy();
evaluateOnChangeListener();
evaluateObservedPlugins();
evaluatePluginStatus();
}
private void evaluateProvidedArtefacts() {
Object providedArtefacts = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, PROVIDED_ARTEFACTS);
if(providedArtefacts instanceof Collection) {
final Collection artefactList = (Collection) providedArtefacts;
this.providedArtefacts = (Class[])artefactList.toArray(new Class[artefactList.size()]);
}
}
public DefaultGrailsPlugin(Class pluginClass, GrailsApplication application) {
this(pluginClass, null,application);
}
private void evaluateObservedPlugins() {
if(this.pluginBean.isReadableProperty(PLUGIN_OBSERVE)) {
Object observeProperty = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, PLUGIN_OBSERVE);
if(observeProperty instanceof Collection) {
Collection observeList = (Collection)observeProperty;
observedPlugins = new String[observeList.size()];
int j = 0;
for (Iterator i = observeList.iterator(); i.hasNext();) {
String pluginName = i.next().toString();
observedPlugins[j++] = pluginName;
}
}
}
if(observedPlugins == null) observedPlugins = new String[0];
}
private void evaluatePluginStatus() {
if(this.pluginBean.isReadableProperty(STATUS)) {
Object statusObj = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, STATUS);
if(statusObj != null) {
this.status = statusObj.toString().toLowerCase();
}
}
}
private void evaluateOnChangeListener() {
if(this.pluginBean.isReadableProperty(ON_CONFIG_CHANGE)) {
this.onConfigChangeListener = (Closure)GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, ON_CONFIG_CHANGE);
}
if(this.pluginBean.isReadableProperty(ON_SHUTDOWN)) {
this.onShutdownListener= (Closure)GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, ON_SHUTDOWN);
}
if(this.pluginBean.isReadableProperty(ON_CHANGE)) {
this.onChangeListener = (Closure) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, ON_CHANGE);
Object referencedResources = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.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 = new ArrayList();
resourceList.add(referencedResources.toString());
}
else if(referencedResources instanceof List) {
resourceList = (List)referencedResources;
}
if(resourceList!=null) {
this.resourcesReferences = new String[resourceList.size()];
this.resourceCount = new int[resourceList.size()];
for (int i = 0; i < resourcesReferences.length; i++) {
String resRef = resourceList.get(i).toString();
resourcesReferences[i]=resRef;
}
for (int i = 0; i < resourcesReferences.length; i++) {
String res = resourcesReferences[i];
Resource[] tmp = resolver.getResources(res);
resourceCount[i] = tmp.length;
if(LOG.isDebugEnabled()) {
LOG.debug("Watching resource set ["+(i+1)+"]: " + ArrayUtils.toString(tmp));
}
if(tmp.length == 0)
tmp = resolver.getResources("classpath*:" + res);
if(tmp.length > 0){
watchedResources = (Resource[])ArrayUtils.addAll(this.watchedResources, tmp);
}
}
}
}
catch (IllegalArgumentException e) {
if(GrailsUtil.isDevelopmentEnv())
LOG.debug("Cannot load plug-in resource watch list from ["+ ArrayUtils.toString(resourcesReferences) +"]. This means that the plugin "+this+", will not be able to auto-reload changes effectively. Try runnng grails upgrade.: " + e.getMessage());
}
catch (IOException e) {
if(GrailsUtil.isDevelopmentEnv())
LOG.debug("Cannot load plug-in resource watch list from ["+ ArrayUtils.toString(resourcesReferences) +"]. This means that the plugin "+this+", will not be able to auto-reload changes effectively. Try runnng grails upgrade.: " + e.getMessage());
}
if(LOG.isDebugEnabled()) {
LOG.debug("Plugin "+this+" found ["+watchedResources.length+"] to watch");
}
try {
initializeModifiedTimes();
} catch (IOException e) {
LOG.warn("I/O exception initializing modified times for watched resources: " + e.getMessage(), e);
}
}
}
private void evaluatePluginInfluencePolicy() {
if(this.pluginBean.isReadableProperty(INFLUENCES)) {
List influencedList = (List)this.pluginBean.getPropertyValue(INFLUENCES);
if(influencedList != null) {
this.influencedPluginNames = (String[])influencedList.toArray(new String[influencedList.size()]);
}
}
}
private void evaluatePluginVersion() {
if(this.pluginBean.isReadableProperty(VERSION)) {
Object vobj = this.plugin.getProperty(VERSION);
if(vobj != null)
this.version = vobj.toString();
else
throw new PluginException("Plugin "+this+" must specify a version. eg: def version = 0.1");
}
else {
throw new PluginException("Plugin ["+getName()+"] must specify a version!");
}
}
private void evaluatePluginEvictionPolicy() {
if(this.pluginBean.isReadableProperty(EVICT)) {
List pluginsToEvict = (List) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, EVICT);
if(pluginsToEvict != null) {
this.evictionList = new String[pluginsToEvict.size()];
int index = 0;
for (Iterator i = pluginsToEvict.iterator(); i.hasNext();) {
Object o = i.next();
evictionList[index++] = o != null ? o.toString() : "";
}
}
}
}
private void evaluatePluginLoadAfters() {
if(this.pluginBean.isReadableProperty(PLUGIN_LOAD_AFTER_NAMES)) {
List loadAfterNamesList = (List) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, PLUGIN_LOAD_AFTER_NAMES);
if(loadAfterNamesList != null) {
this.loadAfterNames = (String[])loadAfterNamesList.toArray(new String[loadAfterNamesList.size()]);
}
}
}
private void evaluatePluginDependencies() {
if(this.pluginBean.isReadableProperty(DEPENDS_ON)) {
this.dependencies = (Map) GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(this.plugin, DEPENDS_ON);
this.dependencyNames = (String[])this.dependencies.keySet().toArray(new String[this.dependencies.size()]);
}
}
public String[] getLoadAfterNames() {
return this.loadAfterNames;
}
/**
* @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;
}
private void initializeModifiedTimes() throws IOException {
modifiedTimes = new long[watchedResources.length];
for (int i = 0; i < watchedResources.length; i++) {
Resource r = watchedResources[i];
URLConnection c = r.getURL().openConnection();
c.setDoInput(false);
c.setDoOutput(false);
modifiedTimes[i] = c.getLastModified();
}
}
public void doWithApplicationContext(ApplicationContext applicationContext) {
if(this.pluginBean.isReadableProperty(DO_WITH_APPLICATION_CONTEXT)) {
Closure c = (Closure)this.plugin.getProperty(DO_WITH_APPLICATION_CONTEXT);
c.setDelegate(this);
c.call(new Object[]{applicationContext});
}
}
public void doWithRuntimeConfiguration(
RuntimeSpringConfiguration springConfig) {
if(this.pluginBean.isReadableProperty(DO_WITH_SPRING)) {
if(LOG.isDebugEnabled()) {
LOG.debug("Plugin " + this + " is participating in Spring configuration...");
}
Closure c = (Closure)this.plugin.getProperty(DO_WITH_SPRING);
BeanBuilder bb = new BeanBuilder(getParentCtx(), application.getClassLoader());
bb.setSpringConfig(springConfig);
Binding b = new Binding();
b.setVariable("application", application);
b.setVariable("manager", getManager());
b.setVariable("plugin", this);
b.setVariable("parentCtx", getParentCtx());
b.setVariable("resolver", getResolver());
bb.setBinding(b);
c.setDelegate(bb);
bb.invokeMethod("beans", new Object[]{c});
}
}
public String getName() {
return this.pluginGrailsClass.getLogicalPropertyName();
}
public String getVersion() {
return this.version;
}
public String[] getDependencyNames() {
return this.dependencyNames;
}
/**
* @return the watchedResources
*/
public Resource[] getWatchedResources() {
return watchedResources;
}
public String getDependentVersion(String name) {
Object dependentVersion = this.dependencies.get(name);
if(dependentVersion == null)
throw new PluginException("Plugin ["+getName()+"] referenced dependency ["+name+"] with no version!");
else
return dependentVersion.toString();
}
public String toString() {
return "["+getName()+":"+getVersion()+"]";
}
public void doWithWebDescriptor(GPathResult webXml) {
if(this.pluginBean.isReadableProperty(DO_WITH_WEB_DESCRIPTOR)) {
Closure c = (Closure)this.plugin.getProperty(DO_WITH_WEB_DESCRIPTOR);
c.setResolveStrategy(Closure.DELEGATE_FIRST);
c.setDelegate(this);
c.call(webXml);
}
}
/**
* 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)
*/
public boolean checkForChanges() {
if(pluginUrl != null) {
long currentModified = -1;
URLConnection conn = null;
try {
conn = pluginUrl
.openConnection();
currentModified = conn
.getLastModified();
if(currentModified > pluginLastModified) {
if(LOG.isInfoEnabled())
LOG.info("Grails plug-in "+this+" changed, reloading changes..");
GroovyClassLoader gcl = new GroovyClassLoader(application.getClassLoader());
initialisePlugin(gcl.parseClass(conn.getInputStream()));
pluginLastModified = currentModified;
return true;
}
} catch (IOException e) {
LOG.warn("Error reading plugin ["+pluginClass+"] last modified date, cannot reload following change: " + e.getMessage());
}
finally {
if(conn!=null) {
try {
conn.getInputStream().close();
} catch (IOException e) {
LOG.warn("Error closing URL connection to plugin resource ["+pluginUrl+"]: " + e.getMessage(), e);
}
}
}
}
if(onChangeListener!=null) {
checkForNewResources(this);
if(LOG.isDebugEnabled()) {
LOG.debug("Plugin "+this+" checking ["+watchedResources.length+"] resources for changes..");
}
for (int i = 0; i < watchedResources.length; i++) {
final Resource r = watchedResources[i];
long modifiedFlag = checkModified(r, modifiedTimes[i]) ;
if( modifiedFlag > -1) {
if(LOG.isInfoEnabled())
LOG.info("Grails plug-in resource ["+r+"] changed, reloading changes..");
modifiedTimes[i] = modifiedFlag;
fireModifiedEvent(r, this);
refreshInfluencedPlugins();
}
}
}
return false;
}
/**
* This method will retrieve all the influenced plugins from the manager and
* call refresh() on each one
*/
private void refreshInfluencedPlugins() {
GrailsPluginManager manager = getManager();
if(LOG.isDebugEnabled())
LOG.debug("Plugin "+this+" starting refresh of influenced plugins " + ArrayUtils.toString(influencedPluginNames));
if(manager != null) {
for (int i = 0; i < influencedPluginNames.length; i++) {
String name = influencedPluginNames[i];
GrailsPlugin plugin = manager.getGrailsPlugin(name);
if(plugin!=null) {
if(LOG.isDebugEnabled())
LOG.debug(this+" plugin is refreshing influenced plugin " + plugin +" following change to resource");
plugin.refresh();
}
}
}
else if(LOG.isDebugEnabled()) {
LOG.debug("Plugin "+this+" cannot refresh influenced plugins, manager is not found");
}
}
/**
* This method will take a Resource and check it against the previous modified time passed
* in the arguments. If the resource was modified it will return the new modified time, otherwise
* it will return -1
*
* @param r The Resource instance
* @param previousModifiedTime The last time the Resource was modified
* @return The new modified time or -1
*/
private long checkModified(Resource r, long previousModifiedTime) {
try {
URL url = r.getURL();
if(LOG.isDebugEnabled())
LOG.debug("Checking modified for url " + url);
URLConnection c = url.openConnection();
c.setDoInput(false);
c.setDoOutput(false);
long lastModified = c.getLastModified();
if( previousModifiedTime < lastModified ) {
return lastModified;
}
} catch (IOException e) {
LOG.debug("Unable to read last modified date of plugin resource" +e.getMessage(),e);
}
return -1;
}
private void checkForNewResources(final GrailsPlugin plugin) {
if(resourcesReferences != null) {
if(LOG.isDebugEnabled()) {
LOG.debug("Plugin "+plugin+" checking ["+ArrayUtils.toString(resourcesReferences)+"] resource references new resources that have been added..");
}
for (int i = 0; i < resourcesReferences.length; i++) {
String resourcesReference = resourcesReferences[i];
try {
Resource[] tmp = resolver.getResources(resourcesReference);
if(resourceCount[i] < tmp.length) {
Resource newResource = null;
resourceCount[i] = tmp.length;
for (int j = 0; j < tmp.length; j++) {
Resource resource = tmp[j];
if(!ArrayUtils.contains(watchedResources, resource)) {
newResource = resource;
break;
}
}
if(newResource!=null) {
watchedResources = (Resource[])ArrayUtils.add(watchedResources, newResource);
if(LOG.isInfoEnabled())
LOG.info("Found new Grails plug-in resource ["+newResource+"], adding to application..");
if(newResource.getFilename().endsWith(".groovy")) {
if(LOG.isDebugEnabled())
LOG.debug("[GrailsPlugin] plugin resource ["+newResource+"] added, registering resource with class loader...");
GroovyClassLoader classLoader = this.application.getClassLoader();
GrailsResourceLoader resourceLoader = GrailsResourceLoaderHolder.getResourceLoader();
Resource[] classLoaderResources = resourceLoader.getResources();
classLoaderResources = (Resource[])ArrayUtils.add(classLoaderResources, newResource);
resourceLoader.setResources(classLoaderResources);
if(classLoader instanceof GrailsClassLoader) {
((GrailsClassLoader)classLoader).setGrailsResourceLoader(resourceLoader);
}
}
initializeModifiedTimes();
if(LOG.isDebugEnabled())
LOG.debug("[GrailsPlugin] plugin resource ["+newResource+"] added, firing event if possible..");
fireModifiedEvent(newResource, plugin);
}
}
}
catch (IllegalArgumentException e) {
LOG.debug("Plugin "+this+" was unable to check for new plugin resources: " + e.getMessage());
}
catch (IOException e) {
LOG.debug("Plugin "+this+" was unable to check for new plugin resources: " + e.getMessage());
}
}
}
}
protected void fireModifiedEvent(final Resource resource, final GrailsPlugin plugin) {
Class loadedClass = null;
String className = GrailsResourceUtils.getClassName(resource);
if(className != null) {
Class oldClass = application.getClassForName(className);
loadedClass = attemptClassReload(className);
if(oldClass != null) {
GroovySystem.getMetaClassRegistry().removeMetaClass(oldClass);
}
}
final Class resourceClass = loadedClass;
Object source;
if(resourceClass != null)source=resourceClass;
else source = resource;
if(loadedClass != null && Modifier.isAbstract(loadedClass.getModifiers())) {
restartContainer();
}
else {
Map event = notifyOfEvent(EVENT_ON_CHANGE, source);
if(LOG.isDebugEnabled()) {
LOG.debug("Firing onChange event listener with event object ["+event+"]");
}
getManager().informObservers(getName(), event);
}
}
public void restartContainer() {
// here we touch the classes directory if the file is abstract to force the Grails server
// to restart the web application
try {
String classesDir = System.getProperty("grails.classes.dir");
File classesFile = null;
if(!StringUtils.isBlank(classesDir)) {
classesFile = new File(classesDir);
}
else {
Resource r = this.applicationContext.getResource("/WEB-INF/classes");
classesFile = r.getFile();
}
classesFile.setLastModified(System.currentTimeMillis());
} catch (IOException e) {
LOG.error("Error retrieving /WEB-INF/classes directory: " + e.getMessage(),e);
}
}
private Class attemptClassReload(final Resource resource) {
String className = GrailsResourceUtils.getClassName(resource);
if(className != null) {
return attemptClassReload(className);
}
return null;
}
private Class attemptClassReload(String className) {
final GroovyClassLoader loader = application.getClassLoader();
if(loader instanceof GrailsClassLoader) {
GrailsClassLoader grailsLoader = (GrailsClassLoader)loader;
return grailsLoader.reloadClass(className);
}
return null;
}
public void setWatchedResources(Resource[] watchedResources) throws IOException {
this.watchedResources = watchedResources;
initializeModifiedTimes();
}
/*
* 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.codehaus.groovy.grails.plugins.AbstractGrailsPlugin#refresh()
*/
public void refresh() {
refresh(true);
}
public void refresh(boolean fireEvent) {
for (int i = 0; i < watchedResources.length; i++) {
Resource r = watchedResources[i];
try {
r.getFile().setLastModified(System.currentTimeMillis());
} catch (IOException e) {
// ignore
}
if(fireEvent)
fireModifiedEvent(r, this);
}
}
public GroovyObject getInstance() {
return this.plugin;
}
public void doWithDynamicMethods(ApplicationContext applicationContext) {
if(this.pluginBean.isReadableProperty(DO_WITH_DYNAMIC_METHODS)) {
Closure c = (Closure)this.plugin.getProperty(DO_WITH_DYNAMIC_METHODS);
c.setDelegate(this);
c.call(new Object[]{applicationContext});
}
}
public boolean isEnabled() {
return STATUS_ENABLED.equals(this.status);
}
public String[] getObservedPluginNames() {
return this.observedPlugins;
}
public void notifyOfEvent(Map event) {
if(onChangeListener != null) {
invokeOnChangeListener(event);
}
}
public Map notifyOfEvent(int eventKind, final Object source) {
Map event = new HashMap() {{
put(PLUGIN_CHANGE_EVENT_SOURCE, source);
put(PLUGIN_CHANGE_EVENT_PLUGIN, plugin);
put(PLUGIN_CHANGE_EVENT_APPLICATION, application);
put(PLUGIN_CHANGE_EVENT_MANAGER, getManager());
put(PLUGIN_CHANGE_EVENT_CTX, applicationContext);
}};
switch (eventKind) {
case EVENT_ON_CHANGE:
notifyOfEvent(event);
break;
case EVENT_ON_SHUTDOWN:
invokeOnShutdownEventListener(event);
break;
case EVENT_ON_CONFIG_CHANGE:
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) {
closureHook.setDelegate(this);
closureHook.call(new Object[]{event});
}
}
private void invokeOnChangeListener(Map event) {
onChangeListener.setDelegate(this);
onChangeListener.call(new Object[]{event});
}
public void doArtefactConfiguration() {
if(this.pluginBean.isReadableProperty(ARTEFACTS)) {
List l = (List)this.plugin.getProperty(ARTEFACTS);
for (Iterator iter = l.iterator(); iter.hasNext();) {
Object artefact = iter.next();
if(artefact instanceof Class) {
Class artefactClass = (Class)artefact;
if(ArtefactHandler.class.isAssignableFrom(artefactClass)) {
try {
this.application.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) {
this.application.registerArtefactHandler((ArtefactHandler)artefact);
} else {
LOG.error("This object is not an ArtefactHandler:" + artefact + "[" + artefact.getClass().getName()+"]");
}
}
}
}
}
public Class[] getProvidedArtefacts() {
return this.providedArtefacts;
}
}
The table below shows all metrics for DefaultGrailsPlugin.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 153.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 58.00 | Comment lines | |
| COMMENT_DENSITY | 0.12 | Comment density | |
| COMPARISONS | 103.00 | Number of comparison operators | |
| CYCLOMATIC | 157.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 9.00 | Comments in declarations | |
| DOC_COMMENT | 31.00 | Number of javadoc comment lines | |
| ELOC | 479.00 | Effective lines of code | |
| EXEC_COMMENTS | 5.00 | Comments in executable code | |
| EXITS | 116.00 | Procedure exits | |
| FUNCTIONS | 52.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 88.75 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 105.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 1.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 1.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 19.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 7.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 5.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 5.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 10.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 1.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 8.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 127.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 1.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 1.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 3.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 1.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 3.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 1.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 5.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 3.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 803.00 | Number of lines in the source file | |
| LINE_COMMENT | 6.00 | Number of line comments | |
| LOC | 619.00 | Lines of code | |
| LOGICAL_LINES | 320.00 | Number of statements | |
| LOOPS | 11.00 | Number of loops | |
| NEST_DEPTH | 8.00 | Maximum nesting depth | |
| OPERANDS | 1477.00 | Number of operands | |
| OPERATORS | 2997.00 | Number of operators | |
| PARAMS | 30.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 4474.00 | Halstead program length | |
| PROGRAM_VOCAB | 522.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 75.00 | Number of return points from functions | |
| SIZE | 31372.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 466.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 56.00 | Number of unique operators | |
| WHITESPACE | 126.00 | Number of whitespace lines | |