org.jenkinsci.plugins.rundeck

Class RundeckJobProjectLinkerAction

java.lang.Object

org.jenkinsci.plugins.rundeck.RundeckJobProjectLinkerAction

All Implemented Interfaces:

Action, ModelObject

public class RundeckJobProjectLinkerAction
extends Object
implements Action

Action used to display a Rundeck icon with a link to the Rundeck job page, and some information about the Rundeck job, on the Jenkins job page.

Author:

Vincent Behar

Constructor Summary

Constructors

Constructor and Description
RundeckJobProjectLinkerAction(String rundeckInstanceName, RundeckManager rundeck, String rundeckJobId) Load the Rundeck job details (name, description, and so on) using the Rundeck API.

Method Summary

Modifier and Type	Method and Description
String	getDisplayName()
String	getIconFileName()
String	getInstanceName()
org.rundeck.client.api.model.JobItem	getRundeckJob()
String	getUrlName()

Methods inherited from class java.lang.Object

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

Constructor Detail

RundeckJobProjectLinkerAction

public RundeckJobProjectLinkerAction(String rundeckInstanceName,
                                     RundeckManager rundeck,
                                     String rundeckJobId)
                              throws Exception,
                                     IllegalArgumentException

Load the Rundeck job details (name, description, and so on) using the Rundeck API.

Parameters:

rundeckInstanceName - Rundeck instance name

rundeck - client used for talking to the Rundeck API

rundeckJobId - ID of the Rundeck job

Throws:

Exception - in case of error while loading the job details from Rundeck API

IllegalArgumentException - if rundeck or rundeckJobId is null

Method Detail

getRundeckJob

@Exported
public org.rundeck.client.api.model.JobItem getRundeckJob()

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getInstanceName

public String getInstanceName()