org.kohsuke.stapler.bind.JavaScriptMethod Java Examples

/**
 * Returns the UI model for an ECharts line chart that shows the issues stacked by severity.
 *
 * @return the UI model as JSON
 */
@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
public String getBuildTrendModel() {
    SeverityTrendChart severityChart = new SeverityTrendChart();

    List<Iterable<? extends BuildResult<AnalysisBuildResult>>> histories = jobs.stream()
            .filter(job -> job.getLastCompletedBuild() != null)
            .map(Job::getLastCompletedBuild)
            .flatMap(build -> build.getActions(ResultAction.class)
                    .stream()
                    .filter(createToolFilter(selectTools, tools)))
            .map(ResultAction::createBuildHistory).collect(Collectors.toList());

    return new JacksonFacade().toJson(
            severityChart.aggregate(histories, new ChartModelConfiguration(AxisType.DATE)));
}
 

/**
 * Resets the quality gate for the owner of this view.
 *
 * @return unused string (since Firefox requires that Ajax calls return something)
 */
@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
public String resetReference() {
    RESET_QUALITY_GATE_COMMAND.execute(owner, labelProvider.getId());

    return "{}";
}
 

@JavaScriptMethod
public boolean startOperation(String viewName) {
	try {
		convertXmlToDSL(viewName);
		saveDSLtoFile();
		return true;
	} catch (IOException iosException) {
		error = "Error getting XML configuration of the job: " + iosException.getLocalizedMessage() + ": " + selectedItems.get(0).getConfigFile().getFile().getParentFile().getParentFile().getParentFile().getAbsolutePath() + File.separator + "userContent" + File.separator + File.separator + DSL_GROOVY;
	} catch (SAXException | ParserConfigurationException xmlException) {
		error = "Error parsing XML configuration of the job to DSL";
	}
	return false;
}
 

/**
 * Empty method as workaround for Stapler bug: JavaScript method in target object is not found.
 *
 * @return unused string (since Firefox requires that Ajax calls return something)
 */
@JavaScriptMethod
@SuppressWarnings("unused")
public String resetReference() {
    // Empty method as workaround for Stapler bug that does not find JavaScript proxy methods in target object IssueDetail
    return "{}";
}
 

@JavaScriptMethod
@Override
public String getBuildTrendModel() {
    return new JacksonFacade().toJson(createChartModel());
}
 

@JavaScriptMethod
public String getNonTranslatedTags() {
	return nonTranslatedTags;
}
 

@JavaScriptMethod
public String getParsedItems() {
	return formatString(parsedItems);
}
 

@JavaScriptMethod
public void remove(int jobIndex) {
	remove(allItems.get(jobIndex));
}
 

@JavaScriptMethod
public void add(int jobIndex) {
	add(allItems.get(jobIndex));
}
 

@JavaScriptMethod
public int getNumberOfSelectedJobs() {
	return selectedItems.size();
}
 

@JavaScriptMethod
public int getNumberOfJobs() {
	return allItems.size();
}
 

@JavaScriptMethod
public String getError() {
	return error;
}
 

@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
@Override
public String getBuildTrendModel() {
    return new JacksonFacade().toJson(createChartModel());
}
 

@JavaScriptMethod
public String getDslFilePath() {
	return dslFilePath;
}
 

@JavaScriptMethod
public String deploy(String version, String environment) {
    LOGGER.info("Deploy version " + version + " to environment " + environment);

    // Get the environment with corresponding build-job
    Environment buildEnvironment = null;
    for (Environment env : environments) {
        if (env.getAwsInstance().equals(environment)) {
            buildEnvironment = env;
            break;
        }
    }

    final AbstractProject buildJob = Jenkins.getInstance().getItemByFullName(buildEnvironment.getBuildJob(), AbstractProject.class);
    LOGGER.info("Executing job: " + buildJob);

    if (buildJob == null) {
        return String.format(Messages.DashboardView_buildJobNotFound(), buildEnvironment.getName());
    }

    if ((!buildJob.isBuildable()) || (!buildJob.isParameterized())) {
        return Messages.DashboardView_deploymentCannotBeExecuted();
    }

    final ParametersAction versionParam = new ParametersAction(new StringParameterValue(PARAM_VERSION, version));
    final ParametersAction environmentParam = new ParametersAction(new StringParameterValue(PARAM_ENVIRONMENT, environment));
    final ParametersAction ec2RegionParam = new ParametersAction(new StringParameterValue(PARAM_EC2_REGION, environment));
    final ParametersAction awsKeyParam = new ParametersAction(new StringParameterValue(PARAM_AWS_KEY, environment));

    List<ParametersAction> actions = Arrays.asList(versionParam, environmentParam, ec2RegionParam, awsKeyParam);
    QueueTaskFuture<AbstractBuild> scheduledBuild = buildJob.scheduleBuild2(2, new Cause.UserIdCause(), actions);

    Result result = Result.FAILURE;
    try {
        AbstractBuild finishedBuild = scheduledBuild.get();
        result = finishedBuild.getResult();
        LOGGER.info("Build finished with result: " + result + " completed in: " + finishedBuild.getDurationString() + ". ");
    } catch (Exception e) {
        LOGGER.severe("Error while waiting for build " + scheduledBuild.toString() + ".");
        LOGGER.severe(e.getMessage());
        LOGGER.severe(ExceptionUtils.getFullStackTrace(e));
        return String.format(Messages.DashboardView_buildJobFailed(), buildJob.getName());
    }
    if (result == Result.SUCCESS) {
        return String.format(Messages.DashboardView_buildJobScheduledSuccessfully(), buildJob.getName());
    }
    return String.format(Messages.DashboardView_buildJobSchedulingFailed(), buildJob.getName());
}
 

/**
 * Returns the UI model for an ECharts doughnut chart that shows the new, fixed, and outstanding issues.
 *
 * @return the UI model as JSON
 */
@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
public String getTrendModel() {
    return JACKSON_FACADE.toJson(new NewVersusFixedPieChart().create(newIssues, outstandingIssues, fixedIssues));
}
 

/**
 * Returns the UI model for an ECharts doughnut chart that shows the severities.
 *
 * @return the UI model as JSON
 */
@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
public String getSeverityModel() {
    return JACKSON_FACADE.toJson(new SeverityPieChart().create(report));
}
 

/**
 * Because of how org.kohsuke.stapler.HttpResponseRenderer is implemented
 * it can only work with net.sf.JSONObject in order to produce correct application/json output
 *
 * @return Json representation of JobViews
 * @throws Exception
 */
@JavaScriptMethod
public JSONObject fetchJobViews() throws Exception {
    return Respond.withSuccess(jobViews());
}
 

/**
 * Returns the UI model for an ECharts line chart that shows the issues stacked by severity.
 *
 * @return the UI model as JSON
 * @deprecated replaced by {@link #getBuildTrendModel()} which is called from JS file
 */
@JavaScriptMethod @Deprecated @SuppressWarnings("unused") // Called by jelly view
public String getTrend() {
    return getBuildTrendModel();
}
 

/**
 * Returns the UI model for an ECharts line chart that shows the issues by tool.
 *
 * @param isBuildOnXAxis
 *         determines whether the Jenkins build number should be used on the X-axis or the date
 *
 * @return the UI model as JSON
 */
@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
public String getHealthTrend(final boolean isBuildOnXAxis) {
    return createTrendAsJson(new HealthTrendChart(healthDescriptor), isBuildOnXAxis);
}
 

/**
 * Returns the UI model for an ECharts line chart that shows the new and fixed issues.
 *
 * @param isBuildOnXAxis
 *         determines whether the Jenkins build number should be used on the X-axis or the date
 *
 * @return the UI model as JSON
 */
@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
public String getNewVersusFixedTrend(final boolean isBuildOnXAxis) {
    return createTrendAsJson(new NewVersusFixedTrendChart(), isBuildOnXAxis);
}
 

/**
 * Returns the UI model for an ECharts line chart that shows the issues by tool.
 *
 * @param isBuildOnXAxis
 *         determines whether the Jenkins build number should be used on the X-axis or the date
 *
 * @return the UI model as JSON
 */
@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
public String getToolsTrend(final boolean isBuildOnXAxis) {
    return createTrendAsJson(new ToolsTrendChart(), isBuildOnXAxis);
}
 

/**
 * Returns the UI model for an ECharts line chart that shows the issues stacked by severity.
 *
 * @param isBuildOnXAxis
 *         determines whether the Jenkins build number should be used on the X-axis or the date
 *
 * @return the UI model as JSON
 */
@JavaScriptMethod
@SuppressWarnings("unused") // Called by jelly view
public String getBuildTrend(final boolean isBuildOnXAxis) {
    return createTrendAsJson(new SeverityTrendChart(), isBuildOnXAxis);
}