hudson.plugins.view.dashboard
Class Dashboard

java.lang.Object
  hudson.model.AbstractModelObject
      hudson.model.View
          hudson.plugins.view.dashboard.Dashboard

All Implemented Interfaces:

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

public class Dashboard
extends hudson.model.View

View that can be customized with portlets to show the selected jobs information in various ways.

Author:

Peter Hayes

Nested Class Summary

static class

Dashboard.DescriptorImpl

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

hudson.model.View.People, hudson.model.View.UserInfo

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.View

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

Constructor Summary

Dashboard(java.lang.String name)

Method Summary

boolean	contains(hudson.model.TopLevelItem item)
hudson.model.Item	doCreateItem(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
java.util.List<hudson.model.Descriptor<DashboardPortlet>>	getDashboardPortletDescriptors()
java.lang.String	getIncludeRegex()
java.util.List<hudson.model.TopLevelItem>	getItems() Returns a read-only view of all Jobs in this view.
java.util.List<hudson.model.Job>	getJobs()
java.util.List<DashboardPortlet>	getLeftPortlets()
DashboardPortlet	getPortlet(java.lang.String name)
java.util.List<DashboardPortlet>	getRightPortlets()
java.util.List<DashboardPortlet>	getTopPortlets()
boolean	isExcludeDisabledJobs()
boolean	isIncludeStdJobList()
void	onJobRenamed(hudson.model.Item item, java.lang.String oldName, java.lang.String newName)
protected void	submit(org.kohsuke.stapler.StaplerRequest req)

Methods inherited from class hudson.model.View

all, checkPermission, create, doConfigSubmit, doDoDelete, doRssAll, doRssFailed, doRssLatest, doSubmitDescription, getAbsoluteUrl, getACL, getActions, getApi, getBuilds, getComputers, getDescription, getDescriptor, getDisplayName, getItem, getItemCreatePermission, getJob, getOwner, getPeople, getPostConstructLandingPage, getQueueItems, getSearchUrl, getUrl, getViewName, getViewUrl, getWidgets, hasPeople, hasPermission, isDefault, isEditable, isFilterExecutors, isFilterQueue, makeSearchIndex, rename

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, toString, wait, wait, wait

Constructor Detail

Dashboard

@DataBoundConstructor
public Dashboard(java.lang.String name)

Method Detail

getIncludeRegex

public java.lang.String getIncludeRegex()

isExcludeDisabledJobs

public boolean isExcludeDisabledJobs()

isIncludeStdJobList

public boolean isIncludeStdJobList()

getLeftPortlets

public java.util.List<DashboardPortlet> getLeftPortlets()

getRightPortlets

public java.util.List<DashboardPortlet> getRightPortlets()

getTopPortlets

public java.util.List<DashboardPortlet> getTopPortlets()

getPortlet

public DashboardPortlet getPortlet(java.lang.String name)

getDashboardPortletDescriptors

public java.util.List<hudson.model.Descriptor<DashboardPortlet>> getDashboardPortletDescriptors()

contains

public boolean contains(hudson.model.TopLevelItem item)

Specified by:

contains in class hudson.model.View

doCreateItem

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

Specified by:

doCreateItem in class hudson.model.View

Throws:

java.io.IOException

javax.servlet.ServletException

getItems

public java.util.List<hudson.model.TopLevelItem> getItems()

Returns a read-only view of all Jobs in this view.

This method returns a separate copy each time to avoid concurrent modification issue.

Specified by:

getItems in class hudson.model.View

getJobs

public java.util.List<hudson.model.Job> getJobs()

onJobRenamed

public void onJobRenamed(hudson.model.Item item,
                         java.lang.String oldName,
                         java.lang.String newName)

Specified by:

onJobRenamed in class hudson.model.View

submit

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

Specified by:

submit in class hudson.model.View

Throws:

java.io.IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException