hudson.plugins.depgraph_view

Class AbstractDependencyGraphAction

java.lang.Object

hudson.plugins.depgraph_view.AbstractDependencyGraphAction

All Implemented Interfaces:

hudson.model.Action, hudson.model.ModelObject

Direct Known Subclasses:

DependencyGraphActionFactory.DependencyGraphProjectAction, DependencyGraphViewActionFactory.DependencyGraphViewAction

public abstract class AbstractDependencyGraphAction
extends Object
implements hudson.model.Action

Basic action for creating a Dot-Image of the DependencyGraph

Constructor Summary

Constructors

Constructor and Description
AbstractDependencyGraphAction()

Method Summary

Modifier and Type	Method and Description
jenkins.model.ModelObjectWithContextMenu.ContextMenu	doContextMenu(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) This method is called via AJAX to obtain the context menu for this model object, but we don't have one...
void	doDynamic(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) graph.{png,gv,...} is mapped to the corresponding output
void	doEdge(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
String	getDisplayName()
String	getIconFileName()
abstract hudson.model.AbstractModelObject	getParentObject()
String	getProjectNameStripRegex()
int	getProjectNameStripRegexGroup()
protected abstract Collection<? extends hudson.model.Job<?,?>>	getProjectsForDepgraph()
abstract String	getTitle()
String	getUrlName()
boolean	isEditFunctionInJSViewEnabled()
boolean	isGraphvizEnabled()
protected void	runDot(OutputStream output, InputStream input, String type) Execute the dot command with given input and output stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDependencyGraphAction

public AbstractDependencyGraphAction()

Method Detail

doContextMenu

public jenkins.model.ModelObjectWithContextMenu.ContextMenu doContextMenu(org.kohsuke.stapler.StaplerRequest request,
                                                                          org.kohsuke.stapler.StaplerResponse response)

This method is called via AJAX to obtain the context menu for this model object, but we don't have one...

Parameters:

request - StaplerRequest

response - StaplerResponse

Returns:

the ContextMenu we dont thave any

doEdge

public void doEdge(org.kohsuke.stapler.StaplerRequest req,
                   org.kohsuke.stapler.StaplerResponse rsp)
            throws IOException,
                   javax.servlet.ServletException,
                   InterruptedException

Throws:

IOException

javax.servlet.ServletException

InterruptedException

doDynamic

public void doDynamic(org.kohsuke.stapler.StaplerRequest req,
                      org.kohsuke.stapler.StaplerResponse rsp)
               throws IOException,
                      javax.servlet.ServletException

graph.{png,gv,...} is mapped to the corresponding output

Parameters:

req - StaplerRequest

rsp - StaplerResponse

Throws:

IOException - if dot fails

javax.servlet.ServletException - for other errors

runDot

protected void runDot(OutputStream output,
                      InputStream input,
                      String type)
               throws IOException

Execute the dot command with given input and output stream

Parameters:

type - the parameter for the -T option of the graphviz tools

input - the input stream to connect to dot execution

output - the output stream to connect to dot execution

Throws:

IOException - in case of dot execution errors

isGraphvizEnabled

public boolean isGraphvizEnabled()

isEditFunctionInJSViewEnabled

public boolean isEditFunctionInJSViewEnabled()

getProjectNameStripRegex

public String getProjectNameStripRegex()

getProjectNameStripRegexGroup

public int getProjectNameStripRegexGroup()

getProjectsForDepgraph

protected abstract Collection<? extends hudson.model.Job<?,?>> getProjectsForDepgraph()

Returns:

projects for which the dependency graph should be calculated

getTitle

public abstract String getTitle()

Returns:

title of the dependency graph page

getParentObject

public abstract hudson.model.AbstractModelObject getParentObject()

Returns:

object for which the sidepanel.jelly will be shown

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action