de.codecentric.jenkins.dashboard

Class DashboardView

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.View

de.codecentric.jenkins.dashboard.DashboardView

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.View>, hudson.model.ModelObject, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.ModelObjectWithChildren

public class DashboardView
extends hudson.model.View

Central class for the dashboard view. When adding a new view to Jenkins page, this DashboardView will appear. Each time this view is loaded, this class will be called.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.View

hudson.model.View.AsynchPeople, hudson.model.View.People, hudson.model.View.PropertyList, hudson.model.View.UserInfo

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static DashboardViewDescriptor	DESCRIPTOR
static String	PARAM_AWS_KEY
static String	PARAM_EC2_REGION
static String	PARAM_ENVIRONMENT
static String	PARAM_VERSION

Fields inherited from class hudson.model.View

CONFIGURE, CREATE, DELETE, description, filterExecutors, filterQueue, LIST, name, NEW_PRONOUN, owner, PERMISSIONS, READ, SORTER, transientActions

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DashboardView(String name)
DashboardView(String name, boolean showDeployField, String groupId, String artefactId, List<Environment> environments)
DashboardView(String name, hudson.model.ViewGroup owner)

Method Summary

Modifier and Type	Method and Description
boolean	contains(hudson.model.TopLevelItem item) Checks if the job is in this collection.
String	deploy(String version, String environment)
hudson.model.Item	doCreateItem(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Creates a new Item in this collection.
String	getArtefactId()
List<Artifact>	getArtifacts()
hudson.model.ViewDescriptor	getDescriptor()
String	getDisplayDeployField()
List<Environment>	getEnvironments()
String	getGroupId()
Collection<hudson.model.TopLevelItem>	getItems() Gets all the items in this collection in a read-only view.
List<ServerEnvironment>	getMatchingEC2Environments()
boolean	getShowDeployField()
void	setArtefactId(String artefactId)
void	setEnvironments(List<Environment> environmentsList)
void	setGroupId(String groupId)
void	setShowDeployField(boolean showDeployField)
protected void	submit(org.kohsuke.stapler.StaplerRequest req) Handles the configuration submission.

Methods inherited from class hudson.model.View

all, allInstantiable, checkPermission, create, createViewFromXML, doChildrenContextMenu, doConfigDotXml, doConfigSubmit, doDoDelete, doRssAll, doRssFailed, doRssLatest, doSubmitDescription, getAbsoluteUrl, getACL, getActions, getAllItems, getAllProperties, getApi, getApplicablePropertyDescriptors, getApproximateQueueItemsQuickly, getAsynchPeople, getBuilds, getColumns, getComputers, getDescription, getDisplayName, getDynamic, getIndenter, getItem, getItemCreatePermission, getJob, getNewPronoun, getOwner, getOwnerItemGroup, getOwnerPrimaryView, getOwnerViewActions, getPeople, getPostConstructLandingPage, getProperties, getQueueItems, getSearchUrl, getTimeline, getUrl, getViewName, getViewUrl, getWidgets, hasPeople, hasPermission, isAutomaticRefreshEnabled, isDefault, isEditable, isFilterExecutors, isFilterQueue, makeSearchIndex, onJobRenamed, rename, save, toString, updateByXml, updateTransientActions, writeXml

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

@Extension
public static final DashboardViewDescriptor DESCRIPTOR

PARAM_VERSION

public static final String PARAM_VERSION

See Also:

Constant Field Values

PARAM_ENVIRONMENT

public static final String PARAM_ENVIRONMENT

See Also:

Constant Field Values

PARAM_EC2_REGION

public static final String PARAM_EC2_REGION

See Also:

Constant Field Values

PARAM_AWS_KEY

public static final String PARAM_AWS_KEY

See Also:

Constant Field Values

Constructor Detail

DashboardView

public DashboardView(String name)

DashboardView

public DashboardView(String name,
                     hudson.model.ViewGroup owner)

DashboardView

@DataBoundConstructor
public DashboardView(String name,
                                           boolean showDeployField,
                                           String groupId,
                                           String artefactId,
                                           List<Environment> environments)

Method Detail

getDescriptor

public hudson.model.ViewDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.model.View>

Overrides:

getDescriptor in class hudson.model.View

getItems

public Collection<hudson.model.TopLevelItem> getItems()

Gets all the items in this collection in a read-only view.

Specified by:

getItems in class hudson.model.View

contains

public boolean contains(hudson.model.TopLevelItem item)

Checks if the job is in this collection.

Specified by:

contains in class hudson.model.View

deploy

@JavaScriptMethod
public String deploy(String version,
                                       String environment)

submit

protected void submit(org.kohsuke.stapler.StaplerRequest req)
               throws IOException,
                      javax.servlet.ServletException,
                      hudson.model.Descriptor.FormException

Handles the configuration submission. Load view-specific properties here.

Specified by:

submit in class hudson.model.View

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

doCreateItem

public hudson.model.Item doCreateItem(org.kohsuke.stapler.StaplerRequest req,
                                      org.kohsuke.stapler.StaplerResponse rsp)
                               throws IOException,
                                      javax.servlet.ServletException

Creates a new Item in this collection. This method should call ModifiableItemGroup.doCreateItem(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse) and then add the newly created item to this view.

Specified by:

doCreateItem in class hudson.model.View

Returns:

null if it fails

Throws:

IOException

javax.servlet.ServletException

getDisplayDeployField

public String getDisplayDeployField()

getShowDeployField

public boolean getShowDeployField()

setShowDeployField

public void setShowDeployField(boolean showDeployField)

getArtefactId

public String getArtefactId()

setArtefactId

public void setArtefactId(String artefactId)

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

getArtifacts

public List<Artifact> getArtifacts()

getMatchingEC2Environments

public List<ServerEnvironment> getMatchingEC2Environments()

getEnvironments

public List<Environment> getEnvironments()

setEnvironments

public void setEnvironments(List<Environment> environmentsList)