hudson.plugins.nested_view

Class NestedView

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.View

hudson.plugins.nested_view.NestedView

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.View>, hudson.model.ModelObject, hudson.model.Saveable, hudson.model.ViewGroup, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, jenkins.model.ModelObjectWithChildren, jenkins.model.ModelObjectWithContextMenu, org.kohsuke.stapler.StaplerProxy

public class NestedView
extends hudson.model.View
implements hudson.model.ViewGroup, org.kohsuke.stapler.StaplerProxy, jenkins.model.ModelObjectWithContextMenu

View type that contains only another set of views. Allows grouping job views into multiple levels instead of one big list of tabs.

Author:

Alan Harder, Kohsuke Kawaguchi, Romain Seguy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NestedView.DefaultViewProxy
static class	NestedView.DescriptorImpl
static class	NestedView.HealthReportContainer Container for HealthReport with two methods matching hudson.model.Job so we can pass this to f:healthReport jelly.

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 jenkins.model.ModelObjectWithContextMenu

jenkins.model.ModelObjectWithContextMenu.ContextMenu, jenkins.model.ModelObjectWithContextMenu.MenuItem

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, NEW_PRONOUN, owner, PERMISSIONS, READ, SORTER, transientActions

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
NestedView(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDelete(hudson.model.View view)
boolean	contains(hudson.model.TopLevelItem item)
void	deleteView(hudson.model.View view)
hudson.util.FormValidation	doCheckViewName(String value) Checks if a nested view with the given name exists and make sure that the name is good as a view name.
jenkins.model.ModelObjectWithContextMenu.ContextMenu	doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)
jenkins.model.ModelObjectWithContextMenu.ContextMenu	doContextMenu(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)
hudson.model.Item	doCreateItem(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doCreateView(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
hudson.util.FormValidation	doViewExistsCheck(String value) Checks if a nested view with the given name exists.
NestedViewColumns	getColumnsToShow()
hudson.model.View	getDefaultView()
NestedView.HealthReportContainer	getHealth() Returns the health of this nested view.
hudson.model.ItemGroup<? extends hudson.model.TopLevelItem>	getItemGroup()
List<hudson.model.TopLevelItem>	getItems()
hudson.model.View	getPrimaryView()
Object	getTarget()
String	getUrl()
hudson.model.View	getView(String name)
List<hudson.model.Action>	getViewActions()
static NestedView.HealthReportContainer	getViewHealth(hudson.model.View v) Returns the health of a view, wether it is a normal or a nested one.
Collection<hudson.model.View>	getViews()
hudson.views.ViewsTabBar	getViewsTabBar()
hudson.model.Result	getWorstResult() Returns the worst result for this nested view.
static hudson.model.Result	getWorstResult(hudson.model.View v) Returns the worst result for a view, wether is a normal view or a nested one.
void	onJobRenamed(hudson.model.Item item, String oldName, String newName)
void	onViewRenamed(hudson.model.View view, String oldName, String newName)
void	save()
protected void	submit(org.kohsuke.stapler.StaplerRequest req)

Methods inherited from class hudson.model.View

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

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

Methods inherited from interface hudson.security.AccessControlled

checkPermission, getACL, hasPermission

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Constructor Detail

NestedView

@DataBoundConstructor
public NestedView(String name)

Method Detail

getItems

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

Specified by:

getItems in class hudson.model.View

contains

public boolean contains(hudson.model.TopLevelItem item)

Specified by:

contains in class hudson.model.View

doContextMenu

public jenkins.model.ModelObjectWithContextMenu.ContextMenu doContextMenu(org.kohsuke.stapler.StaplerRequest request,
                                                                 org.kohsuke.stapler.StaplerResponse response)
                                                                   throws IOException,
                                                                          org.apache.commons.jelly.JellyException

Specified by:

doContextMenu in interface jenkins.model.ModelObjectWithContextMenu

Throws:

IOException

org.apache.commons.jelly.JellyException

doChildrenContextMenu

public jenkins.model.ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest request,
                                                                         org.kohsuke.stapler.StaplerResponse response)
                                                                           throws Exception

Specified by:

doChildrenContextMenu in interface jenkins.model.ModelObjectWithChildren

Overrides:

doChildrenContextMenu in class hudson.model.View

Throws:

Exception

getUrl

public String getUrl()

Specified by:

getUrl in interface hudson.model.ViewGroup

Overrides:

getUrl in class hudson.model.View

getPrimaryView

public hudson.model.View getPrimaryView()

Specified by:

getPrimaryView in interface hudson.model.ViewGroup

getItemGroup

public hudson.model.ItemGroup<? extends hudson.model.TopLevelItem> getItemGroup()

Specified by:

getItemGroup in interface hudson.model.ViewGroup

getViewActions

public List<hudson.model.Action> getViewActions()

Specified by:

getViewActions in interface hudson.model.ViewGroup

doCreateItem

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

Specified by:

doCreateItem in class hudson.model.View

Throws:

IOException

javax.servlet.ServletException

doCheckViewName

public hudson.util.FormValidation doCheckViewName(@QueryParameter
                                         String value)

Checks if a nested view with the given name exists and make sure that the name is good as a view name.

doViewExistsCheck

public hudson.util.FormValidation doViewExistsCheck(@QueryParameter
                                           String value)

Checks if a nested view with the given name exists.

onJobRenamed

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

Specified by:

onJobRenamed in class hudson.model.View

submit

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

Specified by:

submit in class hudson.model.View

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

canDelete

public boolean canDelete(hudson.model.View view)

Specified by:

canDelete in interface hudson.model.ViewGroup

deleteView

public void deleteView(hudson.model.View view)
                throws IOException

Specified by:

deleteView in interface hudson.model.ViewGroup

Throws:

IOException

getViews

@Exported
public Collection<hudson.model.View> getViews()

Specified by:

getViews in interface hudson.model.ViewGroup

getView

public hudson.model.View getView(String name)

Specified by:

getView in interface hudson.model.ViewGroup

getDefaultView

public hudson.model.View getDefaultView()

getColumnsToShow

public NestedViewColumns getColumnsToShow()

onViewRenamed

public void onViewRenamed(hudson.model.View view,
                 String oldName,
                 String newName)

Specified by:

onViewRenamed in interface hudson.model.ViewGroup

save

public void save()
          throws IOException

Specified by:

save in interface hudson.model.Saveable

Overrides:

save in class hudson.model.View

Throws:

IOException

doCreateView

public void doCreateView(org.kohsuke.stapler.StaplerRequest req,
                org.kohsuke.stapler.StaplerResponse rsp)
                  throws IOException,
                         javax.servlet.ServletException,
                         hudson.model.Descriptor.FormException

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

getWorstResult

public hudson.model.Result getWorstResult()

Returns the worst result for this nested view.

To get the worst result, this method browses all the jobs this view contains. Also, as soon as it finds the worst result possible (cf. WORST_RESULT), the browsing stops.

The algorithm first analyzes normal views (that is, views which are not nested ones); Then, in a second time, it processes nested views, hoping that WORST_RESULT will be found as quick as possible, as mentionned previously.

getWorstResult

public static hudson.model.Result getWorstResult(hudson.model.View v)

Returns the worst result for a view, wether is a normal view or a nested one.

See Also:

getWorstResult(), getWorstResultForNormalView(hudson.model.View)

getHealth

public NestedView.HealthReportContainer getHealth()

Returns the health of this nested view.

Notice that, if a job is contained in several sub-views of the current view, then it is taken into account only once to get accurate stats.

This algorithm has been derecursified, hence the stack stuff.

getViewHealth

public static NestedView.HealthReportContainer getViewHealth(hudson.model.View v)

Returns the health of a view, wether it is a normal or a nested one.

See Also:

getHealth(), getHealthForNormalView(hudson.model.View)

getViewsTabBar

public hudson.views.ViewsTabBar getViewsTabBar()

Specified by:

getViewsTabBar in interface hudson.model.ViewGroup

getTarget

public Object getTarget()

Specified by:

getTarget in interface org.kohsuke.stapler.StaplerProxy