Package com.hello2morrow.sonargraph.integration.jenkins.controller

Class SonargraphIntegrationAction

java.lang.Object

com.hello2morrow.sonargraph.integration.jenkins.controller.SonargraphIntegrationAction

All Implemented Interfaces:

Action, ModelObject, ProminentProjectAction

public class SonargraphIntegrationAction
extends Object
implements ProminentProjectAction

This object is the responsible of managing the action that will take the user to see the graphs generated by sonargraph.

Author:

esteban

Constructor Summary

Constructors

Constructor	Description
SonargraphIntegrationAction(Job<?,?> job, List<String> selectedMetrics, MetricIds metricMetaData)

Method Summary

Modifier and Type	Method	Description
void	doGetPlot(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Method that generates the chart and adds it to the response object to allow jenkins to display it.
Collection<String>	getChartsForMetrics()
String	getDiffURL()	Diff URL is used as html href for "Show most recent Sonargraph Diff" in SonargraphIntegrationAction/index.jelly.
String	getDisplayName()	Name of the link for this action
String	getIconFileName()	Icon that will appear next to the link defined by this action.
Job<?,?>	getJob()
String	getReportURL()	Report URL is used as html href for "Show most recent Sonargraph Report" in SonargraphIntegrationAction/index.jelly.
String	getUrlName()	Last segment of the url that will lead to this action.

Methods inherited from class java.lang.Object

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

Constructor Details

SonargraphIntegrationAction

public SonargraphIntegrationAction(Job<?,?> job,
 List<String> selectedMetrics,
 MetricIds metricMetaData)

Method Details

getChartsForMetrics

public Collection<String> getChartsForMetrics()

doGetPlot

public void doGetPlot(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)

Method that generates the chart and adds it to the response object to allow jenkins to display it. It is called in SonargraphChartAction/index.jelly in the src attribute of an img tag.

getJob

public Job<?,?> getJob()

getIconFileName

public String getIconFileName()

Icon that will appear next to the link defined by this action.

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Name of the link for this action

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Last segment of the url that will lead to this action. e.g https://localhost:8080/jobName/sonargraph

Specified by:

getUrlName in interface Action

getReportURL

public String getReportURL()

Report URL is used as html href for "Show most recent Sonargraph Report" in SonargraphIntegrationAction/index.jelly. Depends on global Jenkins URL being set correctly in Jenkins. Otherwise a relative path is used, which may work or not.

Returns:

the absolute or relative url/path for the most recent sonargraph report.

getDiffURL

public String getDiffURL()

Diff URL is used as html href for "Show most recent Sonargraph Diff" in SonargraphIntegrationAction/index.jelly. Depends on global Jenkins URL being set correctly in Jenkins. Otherwise a relative path is used, which may work or not.

Returns:

the absolute or relative url/path for the most recent sonargraph diff.