hudson.maven.MavenReporterDescriptor Maven / Gradle / Ivy
package hudson.maven;
import hudson.maven.reporters.MavenArtifactArchiver;
import hudson.model.Descriptor;
import org.apache.commons.jelly.JellyException;
import org.kohsuke.stapler.MetaClass;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.WebApp;
import org.kohsuke.stapler.jelly.JellyClassTearOff;
/**
* {@link Descriptor} for {@link MavenReporter}.
*
* @author Kohsuke Kawaguchi
*/
public abstract class MavenReporterDescriptor extends Descriptor {
protected MavenReporterDescriptor(Class clazz) {
super(clazz);
}
/**
* Returns an instance used for automatic {@link MavenReporter} activation.
*
*
* Some {@link MavenReporter}s, such as {@link MavenArtifactArchiver},
* can work just with the configuration in POM and don't need any additional
* Hudson configuration. They also don't need any explicit enabling/disabling
* as they can activate themselves by listening to the callback from the build
* (for example javadoc archiver can do the work in response to the execution
* of the javadoc target.)
*
*
* Those {@link MavenReporter}s should return a valid instance
* from this method. Such instance will then participate into the build
* and receive event callbacks.
*/
public MavenReporter newAutoInstance(MavenModule module) {
return null;
}
/**
* If {@link #hasConfigScreen() the reporter has no configuration screen},
* this method can safely return null, which is the default implementation.
*/
@Deprecated
public MavenReporter newInstance(StaplerRequest req) throws FormException {
return null;
}
/**
* Returns true if this descriptor has config.jelly.
*/
public final boolean hasConfigScreen() {
MetaClass c = WebApp.getCurrent().getMetaClass(getClass());
try {
JellyClassTearOff tearOff = c.loadTearOff(JellyClassTearOff.class);
return tearOff.findScript(getConfigPage())!=null;
} catch(JellyException e) {
return false;
}
}
}