Package com.synopsys.arc.jenkinsci.plugins.dynamic_search.views

Class SimpleSearchView

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.View

hudson.model.ListView

com.synopsys.arc.jenkinsci.plugins.dynamic_search.views.SimpleSearchView

All Implemented Interfaces:

ExtensionPoint, Describable<View>, DescriptorByNameOwner, DirectlyModifiableView, ModelObject, Saveable, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithChildren

public class SimpleSearchView
extends ListView

List View with dynamic filters. The class is being displayed as a "Dynamic Search View" in Jenkins UI, but we keep the original class name in order to maintain the backward compatibility. Class uses internal storage to pass parameters between pages.

Author:

Oleg Nenashev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleSearchView.DescriptorImpl

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

ListView.Listener

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

View.AsynchPeople, View.People, View.PropertyList, View.UserInfo

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static VersionNumber	MINIMAL_AUTOREFRESH_VERSION	A minimal version, where views can disable the automatic refresh.

Fields inherited from class hudson.model.View

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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
SimpleSearchView(String name)

Method Summary

Modifier and Type	Method	Description
String	cleanCache()	Cleans internal cache of JSON Objects for the session.
void	doSearchSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
JobsFilter	getDefaultFilters()	Gets default search options for UI.
String	getDefaultIncludeRegex()
DescribableList<ViewJobFilter,Descriptor<ViewJobFilter>>	getDefaultJobFilters()
JobsFilter	getFilters()	Retrieves view filters for the user.
List<TopLevelItem>	getItems()
Search	getSearch()
static String	getSessionId()	Gets identifier of the current session.
boolean	hasConfiguredFilters()
boolean	hasUserJobFilterExtensions()
boolean	isAutomaticRefreshEnabled()	An override for future versions (since 1.557).
protected Object	readResolve()
void	setDefaultIncludeRegex(String regex)
protected void	submit(org.kohsuke.stapler.StaplerRequest req)
void	updateSearchCache(JobsFilter filter)

Methods inherited from class hudson.model.ListView

add, contains, doAddJobToView, doCreateItem, doRemoveJobFromView, getColumns, getDefaultColumns, getIncludeRegex, getJobFilters, getJobNames, getStatusFilter, hasJobFilterExtensions, initColumns, initJobFilters, isAddToCurrentView, isRecurse, jobNamesContains, makeSearchIndex, remove, setColumns, setIncludeRegex, setJobFilters, setJobNames, setRecurse, setStatusFilter

Methods inherited from class hudson.model.View

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

Methods inherited from class hudson.model.AbstractModelObject

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

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Field Detail

MINIMAL_AUTOREFRESH_VERSION

public static final VersionNumber MINIMAL_AUTOREFRESH_VERSION

A minimal version, where views can disable the automatic refresh.

Since:

0.2.1

Constructor Detail

SimpleSearchView

@DataBoundConstructor
public SimpleSearchView(String name)

Method Detail

readResolve

protected Object readResolve()

Overrides:

readResolve in class ListView

getDefaultIncludeRegex

@CheckForNull
public String getDefaultIncludeRegex()

getDefaultJobFilters

@CheckForNull
public DescribableList<ViewJobFilter,Descriptor<ViewJobFilter>> getDefaultJobFilters()

submit

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

Overrides:

submit in class ListView

Throws:

javax.servlet.ServletException

Descriptor.FormException

IOException

getSessionId

public static String getSessionId()

Gets identifier of the current session.

Returns:

Unique id of the current session.

getSearch

public Search getSearch()

Specified by:

getSearch in interface SearchableModelObject

Overrides:

getSearch in class AbstractModelObject

hasConfiguredFilters

public boolean hasConfiguredFilters()

getFilters

public JobsFilter getFilters()

Retrieves view filters for the user.

Returns:

View filters from the session if it is available. Otherwise, default filters will be returned.

getDefaultFilters

@Nonnull
public JobsFilter getDefaultFilters()

Gets default search options for UI.

Returns:

a default set of filters.

Since:

0.2

isAutomaticRefreshEnabled

public boolean isAutomaticRefreshEnabled()

An override for future versions (since 1.557).

Overrides:

isAutomaticRefreshEnabled in class View

Returns:

Always false

setDefaultIncludeRegex

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void setDefaultIncludeRegex(String regex)

cleanCache

public String cleanCache()

Cleans internal cache of JSON Objects for the session.

Returns:

Current Session Id

getItems

public List<TopLevelItem> getItems()

Overrides:

getItems in class ListView

doSearchSubmit

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@RestrictedSince("0.3.0")
public void doSearchSubmit(org.kohsuke.stapler.StaplerRequest req,
                           org.kohsuke.stapler.StaplerResponse rsp)
                    throws IOException,
                           UnsupportedEncodingException,
                           javax.servlet.ServletException,
                           Descriptor.FormException

Throws:

IOException

UnsupportedEncodingException

javax.servlet.ServletException

Descriptor.FormException

updateSearchCache

public void updateSearchCache(JobsFilter filter)

hasUserJobFilterExtensions

public boolean hasUserJobFilterExtensions()