Jenkins (Jenkins core 2.316 API)

java.lang.Object
- hudson.model.AbstractModelObject
- - hudson.model.Node
  - - hudson.model.AbstractCIBase
    - - jenkins.model.Jenkins

All Implemented Interfaces:

ExtensionPoint, Describable<Node>, DescriptorByNameOwner, ItemGroup<TopLevelItem>, ModelObject, ModifiableItemGroup<TopLevelItem>, ModifiableViewGroup, PersistenceRoot, ReconfigurableDescribable<Node>, Saveable, ViewGroup, SearchableModelObject, SearchItem, AccessControlled, DirectlyModifiableTopLevelItemGroup, ModelObjectWithChildren, ModelObjectWithContextMenu, ModifiableTopLevelItemGroup, OnMaster, org.kohsuke.stapler.StaplerFallback, org.kohsuke.stapler.StaplerProxy

Direct Known Subclasses:

Hudson
```
@ExportedBean
public class Jenkins
extends AbstractCIBase
implements DirectlyModifiableTopLevelItemGroup, org.kohsuke.stapler.StaplerProxy, org.kohsuke.stapler.StaplerFallback, ModifiableViewGroup, AccessControlled, DescriptorByNameOwner, ModelObjectWithContextMenu, ModelObjectWithChildren, OnMaster
```
Root object of the system.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Jenkins.CloudList`
`static class`	`Jenkins.DescriptorImpl`
`static class`	`Jenkins.EnforceSlaveAgentPortAdministrativeMonitor`
`static interface`	`Jenkins.JenkinsHolder` Hook for a test harness to intercept Jenkins.get() Do not use in the production code as the signature may change.
`static class`	`Jenkins.MasterComputer`
`static class`	`Jenkins.MasterRestartNotifyier`

Nested classes/interfaces inherited from class hudson.model.Node
Node.InternalComputerListener, Node.Mode

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu
ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem

Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields
Modifier and Type	Field and Description
`static Permission`	`ADMINISTER`
`List<AdministrativeMonitor>`	`administrativeMonitors` `AdministrativeMonitor`s installed on this system.
`static Set<String>`	`ALLOWED_RESOURCE_EXTENSIONS` Extension list that `doResources(StaplerRequest, StaplerResponse)` can serve.
`static Authentication`	`ANONYMOUS` Deprecated. use `ANONYMOUS2`
`static org.springframework.security.core.Authentication`	`ANONYMOUS2` `Authentication` object that represents the anonymous user.
`static boolean`	`AUTOMATIC_SLAVE_LAUNCH` Automatically try to launch an agent when Jenkins is initialized or a new agent computer is created.
`static String`	`CHANGELOG_URL`
`Hudson.CloudList`	`clouds` Active `Cloud`s.
`protected Map<Node,Computer>`	`computers` `Computer`s in this Jenkins system.
`static boolean`	`CONCURRENT_BUILD` Deprecated. as of 1.464 This flag will have no effect.
`static boolean`	`FLYWEIGHT_SUPPORT` Deprecated. No longer used.
`static boolean`	`KILL_AFTER_LOAD`
`static List<LogRecord>`	`logRecords` Live view of recent `LogRecord`s produced by Jenkins.
`Lookup`	`lookup` Stores various objects scoped to `Jenkins`.
`static Permission`	`MANAGE` This permission grants access to parts of the Jenkins system configuration.
`static Permission[]`	`MANAGE_AND_SYSTEM_READ`
`static String`	`NAME_VALIDATION_REJECTS_TRAILING_DOT_PROP` Name of the system property escape hatch for SECURITY-2424.
`OverallLoadStatistics`	`overallLoad` Load statistics of the entire system.
`NodeProvisioner`	`overallNodeProvisioner` Deprecated. as of 1.467 Use `unlabeledNodeProvisioner`. This was broken because it was tracking all the executors in the system, but it was only tracking free-roaming jobs in the queue. So `Cloud` fails to launch nodes when you have some exclusive agents and free-roaming jobs in the queue.
`static boolean`	`PARALLEL_LOAD`
`static PermissionGroup`	`PERMISSIONS`
`PluginManager`	`pluginManager` Loaded plugins.
`ProxyConfiguration`	`proxy` HTTP proxy configuration.
`static Permission`	`READ`
`static String`	`RESOURCE_PATH` Prefix to static resources like images and javascripts in the war file.
`File`	`root` Root directory of the system.
`static Permission`	`RUN_SCRIPTS` Deprecated. in Jenkins 2.222 use `ADMINISTER` instead
`javax.servlet.ServletContext`	`servletContext`
`static String`	`SESSION_HASH` Unique random token that identifies the current session.
`protected NodeList`	`slaves` Deprecated. in favour of `Nodes`
`static Permission`	`SYSTEM_READ` Allows read-only access to large parts of the system configuration.
`TcpSlaveAgentListener`	`tcpSlaveAgentListener`
`static String`	`UNCOMPUTED_VERSION` The version number before it is "computed" (by a call to computeVersion()).
`LoadStatistics`	`unlabeledLoad` Load statistics of the free roaming jobs and agents.
`NodeProvisioner`	`unlabeledNodeProvisioner` `NodeProvisioner` that reacts to `unlabeledLoad`.
`static String`	`VERSION` Version number of this Jenkins.
`static String`	`VERSION_HASH` Hash of `VERSION`.
`static String`	`VIEW_RESOURCE_PATH` Prefix to resources alongside view scripts.
`static com.thoughtworks.xstream.XStream`	`XSTREAM` Thread-safe reusable `XStream`.
`static XStream2`	`XSTREAM2` Alias to `XSTREAM` so that one can access additional methods on `XStream2` more easily.

Fields inherited from class hudson.model.AbstractCIBase
LOG_STARTUP_PERFORMANCE

Fields inherited from class hudson.model.Node
holdOffLaunchUntilSave, SKIP_BUILD_CHECK_ON_FLYWEIGHTS

Fields inherited from interface hudson.model.Saveable
NOOP

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jenkins(File root, javax.servlet.ServletContext context)`
`protected`	`Jenkins(File root, javax.servlet.ServletContext context, PluginManager pluginManager)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`_doScript(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, javax.servlet.RequestDispatcher view, hudson.remoting.VirtualChannel channel, ACL acl)`
`Fingerprint`	`_getFingerprint(String md5sum)` Gets a `Fingerprint` object if it exists.
`<I extends TopLevelItem> I`	`add(I item, String name)` Adds an item to this group.
`void`	`addNode(Node n)` Adds one more `Node` to Jenkins.
`void`	`addView(View v)` Add new `View` to this `ViewGroup`.
`boolean`	`canAdd(TopLevelItem item)` Returns true if a particular item may be added to this group.
`boolean`	`canDelete(View view)` Determine whether a view may be deleted.
`static void`	`checkGoodName(String name)` Check if the given name is suitable as a name for job, view, etc.
`void`	`cleanUp()` Called to shut down the system.
`<T extends AbstractProject<?,?>> T`	`copy(T src, String name)`
`<T extends TopLevelItem> T`	`copy(T src, String name)` Copies a job.
`Computer`	`createComputer()` Creates a new `Computer` object that acts as the UI peer of this `Node`.
`Launcher`	`createLauncher(TaskListener listener)` Returns a `Launcher` for executing programs on this node.
`FilePath`	`createPath(String absolutePath)` Gets the `FilePath` on this node.
`<T extends TopLevelItem> T`	`createProject(Class<T> type, String name)` Creates a new job.
`TopLevelItem`	`createProject(TopLevelItemDescriptor type, String name)`
`TopLevelItem`	`createProject(TopLevelItemDescriptor type, String name, boolean notify)` Creates a new job.
`TopLevelItem`	`createProjectFromXML(String name, InputStream xml)` Creates a new job from its configuration XML.
`void`	`deleteView(View view)` Deletes a view in this group.
`void`	`disableSecurity()`
`org.kohsuke.stapler.HttpRedirect`	`doCancelQuietDown()` Cancel previous quiet down Jenkins - preparation for a restart
`FormValidation`	`doCheckDisplayName(String displayName, String jobName)` Checks to see if the candidate displayName collides with any existing display names or project names
`FormValidation`	`doCheckURIEncoding(org.kohsuke.stapler.StaplerRequest request)` Deprecated.
`FormValidation`	`doCheckViewName(String value)` Checks if a top-level view with the given name exists and make sure that the name is good as a view name.
`ModelObjectWithContextMenu.ContextMenu`	`doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)` Generates the context menu to list up all the children.
`void`	`doClassicThreadDump(org.kohsuke.stapler.StaplerResponse rsp)` Backward compatibility.
`void`	`doConfigExecutorsSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Accepts submission from the node configuration page.
`void`	`doConfigSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Accepts submission from the configuration page.
`ModelObjectWithContextMenu.ContextMenu`	`doContextMenu(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)` Generates the context menu.
`TopLevelItem`	`doCreateItem(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` The request format follows that of `<n:form xmlns:n="/lib/form">`.
`void`	`doCreateView(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)`
`FormValidation`	`doDefaultJDKCheck(org.kohsuke.stapler.StaplerRequest request, String value)` If the user chose the default JDK, make sure we got 'java' in PATH.
`void`	`doDoFingerprintCheck(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Do a finger-print check.
`void`	`doEval(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Evaluates the Jelly script submitted by the client.
`void`	`doException()` End point that intentionally throws an exception to test the error behaviour.
`void`	`doExit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Shutdown the system.
`void`	`doFingerprintCleanup(org.kohsuke.stapler.StaplerResponse rsp)`
`void`	`doGc(org.kohsuke.stapler.StaplerResponse rsp)` For debugging.
`void`	`doIconSize(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Changes the icon size by changing the cookie
`Slave.JnlpJar`	`doJnlpJars(org.kohsuke.stapler.StaplerRequest req)`
`void`	`doLoginEntry(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Called once the user logs in.
`void`	`doLogout(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Logs out the user.
`org.kohsuke.stapler.HttpRedirect`	`doQuietDown()`
`org.kohsuke.stapler.HttpRedirect`	`doQuietDown(boolean block, int timeout)` Deprecated. since 2.267; use `doQuietDown(boolean, int, String)` instead.
`org.kohsuke.stapler.HttpRedirect`	`doQuietDown(boolean block, int timeout, String reason)` Quiet down Jenkins - preparation for a restart
`org.kohsuke.stapler.HttpResponse`	`doReload()` Reloads the configuration.
`void`	`doResources(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Serves static resources placed along with Jelly view files.
`void`	`doRestart(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Perform a restart of Jenkins, if we can.
`org.kohsuke.stapler.HttpResponse`	`doSafeExit(org.kohsuke.stapler.StaplerRequest req)` Shutdown the system safely.
`org.kohsuke.stapler.HttpResponse`	`doSafeRestart(org.kohsuke.stapler.StaplerRequest req)` Queues up a restart of Jenkins for when there are no builds running, if we can.
`void`	`doScript(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` For system diagnostics.
`void`	`doScriptText(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Run arbitrary Groovy script and return result as plain text.
`void`	`doSecured(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Checks if the user was successfully authenticated.
`void`	`doSignup(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Sign up for the user account.
`void`	`doSimulateOutOfMemory()` Simulates OutOfMemoryError.
`void`	`doSubmitDescription(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)` Accepts the new description.
`void`	`doTestPost(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)`
`org.kohsuke.stapler.HttpResponse`	`doToggleCollapse()`
`DirectoryBrowserSupport`	`doUserContent()` Binds /userContent/...
`FormValidation`	`doViewExistsCheck(String value)` Deprecated. 1.512
`void`	`doWorkspaceCleanup(org.kohsuke.stapler.StaplerResponse rsp)`
`static String`	`expandVariablesForDirectory(String base, String itemFullName, String itemRootDir)`
`static Jenkins`	`get()` Gets the `Jenkins` singleton.
`ACL`	`getACL()` Returns the root `ACL`.
`List<Action>`	`getActions()` Returns the transient `Action`s associated with the top page.
`List<AdministrativeMonitor>`	`getActiveAdministrativeMonitors()` Returns the enabled and activated administrative monitors accessible to the current user.
`static Jenkins`	`getActiveInstance()` Deprecated. This is a verbose historical alias for `get()`.
`org.kohsuke.stapler.framework.adjunct.AdjunctManager`	`getAdjuncts(String dummy)` Makes `AdjunctManager` URL-bound.
`AdministrativeMonitor`	`getAdministrativeMonitor(String id)` Binds `AdministrativeMonitor`s to URL.
`Set<String>`	`getAgentProtocols()` Returns the enabled agent protocols.
`Map<String,Map<String,String>>`	`getAllThreadDumps()` Obtains the thread dump of all agents (including the controller/built-in node.)
`Api`	`getApi()`
`View.AsynchPeople`	`getAsynchPeople()`
`static Authentication`	`getAuthentication()` Deprecated. use `getAuthentication2()`
`static org.springframework.security.core.Authentication`	`getAuthentication2()` Gets the `Authentication` object that represents the user associated with the current request.
`AuthorizationStrategy`	`getAuthorizationStrategy()`
`File`	`getBuildDirFor(Job job)`
`Descriptor<Builder>`	`getBuilder(String shortClassName)` Gets the builder descriptor by name.
`Descriptor<BuildWrapper>`	`getBuildWrapper(String shortClassName)` Gets the build wrapper descriptor by name.
`Map<ManagementLink.Category,List<ManagementLink>>`	`getCategorizedManagementLinks()`
`ClockDifference`	`getClockDifference()` Estimates the clock difference with this agent.
`hudson.remoting.Callable<ClockDifference,IOException>`	`getClockDifferenceCallable()` Returns a `Callable` that when run on the channel, estimates the clock difference.
`Cloud`	`getCloud(String name)` Gets a `Cloud` by `its name`, or null.
`ComputerSet`	`getComputer()` Deprecated. UI method. Not meant to be used programmatically.
`Computer`	`getComputer(String name)`
`protected Map<Node,Computer>`	`getComputerMap()`
`Computer[]`	`getComputers()` Gets the read-only list of all `Computer`s.
`String`	`getConfiguredRootUrl()` Exported alias for `JenkinsLocationConfiguration.getUrl()`.
`CrumbIssuer`	`getCrumbIssuer()` Gets the `CrumbIssuer` currently in use.
`DependencyGraph`	`getDependencyGraph()`
`String`	`getDescription()`
`NodeDescriptor`	`getDescriptor()` Gets the descriptor for this instance.
`Descriptor`	`getDescriptor(Class<? extends Describable> type)` Gets the `Descriptor` that corresponds to the given `Describable` type.
`Descriptor`	`getDescriptor(String id)` Exposes `Descriptor` by its name to URL.
`Descriptor`	`getDescriptorByName(String id)` Alias for `getDescriptor(String)`.
`<T extends Descriptor> T`	`getDescriptorByType(Class<T> type)` Gets the `Descriptor` instance in the current Jenkins by its type.
`<T extends Describable<T>,D extends Descriptor<T>> DescriptorExtensionList<T,D>`	`getDescriptorList(Class<T> type)` Returns `ExtensionList` that retains the discovered `Descriptor` instances for the given kind of `Describable`.
`Descriptor`	`getDescriptorOrDie(Class<? extends Describable> type)` Works just like `getDescriptor(Class)` but don't take no for an answer.
`String`	`getDisplayName()`
`Object`	`getDynamic(String token)`
`<T> ExtensionList<T>`	`getExtensionList(Class<T> extensionType)` Returns `ExtensionList` that retains the discovered instances for the given extension type.
`ExtensionList`	`getExtensionList(String extensionType)` Used to bind `ExtensionList`s to URLs.
`FederatedLoginService`	`getFederatedLoginService(String name)`
`List<FederatedLoginService>`	`getFederatedLoginServices()`
`Object`	`getFingerprint(String md5sum)`
`FingerprintMap`	`getFingerprintMap()`
`String`	`getFullDisplayName()`
`String`	`getFullName()` Gets the full name of this `ItemGroup`.
`DescribableList<NodeProperty<?>,NodePropertyDescriptor>`	`getGlobalNodeProperties()`
`RemotingDiagnostics.HeapDump`	`getHeapDump()` Obtains the heap dump.
`InitMilestone`	`getInitLevel()` Gets the initialization milestone that we've already reached.
`com.google.inject.Injector`	`getInjector()` Gets the dependency injection container that hosts all the extension implementations and other components in Jenkins.
`InstallState`	`getInstallState()` Get the Jenkins `install state`.
`static Jenkins`	`getInstance()` Deprecated. This is a historical alias for `getInstanceOrNull()` but with ambiguous nullability. Use `get()` in typical cases.
`static Jenkins`	`getInstanceOrNull()` Gets the `Jenkins` singleton.
`TopLevelItem`	`getItem(String name)` Gets the `Item` inside this group that has a given name, or null if it does not exist.
`Item`	`getItem(String pathName, Item context)`
`<T extends Item> T`	`getItem(String pathName, Item context, Class<T> type)`
`Item`	`getItem(String pathName, ItemGroup context)` Gets the item by its path name from the given context
`<T extends Item> T`	`getItem(String pathName, ItemGroup context, Class<T> type)`
`Item`	`getItemByFullName(String fullName)`
`<T extends Item> T`	`getItemByFullName(String fullName, Class<T> type)` Gets the `Item` object by its full name.
`Jenkins`	`getItemGroup()` Returns the `ItemGroup` from which the views in this group should render items.
`Map<String,TopLevelItem>`	`getItemMap()` Returns the read-only view of all the `TopLevelItem`s keyed by their names.
`List<TopLevelItem>`	`getItems()` Gets just the immediate children of `Jenkins`.
`<T> List<T>`	`getItems(Class<T> type)` Gets just the immediate children of `Jenkins` but of the given type.
`List<TopLevelItem>`	`getItems(Predicate<TopLevelItem> pred)` Gets just the immediate children of `Jenkins` based on supplied predicate.
`JDK`	`getJDK(String name)` Gets the JDK installation of the given name, or returns null.
`List<JDK>`	`getJDKs()`
`Slave.JnlpJar`	`getJnlpJars(String fileName)` Serves jar files for inbound agents.
`Collection<String>`	`getJobNames()` Gets the names of all the `Job`s.
`JobPropertyDescriptor`	`getJobProperty(String shortClassName)` Gets the `JobPropertyDescriptor` by name.
`Label`	`getLabel(String expr)` Gets the label that exists on this system by the name.
`LabelAtom`	`getLabelAtom(String name)` Returns the label atom of the given name.
`Set<LabelAtom>`	`getLabelAtoms()`
`Set<Label>`	`getLabels()` Gets all the active labels in the current system.
`String`	`getLabelString()` Returns the manually configured label for a node.
`String`	`getLegacyInstanceId()` Returns the unique identifier of this Jenkins that has been historically used to identify this Jenkins to the outside world.
`Lifecycle`	`getLifecycle()`
`LogRecorderManager`	`getLog()` For binding `LogRecorderManager` to "/log".
`List<ManagementLink>`	`getManagementLinks()`
`MarkupFormatter`	`getMarkupFormatter()` Gets the markup formatter used in the system.
`User`	`getMe()` Exposes the current user to `/me` URL.
`Node.Mode`	`getMode()` Returns `Node.Mode.EXCLUSIVE` if this node is only available for those jobs that exclusively specifies this node as the assigned node.
`MyViewsTabBar`	`getMyViewsTabBar()`
`Node`	`getNode(String name)` Gets the agent node of the give name, hooked under this Jenkins.
`String`	`getNodeDescription()` Human-readable description of this node.
`DescribableList<NodeProperty<?>,NodePropertyDescriptor>`	`getNodeProperties()` Gets the `NodeProperty` instances configured for this `Node`.
`List<Node>`	`getNodes()` Returns all `Node`s in the system, excluding `Jenkins` instance itself which represents the built-in node (in other words, this only returns agents).
`Nodes`	`getNodesObject()` Get the `Nodes` object that handles maintaining individual `Node`s.
`int`	`getNumExecutors()` Returns the number of `Executor`s.
`View.People`	`getPeople()`
`<P extends Plugin> P`	`getPlugin(Class<P> clazz)` Gets the plugin object from its class.
`Plugin`	`getPlugin(String shortName)` Gets the plugin object from its short name.
`PluginManager`	`getPluginManager()`
`<P extends Plugin> List<P>`	`getPlugins(Class<P> clazz)` Gets the plugin objects from their super-class.
`View`	`getPrimaryView()` Returns the primary `View` that renders the top-page of Jenkins.
`ProjectNamingStrategy`	`getProjectNamingStrategy()` The strategy used to check the project names.
`List<Project>`	`getProjects()` Deprecated. This method will ignore Maven and matrix projects, as well as projects inside containers such as folders. You may prefer to call `ItemGroup.getAllItems(Class)` on `AbstractProject`, perhaps also using `Util.createSubList(java.util.Collection<?>, java.lang.Class<T>)` to consider only `TopLevelItem`s. (That will also consider the caller's permissions.) If you really want to get just `Project`s at top level, ignoring permissions, you can filter the values from `getItemMap()` using `Util.createSubList(java.util.Collection<?>, java.lang.Class<T>)`.
`ProxyConfiguration`	`getProxy()` Retrieve the proxy configuration.
`Descriptor<Publisher>`	`getPublisher(String shortClassName)` Gets the publisher descriptor by name.
`Queue`	`getQueue()`
`String`	`getQuietDownReason()` Returns quiet down reason if it was indicated.
`int`	`getQuietPeriod()` Gets the system default quiet period.
`String`	`getRawBuildsDir()`
`String`	`getRawWorkspaceDir()`
`Descriptor<RepositoryBrowser<?>>`	`getRepositoryBrowser(String shortClassName)` Gets the repository browser descriptor by name.
`Descriptor<RetentionStrategy<?>>`	`getRetentionStrategy(String shortClassName)` Gets the retention strategy descriptor by name.
`File`	`getRootDir()` Gets the root directory on the file system that this `Item` can use freely for storing the configuration data.
`File`	`getRootDirFor(TopLevelItem child)` Assigns the `root directory` for children.
`FilePath`	`getRootPath()` Gets the root directory of this node.
`String`	`getRootUrl()` Gets the absolute URL of Jenkins, such as `http://localhost/jenkins/`.
`String`	`getRootUrlFromRequest()` Gets the absolute URL of Jenkins top page, such as `http://localhost/jenkins/`.
`Descriptor<SCM>`	`getScm(String shortClassName)` Gets the SCM descriptor by name.
`int`	`getScmCheckoutRetryCount()` Gets the global SCM check out retry count.
`CopyOnWriteList<SCMListener>`	`getSCMListeners()` Deprecated. Use `SCMListener.all()` instead.
`String`	`getSearchUrl()` Returns the URL of this item relative to the parent `SearchItem`.
`String`	`getSecretKey()` Deprecated. Due to the past security advisory, this value should not be used any more to protect sensitive information. See `ConfidentialStore` and `ConfidentialKey` for how to store secrets.
`SecretKey`	`getSecretKeyAsAES128()` Deprecated. See `getSecretKey()`.
`SecurityMode`	`getSecurity()` Returns the constant that captures the three basic security modes in Jenkins.
`SecurityRealm`	`getSecurityRealm()`
`Descriptor<SecurityRealm>`	`getSecurityRealms(String shortClassName)` Gets the `SecurityRealm` descriptors by name.
`LabelAtom`	`getSelfLabel()` Gets the special label that represents this node itself.
`SetupWizard`	`getSetupWizard()` If set, a currently active setup wizard - e.g.
`int`	`getSlaveAgentPort()`
`View`	`getStaplerFallback()` Fallback to the primary view.
`static VersionNumber`	`getStoredVersion()` Get the stored version of Jenkins, as stored by `doConfigSubmit(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse)`.
`String`	`getSystemMessage()` Synonym for `getDescription()`.
`Object`	`getTarget()`
`TcpSlaveAgentListener`	`getTcpSlaveAgentListener()`
`Collection<String>`	`getTopLevelItemNames()` Gets the names of all the `TopLevelItem`s.
`TriggerDescriptor`	`getTrigger(String shortClassName)` Gets the trigger descriptor by name.
`Collection<String>`	`getUnprotectedRootActions()` Gets a list of unprotected root actions.
`UpdateCenter`	`getUpdateCenter()`
`String`	`getUrlChildPrefix()` Gets the URL token that prefixes the URLs for child `Item`s.
`User`	`getUser(String name)` Gets the user of the given name.
`static VersionNumber`	`getVersion()` Parses `VERSION` into `VersionNumber`, or null if it's not parseable as a version number (such as when Jenkins is run with `mvn jetty:run`)
`View`	`getView(String name)` Gets a view by the specified name.
`List<Action>`	`getViewActions()` Returns actions that should be displayed in views.
`Collection<View>`	`getViews()` Gets the read-only list of all `View`s.
`ViewsTabBar`	`getViewsTabBar()` Gets the TabBar for the views.
`List<Widget>`	`getWidgets()` Gets the `Widget`s registered on this object.
`FilePath`	`getWorkspaceFor(TopLevelItem item)` Returns a "workspace" directory for the given `TopLevelItem`.
`boolean`	`hasPeople()` Deprecated. Potentially very expensive call; do not use from Jelly views.
`static boolean`	`isCheckURIEncodingEnabled()` Deprecated.
`boolean`	`isDefaultBuildDir()` If the configured buildsDir has it's default value or has been changed.
`boolean`	`isDisableRememberMe()`
`Boolean`	`isNoUsageStatistics()` If usage statistics has been disabled
`boolean`	`isQuietingDown()` Returns true if Jenkins is quieting down.
`boolean`	`isRootUrlSecure()` Is Jenkins running in HTTPS? Note that we can't really trust `ServletRequest.isSecure()` because HTTPS might be terminated in the reverse proxy.
`boolean`	`isSlaveAgentPortEnforced()`
`boolean`	`isSubjectToMandatoryReadPermissionCheck(String restOfPath)` Test a path to see if it is subject to mandatory read permission checks by container-managed security
`boolean`	`isTerminating()` Returns true if the container initiated the termination of the web application.
`boolean`	`isUpgradedFromBefore(VersionNumber v)` Returns true if the current running Jenkins is upgraded from a version earlier than the specified version.
`boolean`	`isUsageStatisticsCollected()` If usage statistics are being collected
`boolean`	`isUseCrumbs()` If true, all the POST requests to Jenkins would have to have crumb in it to protect Jenkins from CSRF vulnerabilities.
`boolean`	`isUseProjectNamingStrategy()`
`boolean`	`isUseSecurity()` A convenience method to check if there's some security restrictions in place.
`static <T> T`	`lookup(Class<T> type)` Shortcut for `Jenkins.getInstanceOrNull()?.lookup.get(type)`
`SearchIndexBuilder`	`makeSearchIndex()` Default implementation that returns empty index.
`void`	`onDeleted(TopLevelItem item)` Called in response to `AbstractItem.doDoDelete(StaplerRequest, StaplerResponse)`
`void`	`onRenamed(TopLevelItem job, String oldName, String newName)` Called by `Job.renameTo(String)` to update relevant data structure.
`void`	`onViewRenamed(View view, String oldName, String newName)` `View` calls this method when it's renamed.
`void`	`putItem(TopLevelItem item)` Overwrites the existing item by new one.
`protected Object`	`readResolve()` Maintains backwards compatibility.
`void`	`rebuildDependencyGraph()` Rebuilds the dependency map.
`Future<DependencyGraph>`	`rebuildDependencyGraphAsync()` Rebuilds the dependency map asynchronously.
`void`	`refreshExtensions()` Refresh `ExtensionList`s by adding all the newly discovered extensions.
`void`	`reload()` Reloads the configuration synchronously.
`void`	`remove(TopLevelItem item)` Removes an item from this group.
`void`	`removeNode(Node n)` Removes a `Node` from Jenkins.
`void`	`restart()` Performs a restart.
`void`	`safeRestart()` Queues up a restart to be performed once there are no builds currently running.
`void`	`save()` Save the settings to a file.
`void`	`setAgentProtocols(Set<String> protocols)` Sets the enabled agent protocols.
`void`	`setAuthorizationStrategy(AuthorizationStrategy a)` Sets a new authorization strategy.
`void`	`setCrumbIssuer(CrumbIssuer issuer)`
`void`	`setDisableRememberMe(boolean disableRememberMe)`
`void`	`setInstallState(InstallState newState)` Update the current install state.
`void`	`setJDKs(Collection<? extends JDK> jdks)` Replaces all JDK installations with those from the given collection.
`void`	`setLabelString(String label)` Sets the label string for a node.
`void`	`setMarkupFormatter(MarkupFormatter f)` Sets the markup formatter used in the system globally.
`void`	`setMode(Node.Mode m)`
`void`	`setMyViewsTabBar(MyViewsTabBar myViewsTabBar)`
`void`	`setNodeName(String name)` When the user clones a `Node`, Hudson uses this method to change the node name right after the cloned `Node` object is instantiated.
`void`	`setNodes(List<? extends Node> n)`
`void`	`setNoUsageStatistics(Boolean noUsageStatistics)` Sets the noUsageStatistics flag
`void`	`setNumExecutors(int n)` Sets a number of executors.
`void`	`setPrimaryView(View v)`
`void`	`setProjectNamingStrategy(ProjectNamingStrategy ns)`
`void`	`setProxy(ProxyConfiguration proxy)` Set the proxy configuration.
`void`	`setQuietPeriod(Integer quietPeriod)` Sets the global quiet period.
`void`	`setRawBuildsDir(String buildsDir)`
`void`	`setScmCheckoutRetryCount(int scmCheckoutRetryCount)`
`void`	`setSecurityRealm(SecurityRealm securityRealm)` Sets a security realm.
`void`	`setSlaveAgentPort(int port)`
`void`	`setSystemMessage(String message)` Sets the system message.
`void`	`setViews(Collection<View> views)` Completely replaces views.
`void`	`setViewsTabBar(ViewsTabBar viewsTabBar)`
`boolean`	`shouldShowStackTrace()`
`protected void`	`updateComputerList()`
`protected void`	`updateNewComputer(Node n)`
`boolean`	`updateNode(Node n)` Saves an existing `Node` on disk, called by `Node.save()`.

Methods inherited from class hudson.model.AbstractCIBase
getDisabledAdministrativeMonitors, getNodeName, getUrl, interruptReloadThread, killComputer, resetLabel, setDisabledAdministrativeMonitors, setViewOwner, updateComputerList, updateNewComputer

Methods inherited from class hudson.model.Node
canTake, canTake, getAssignedLabels, getChannel, getFileSystemProvisioner, getLabelCloud, getNodeProperty, getNodeProperty, getNodePropertyDescriptors, isAcceptingTasks, isHoldOffLaunchUntilSave, reconfigure, toComputer

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

Methods inherited from interface hudson.model.ItemGroup
allItems, allItems, allItems, getAllItems, getAllItems, getAllItems, getItemsStream, getItemsStream, getUrl

Methods inherited from interface hudson.model.ViewGroup
getAllViews, getUrl

Methods inherited from interface hudson.security.AccessControlled
checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

- Field Detail
 - lookup
```
public final transient Lookup lookup
```
 Stores various objects scoped to Jenkins.
 - root
```
public final transient File root
```
 Root directory of the system.
 - computers
```
protected final transient Map<Node,Computer> computers
```
 Computers in this Jenkins system. Read-only.
 - clouds
```
public final Hudson.CloudList clouds
```
 Active Clouds.
 - slaves
```
@Deprecated
protected transient volatile NodeList slaves
```
 Deprecated. in favour of Nodes
 
 Legacy store of the set of installed cluster nodes.
 - pluginManager
```
public final transient PluginManager pluginManager
```
 Loaded plugins.
 - tcpSlaveAgentListener
```
public transient volatile TcpSlaveAgentListener tcpSlaveAgentListener
```
 - overallLoad
```
@Exported
public final transient OverallLoadStatistics overallLoad
```
 Load statistics of the entire system. This includes every executor and every job in the system.
 - unlabeledLoad
```
@Exported
public final transient LoadStatistics unlabeledLoad
```
 Load statistics of the free roaming jobs and agents. This includes all executors on Node.Mode.NORMAL nodes and jobs that do not have any assigned nodes.
 
 Since:
 
 1.467
 - unlabeledNodeProvisioner
```
public final transient NodeProvisioner unlabeledNodeProvisioner
```
 NodeProvisioner that reacts to unlabeledLoad.
 
 Since:
 
 1.467
 - overallNodeProvisioner
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @Deprecated
public final transient NodeProvisioner overallNodeProvisioner
```
 Deprecated. as of 1.467 Use unlabeledNodeProvisioner. This was broken because it was tracking all the executors in the system, but it was only tracking free-roaming jobs in the queue. So Cloud fails to launch nodes when you have some exclusive agents and free-roaming jobs in the queue.
 - servletContext
```
public final transient javax.servlet.ServletContext servletContext
```
 - administrativeMonitors
```
public final transient List<AdministrativeMonitor> administrativeMonitors
```
 AdministrativeMonitors installed on this system.
 
 See Also:
 
 AdministrativeMonitor
 - proxy
```
public transient volatile ProxyConfiguration proxy
```
 HTTP proxy configuration.
 - ALLOWED_RESOURCE_EXTENSIONS
```
public static final Set<String> ALLOWED_RESOURCE_EXTENSIONS
```
 Extension list that doResources(StaplerRequest, StaplerResponse) can serve. This set is mutable to allow plugins to add additional extensions.
 - logRecords
```
public static List<LogRecord> logRecords
```
 Live view of recent LogRecords produced by Jenkins.
 - XSTREAM
```
public static final com.thoughtworks.xstream.XStream XSTREAM
```
 Thread-safe reusable XStream.
 - XSTREAM2
```
public static final XStream2 XSTREAM2
```
 Alias to XSTREAM so that one can access additional methods on XStream2 more easily.
 - UNCOMPUTED_VERSION
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final String UNCOMPUTED_VERSION
```
 The version number before it is "computed" (by a call to computeVersion()).
 
 Since:
 
 2.0
 
 See Also:
 
 Constant Field Values
 - VERSION
```
public static String VERSION
```
 Version number of this Jenkins.
 - CHANGELOG_URL
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static String CHANGELOG_URL
```
 - VERSION_HASH
```
public static String VERSION_HASH
```
 Hash of VERSION.
 - SESSION_HASH
```
public static String SESSION_HASH
```
 Unique random token that identifies the current session. Used to make RESOURCE_PATH unique so that we can set long "Expires" header. We used to use VERSION_HASH, but making this session local allows us to reuse the same RESOURCE_PATH for static resources in plugins.
 - RESOURCE_PATH
```
public static String RESOURCE_PATH
```
 Prefix to static resources like images and javascripts in the war file. Either "" or strings like "/static/VERSION", which avoids Jenkins to pick up stale cache when the user upgrades to a different version.
 Value computed in WebAppMain.
 - VIEW_RESOURCE_PATH
```
public static String VIEW_RESOURCE_PATH
```
 Prefix to resources alongside view scripts. Strings like "/resources/VERSION", which avoids Jenkins to pick up stale cache when the user upgrades to a different version.
 Value computed in WebAppMain.
 - PARALLEL_LOAD
```
public static boolean PARALLEL_LOAD
```
 - KILL_AFTER_LOAD
```
public static boolean KILL_AFTER_LOAD
```
 - FLYWEIGHT_SUPPORT
```
@Deprecated
public static boolean FLYWEIGHT_SUPPORT
```
 Deprecated. No longer used.
 - CONCURRENT_BUILD
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @Deprecated
public static boolean CONCURRENT_BUILD
```
 Deprecated. as of 1.464 This flag will have no effect.
 
 Tentative switch to activate the concurrent build behavior. When we merge this back to the trunk, this allows us to keep this feature hidden for a while until we iron out the kinks.
 
 See Also:
 
 AbstractProject.isConcurrentBuild()
 - NAME_VALIDATION_REJECTS_TRAILING_DOT_PROP
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final String NAME_VALIDATION_REJECTS_TRAILING_DOT_PROP
```
 Name of the system property escape hatch for SECURITY-2424. It allows to have back the legacy (and vulnerable) behavior allowing a "good name" to end with a dot. This could be used to exploit two names colliding in the file system to extract information. The files ending with a dot are only a problem on Windows. The default value is true. For detailed documentation: https://docs.microsoft.com/en-us/troubleshoot/windows-client/shell-experience/file-folder-name-whitespace-characters
 
 See Also:
 
 checkGoodName(String)
 - AUTOMATIC_SLAVE_LAUNCH
```
public static boolean AUTOMATIC_SLAVE_LAUNCH
```
 Automatically try to launch an agent when Jenkins is initialized or a new agent computer is created.
 - PERMISSIONS
```
public static final PermissionGroup PERMISSIONS
```
 - ADMINISTER
```
public static final Permission ADMINISTER
```
 - MANAGE
```
@Restricted(value=org.kohsuke.accmod.restrictions.Beta.class)
public static final Permission MANAGE
```
 This permission grants access to parts of the Jenkins system configuration.
 Only features that won't have an impact on Jenkins' overall security and stability should have their permission requirement lowered from ADMINISTER to MANAGE. For example, many scripting and code execution features (e.g., configuring master agents, paths to tools on master, etc.) are unsafe to make available to users with only this permission, as they could be used to bypass permission enforcement and elevate permissions.
 
 This permission is disabled by default and support for it considered experimental. Administrators can set the system property jenkins.security.ManagePermission to enable it.
 
 Since:
 
 2.222
 - SYSTEM_READ
```
public static final Permission SYSTEM_READ
```
 Allows read-only access to large parts of the system configuration. When combined with MANAGE, it is expected that everything is shown as if only SYSTEM_READ was granted, but that only options editable by users with MANAGE are editable.
 - MANAGE_AND_SYSTEM_READ
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final Permission[] MANAGE_AND_SYSTEM_READ
```
 - READ
```
public static final Permission READ
```
 - RUN_SCRIPTS
```
@Deprecated
public static final Permission RUN_SCRIPTS
```
 Deprecated. in Jenkins 2.222 use ADMINISTER instead
 - ANONYMOUS2
```
public static final org.springframework.security.core.Authentication ANONYMOUS2
```
 Authentication object that represents the anonymous user. Because Spring Security creates its own AnonymousAuthenticationToken instances, the code must not expect the singleton semantics. This is just a convenient instance.
 
 Since:
 
 2.266
 - ANONYMOUS
```
@Deprecated
public static final Authentication ANONYMOUS
```
 Deprecated. use ANONYMOUS2
 
 Since:
 
 1.343
- Constructor Detail
 - Jenkins
```
protected Jenkins(File root,
 javax.servlet.ServletContext context)
 throws IOException,
 InterruptedException,
 org.jvnet.hudson.reactor.ReactorException
```
 Throws:
 
 IOException
 
 InterruptedException
 
 org.jvnet.hudson.reactor.ReactorException
 - Jenkins
```
protected Jenkins(File root,
 javax.servlet.ServletContext context,
 PluginManager pluginManager)
 throws IOException,
 InterruptedException,
 org.jvnet.hudson.reactor.ReactorException
```
 Parameters:
 
 pluginManager - If non-null, use existing plugin manager. create a new one.
 
 Throws:
 
 IOException
 
 InterruptedException
 
 org.jvnet.hudson.reactor.ReactorException
- Method Detail
 - get
```
@NonNull
public static Jenkins get()
 throws IllegalStateException
```
 Gets the Jenkins singleton.
 
 Returns:
 
 Jenkins instance
 
 Throws:
 
 IllegalStateException - for the reasons that getInstanceOrNull() might return null
 
 Since:
 
 2.98
 - getActiveInstance
```
@Deprecated
 @NonNull
public static Jenkins getActiveInstance()
 throws IllegalStateException
```
 Deprecated. This is a verbose historical alias for get().
 
 Throws:
 
 IllegalStateException
 
 Since:
 
 1.590
 - getInstanceOrNull
```
@CLIResolver
 @CheckForNull
public static Jenkins getInstanceOrNull()
```
 Gets the Jenkins singleton. get() is what you normally want.
 In certain rare cases you may have code that is intended to run before Jenkins starts or while Jenkins is being shut down. For those rare cases use this method.
 In other cases you may have code that might end up running on a remote JVM and not on the Jenkins controller or built-in node. For those cases you really should rewrite your code so that when the Callable is sent over the remoting channel it can do whatever it needs without ever referring to Jenkins; for example, gather any information you need on the controller side before constructing the callable. If you must do a runtime check whether you are in the controller or agent, use JenkinsJVM rather than this method, as merely loading the Jenkins class file into an agent JVM can cause linkage errors under some conditions.
 
 Returns:
 
 The instance. Null if the Jenkins service has not been started, or was already shut down, or we are running on an unrelated JVM, typically an agent.
 
 Since:
 
 1.653
 - getInstance
```
@Nullable
 @Deprecated
public static Jenkins getInstance()
```
 Deprecated. This is a historical alias for getInstanceOrNull() but with ambiguous nullability. Use get() in typical cases.
 - readResolve
```
protected Object readResolve()
```
 Maintains backwards compatibility. Invoked by XStream when this object is de-serialized.
 - getProxy
```
@CheckForNull
public ProxyConfiguration getProxy()
```
 Retrieve the proxy configuration.
 
 Returns:
 
 the proxy configuration
 
 Since:
 
 2.205
 - setProxy
```
public void setProxy(@CheckForNull
 ProxyConfiguration proxy)
```
 Set the proxy configuration.
 
 Parameters:
 
 proxy - the proxy to set
 
 Since:
 
 2.205
 - getInstallState
```
@NonNull
public InstallState getInstallState()
```
 Get the Jenkins install state.
 
 Returns:
 
 The Jenkins install state.
 - setInstallState
```
public void setInstallState(@NonNull
 InstallState newState)
```
 Update the current install state. This will invoke state.initializeState() when the state has been transitioned.
 - getTcpSlaveAgentListener
```
public TcpSlaveAgentListener getTcpSlaveAgentListener()
```
 - getAdjuncts
```
public org.kohsuke.stapler.framework.adjunct.AdjunctManager getAdjuncts(String dummy)
```
 Makes AdjunctManager URL-bound. The dummy parameter allows us to use different URLs for the same adjunct, for proper cache handling.
 - getSlaveAgentPort
```
@Exported
public int getSlaveAgentPort()
```
 - isSlaveAgentPortEnforced
```
public boolean isSlaveAgentPortEnforced()
```
 Since:
 
 2.24
 - setSlaveAgentPort
```
public void setSlaveAgentPort(int port)
 throws IOException
```
 Parameters:
 
 port - 0 to indicate random available TCP port. -1 to disable this service.
 
 Throws:
 
 IOException
 - getAgentProtocols
```
public Set<String> getAgentProtocols()
```
 Returns the enabled agent protocols.
 
 Returns:
 
 the enabled agent protocols.
 
 Since:
 
 2.16
 - setAgentProtocols
```
public void setAgentProtocols(Set<String> protocols)
```
 Sets the enabled agent protocols.
 
 Parameters:
 
 protocols - the enabled agent protocols.
 
 Since:
 
 2.16
 - setNodeName
```
public void setNodeName(String name)
```
 Description copied from class: Node
 
 When the user clones a Node, Hudson uses this method to change the node name right after the cloned Node object is instantiated.
 This method is never used for any other purpose, and as such for all practical intents and purposes, the node name should be treated like immutable.
 
 Specified by:
 
 setNodeName in class Node
 - getNodeDescription
```
public String getNodeDescription()
```
 Description copied from class: Node
 
 Human-readable description of this node.
 
 Specified by:
 
 getNodeDescription in class Node
 - getDescription
```
@Exported
public String getDescription()
```
 - getPluginManager
```
@NonNull
public PluginManager getPluginManager()
```
 - getUpdateCenter
```
public UpdateCenter getUpdateCenter()
```
 - isNoUsageStatistics
```
@CheckForNull
public Boolean isNoUsageStatistics()
```
 If usage statistics has been disabled
 
 Since:
 
 2.226
 - isUsageStatisticsCollected
```
public boolean isUsageStatisticsCollected()
```
 If usage statistics are being collected
 
 Returns:
 
 true if usage statistics should be collected. Defaults to true when noUsageStatistics is not set.
 - setNoUsageStatistics
```
public void setNoUsageStatistics(Boolean noUsageStatistics)
 throws IOException
```
 Sets the noUsageStatistics flag
 
 Throws:
 
 IOException
 - getPeople
```
public View.People getPeople()
```
 - getAsynchPeople
```
public View.AsynchPeople getAsynchPeople()
```
 Since:
 
 1.484
 - hasPeople
```
@Deprecated
public boolean hasPeople()
```
 Deprecated. Potentially very expensive call; do not use from Jelly views.
 
 Does this View has any associated user information recorded?
 - getApi
```
public Api getApi()
```
 - getSecretKey
```
@Deprecated
public String getSecretKey()
```
 Deprecated. Due to the past security advisory, this value should not be used any more to protect sensitive information. See ConfidentialStore and ConfidentialKey for how to store secrets.
 
 Returns a secret key that survives across container start/stop.
 This value is useful for implementing some of the security features.
 - getSecretKeyAsAES128
```
@Deprecated
public SecretKey getSecretKeyAsAES128()
```
 Deprecated. See getSecretKey().
 
 Gets the secret key as a key for AES-128.
 
 Since:
 
 1.308
 - getLegacyInstanceId
```
public String getLegacyInstanceId()
```
 Returns the unique identifier of this Jenkins that has been historically used to identify this Jenkins to the outside world.
 This form of identifier is weak in that it can be impersonated by others. See https://wiki.jenkins-ci.org/display/JENKINS/Instance+Identity for more modern form of instance ID that can be challenged and verified.
 
 Since:
 
 1.498
 - getScm
```
public Descriptor<SCM> getScm(String shortClassName)
```
 Gets the SCM descriptor by name. Primarily used for making them web-visible.
 - getRepositoryBrowser
```
public Descriptor<RepositoryBrowser<?>> getRepositoryBrowser(String shortClassName)
```
 Gets the repository browser descriptor by name. Primarily used for making them web-visible.
 - getBuilder
```
public Descriptor<Builder> getBuilder(String shortClassName)
```
 Gets the builder descriptor by name. Primarily used for making them web-visible.
 - getBuildWrapper
```
public Descriptor<BuildWrapper> getBuildWrapper(String shortClassName)
```
 Gets the build wrapper descriptor by name. Primarily used for making them web-visible.
 - getPublisher
```
public Descriptor<Publisher> getPublisher(String shortClassName)
```
 Gets the publisher descriptor by name. Primarily used for making them web-visible.
 - getTrigger
```
public TriggerDescriptor getTrigger(String shortClassName)
```
 Gets the trigger descriptor by name. Primarily used for making them web-visible.
 - getRetentionStrategy
```
public Descriptor<RetentionStrategy<?>> getRetentionStrategy(String shortClassName)
```
 Gets the retention strategy descriptor by name. Primarily used for making them web-visible.
 - getJobProperty
```
public JobPropertyDescriptor getJobProperty(String shortClassName)
```
 Gets the JobPropertyDescriptor by name. Primarily used for making them web-visible.
 - getComputer
```
@Deprecated
public ComputerSet getComputer()
```
 Deprecated. UI method. Not meant to be used programmatically.
 - getDescriptor
```
public Descriptor getDescriptor(String id)
```
 Exposes Descriptor by its name to URL. After doing all the getXXX(shortClassName) methods, I finally realized that this just doesn't scale.
 
 Parameters:
 
 id - Either Descriptor.getId() (recommended) or the short name of a Describable subtype (for compatibility)
 
 Throws:
 
 IllegalArgumentException - if a short name was passed which matches multiple IDs (fail fast)
 - getDescriptorByName
```
public Descriptor getDescriptorByName(String id)
```
 Alias for getDescriptor(String).
 
 Specified by:
 
 getDescriptorByName in interface DescriptorByNameOwner
 
 Parameters:
 
 id - Either Descriptor.getId() (recommended) or the short name.
 - getDescriptor
```
@CheckForNull
public Descriptor getDescriptor(Class<? extends Describable> type)
```
 Gets the Descriptor that corresponds to the given Describable type.
 If you have an instance of type and call Describable.getDescriptor(), you'll get the same instance that this method returns.
 - getDescriptorOrDie
```
@NonNull
public Descriptor getDescriptorOrDie(Class<? extends Describable> type)
```
 Works just like getDescriptor(Class) but don't take no for an answer.
 
 Throws:
 
 AssertionError - If the descriptor is missing.
 
 Since:
 
 1.326
 - getDescriptorByType
```
public <T extends Descriptor> T getDescriptorByType(Class<T> type)
```
 Gets the Descriptor instance in the current Jenkins by its type.
 - getSecurityRealms
```
public Descriptor<SecurityRealm> getSecurityRealms(String shortClassName)
```
 Gets the SecurityRealm descriptors by name. Primarily used for making them web-visible.
 - updateNewComputer
```
protected void updateNewComputer(Node n)
```
 - updateComputerList
```
protected void updateComputerList()
```
 - getSCMListeners
```
@Deprecated
public CopyOnWriteList<SCMListener> getSCMListeners()
```
 Deprecated. Use SCMListener.all() instead.
 - getPlugin
```
@CheckForNull
public Plugin getPlugin(String shortName)
```
 Gets the plugin object from its short name. This allows URL hudson/plugin/ID to be served by the views of the plugin class.
 
 Parameters:
 
 shortName - Short name of the plugin
 
 Returns:
 
 The plugin singleton or null if for some reason the plugin is not loaded. The fact the plugin is loaded does not mean it is enabled and fully initialized for the current Jenkins session. Use Plugin.getWrapper() and then PluginWrapper.isActive() to check it.
 - getPlugin
```
@CheckForNull
public  P getPlugin(Class clazz)
```
 Gets the plugin object from its class.
 This allows easy storage of plugin information in the plugin singleton without every plugin reimplementing the singleton pattern.
 
 Type Parameters:
 
 P - Class of the plugin
 
 Parameters:
 
 clazz - The plugin class (beware class-loader fun, this will probably only work from within the jpi that defines the plugin class, it may or may not work in other cases)
 
 Returns:
 
 The plugin singleton or null if for some reason the plugin is not loaded. The fact the plugin is loaded does not mean it is enabled and fully initialized for the current Jenkins session. Use Plugin.getWrapper() and then PluginWrapper.isActive() to check it.
 - getPlugins
```
public  List getPlugins(Class clazz)
```
 Gets the plugin objects from their super-class.
 
 Parameters:
 
 clazz - The plugin class (beware class-loader fun)
 
 Returns:
 
 The plugin instances.
 - getSystemMessage
```
public String getSystemMessage()
```
 Synonym for getDescription().
 - getMarkupFormatter
```
@NonNull
public MarkupFormatter getMarkupFormatter()
```
 Gets the markup formatter used in the system.
 
 Returns:
 
 never null.
 
 Since:
 
 1.391
 - setMarkupFormatter
```
public void setMarkupFormatter(MarkupFormatter f)
```
 Sets the markup formatter used in the system globally.
 
 Since:
 
 1.391
 - setSystemMessage
```
public void setSystemMessage(String message)
 throws IOException
```
 Sets the system message.
 
 Throws:
 
 IOException
 - getFederatedLoginService
```
@StaplerDispatchable
public FederatedLoginService getFederatedLoginService(String name)
```
 - getFederatedLoginServices
```
public List<FederatedLoginService> getFederatedLoginServices()
```
 - createLauncher
```
public Launcher createLauncher(TaskListener listener)
```
 Description copied from class: Node
 
 Returns a Launcher for executing programs on this node.
 The callee must call Launcher.decorateFor(Node) before returning to complete the decoration.
 
 Specified by:
 
 createLauncher in class Node
 - getFullName
```
public String getFullName()
```
 Description copied from interface: ItemGroup
 
 Gets the full name of this ItemGroup.
 
 Specified by:
 
 getFullName in interface ItemGroup<TopLevelItem>
 
 See Also:
 
 Item.getFullName()
 - getFullDisplayName
```
public String getFullDisplayName()
```
 Specified by:
 
 getFullDisplayName in interface ItemGroup<TopLevelItem>
 
 See Also:
 
 Item.getFullDisplayName()
 - getActions
```
public List<Action> getActions()
```
 Returns the transient Actions associated with the top page.
 Adding Action is primarily useful for plugins to contribute an item to the navigation bar of the top page. See existing Action implementation for it affects the GUI.
 To register an Action, implement RootAction extension point, or write code like Jenkins.get().getActions().add(...).
 
 Returns:
 
 Live list where the changes can be made. Can be empty but never null.
 
 Since:
 
 1.172
 - getItems
```
@Exported(name="jobs")
public List<TopLevelItem> getItems()
```
 Gets just the immediate children of Jenkins.
 
 Specified by:
 
 getItems in interface ItemGroup<TopLevelItem>
 
 See Also:
 
 ItemGroup.getAllItems(Class)
 - getItems
```
public List<TopLevelItem> getItems(Predicate<TopLevelItem> pred)
```
 Gets just the immediate children of Jenkins based on supplied predicate.
 
 Specified by:
 
 getItems in interface ItemGroup<TopLevelItem>
 
 Since:
 
 2.221
 
 See Also:
 
 ItemGroup.getAllItems(Class)
 - getItemMap
```
public Map<String,TopLevelItem> getItemMap()
```
 Returns the read-only view of all the TopLevelItems keyed by their names.
 This method is efficient, as it doesn't involve any copying.
 
 Since:
 
 1.296
 - getItems
```
public <T> List<T> getItems(Class<T> type)
```
 Gets just the immediate children of Jenkins but of the given type.
 - getProjects
```
@Deprecated
public List<Project> getProjects()
```
 Deprecated. This method will ignore Maven and matrix projects, as well as projects inside containers such as folders. You may prefer to call ItemGroup.getAllItems(Class) on AbstractProject, perhaps also using Util.createSubList(java.util.Collection<?>, java.lang.Class<T>) to consider only TopLevelItems. (That will also consider the caller's permissions.) If you really want to get just Projects at top level, ignoring permissions, you can filter the values from getItemMap() using Util.createSubList(java.util.Collection<?>, java.lang.Class<T>).
 
 Gets a list of simple top-level projects.
 - getJobNames
```
public Collection<String> getJobNames()
```
 Gets the names of all the Jobs.
 - getViewActions
```
public List<Action> getViewActions()
```
 Description copied from interface: ViewGroup
 
 Returns actions that should be displayed in views.
 In this interface, the return value is used read-only. This doesn't prevent subtypes from returning modifiable actions, however.
 
 Specified by:
 
 getViewActions in interface ViewGroup
 
 Returns:
 
 may be empty but never null; getActions() by default
 
 See Also:
 
 Actionable.getActions()
 - getTopLevelItemNames
```
public Collection<String> getTopLevelItemNames()
```
 Gets the names of all the TopLevelItems.
 - getView
```
@CheckForNull
public View getView(@CheckForNull
 String name)
```
 Gets a view by the specified name. The method iterates through ViewGroups if required.
 
 Specified by:
 
 getView in interface ViewGroup
 
 Parameters:
 
 name - Name of the view
 
 Returns:
 
 View instance or null if it is missing
 - getViews
```
@Exported
public Collection<View> getViews()
```
 Gets the read-only list of all Views.
 
 Specified by:
 
 getViews in interface ViewGroup
 
 Returns:
 
 can be empty but never null.
 - addView
```
public void addView(@NonNull
 View v)
 throws IOException
```
 Description copied from interface: ModifiableViewGroup
 
 Add new View to this ViewGroup.
 
 Specified by:
 
 addView in interface ModifiableViewGroup
 
 Throws:
 
 IOException
 - setViews
```
public void setViews(Collection<View> views)
 throws IOException
```
 Completely replaces views.
 This operation is NOT provided as an atomic operation, but rather the sole purpose of this is to define a setter for this to help introspecting code, such as system-config-dsl plugin
 
 Throws:
 
 IOException
 - canDelete
```
public boolean canDelete(View view)
```
 Description copied from interface: ViewGroup
 
 Determine whether a view may be deleted.
 
 Specified by:
 
 canDelete in interface ViewGroup
 - deleteView
```
public void deleteView(View view)
 throws IOException
```
 Description copied from interface: ViewGroup
 
 Deletes a view in this group.
 
 Specified by:
 
 deleteView in interface ViewGroup
 
 Throws:
 
 IOException
 - onViewRenamed
```
public void onViewRenamed(View view,
 String oldName,
 String newName)
```
 Description copied from interface: ViewGroup
 
 View calls this method when it's renamed. This method is intended to work as a notification to the ViewGroup (so that it can adjust its internal data structure, for example.)
 It is the caller's responsibility to ensure that the new name is a legal view name.
 
 Specified by:
 
 onViewRenamed in interface ViewGroup
 - getPrimaryView
```
@Exported
public View getPrimaryView()
```
 Returns the primary View that renders the top-page of Jenkins.
 
 Specified by:
 
 getPrimaryView in interface ViewGroup
 
 Returns:
 
 by default, null
 - setPrimaryView
```
public void setPrimaryView(@NonNull
 View v)
```
 - getViewsTabBar
```
public ViewsTabBar getViewsTabBar()
```
 Description copied from interface: ViewGroup
 
 Gets the TabBar for the views. TabBar for views can be provided by extension. Only one TabBar can be active at a given time (Selectable by user in the global Configuration page). Default TabBar is provided by Hudson Platform.
 
 Specified by:
 
 getViewsTabBar in interface ViewGroup
 - setViewsTabBar
```
public void setViewsTabBar(ViewsTabBar viewsTabBar)
```
 - getItemGroup
```
public Jenkins getItemGroup()
```
 Description copied from interface: ViewGroup
 
 Returns the ItemGroup from which the views in this group should render items.
 Generally speaking, Views render a subset of TopLevelItems that belong to this item group.
 
 Specified by:
 
 getItemGroup in interface ViewGroup
 
 Returns:
 
 Never null. Sometimes this is ModifiableItemGroup (if the container allows arbitrary addition). By default, get().
 - getMyViewsTabBar
```
public MyViewsTabBar getMyViewsTabBar()
```
 - setMyViewsTabBar
```
public void setMyViewsTabBar(MyViewsTabBar myViewsTabBar)
```
 - isUpgradedFromBefore
```
public boolean isUpgradedFromBefore(VersionNumber v)
```
 Returns true if the current running Jenkins is upgraded from a version earlier than the specified version.
 This method continues to return true until the system configuration is saved, at which point version will be overwritten and Jenkins forgets the upgrade history.
 To handle SNAPSHOTS correctly, pass in "1.N.*" to test if it's upgrading from the version equal or younger than N. So say if you implement a feature in 1.301 and you want to check if the installation upgraded from pre-1.301, pass in "1.300.*"
 
 Since:
 
 1.301
 - getComputers
```
public Computer[] getComputers()
```
 Gets the read-only list of all Computers.
 - getComputer
```
@CLIResolver
 @CheckForNull
public Computer getComputer(@NonNull
 String name)
```
 - getLabel
```
public Label getLabel(String expr)
```
 Gets the label that exists on this system by the name.
 
 Returns:
 
 null if name is null.
 
 See Also:
 
 (String)
 - getLabelAtom
```
@Nullable
public LabelAtom getLabelAtom(@CheckForNull
 String name)
```
 Returns the label atom of the given name.
 
 Returns:
 
 non-null iff name is non-null
 - getLabels
```
public Set<Label> getLabels()
```
 Gets all the active labels in the current system.
 - getLabelAtoms
```
public Set<LabelAtom> getLabelAtoms()
```
 - getQueue
```
public Queue getQueue()
```
 Specified by:
 
 getQueue in class AbstractCIBase
 - getDisplayName
```
public String getDisplayName()
```
 Specified by:
 
 getDisplayName in interface ModelObject
 
 Overrides:
 
 getDisplayName in class Node
 - getJDKs
```
public List<JDK> getJDKs()
```
 - setJDKs
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void setJDKs(Collection<? extends JDK> jdks)
```
 Replaces all JDK installations with those from the given collection. Use JDK.DescriptorImpl.setInstallations(JDK...) to set JDK installations from external code.
 - getJDK
```
public JDK getJDK(String name)
```
 Gets the JDK installation of the given name, or returns null.
 - getNode
```
@CheckForNull
public Node getNode(String name)
```
 Gets the agent node of the give name, hooked under this Jenkins.
 - getCloud
```
public Cloud getCloud(String name)
```
 Gets a Cloud by its name, or null.
 - getComputerMap
```
protected Map<Node,Computer> getComputerMap()
```
 Specified by:
 
 getComputerMap in class AbstractCIBase
 - getNodes
```
@NonNull
public List<Node> getNodes()
```
 Returns all Nodes in the system, excluding Jenkins instance itself which represents the built-in node (in other words, this only returns agents).
 
 Specified by:
 
 getNodes in class AbstractCIBase
 - getNodesObject
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Nodes getNodesObject()
```
 Get the Nodes object that handles maintaining individual Nodes.
 
 Returns:
 
 The Nodes object.
 - addNode
```
public void addNode(Node n)
 throws IOException
```
 Adds one more Node to Jenkins. If a node of the same name already exists then that node will be replaced.
 
 Throws:
 
 IOException
 - removeNode
```
public void removeNode(@NonNull
 Node n)
 throws IOException
```
 Removes a Node from Jenkins.
 
 Throws:
 
 IOException
 - updateNode
```
public boolean updateNode(Node n)
 throws IOException
```
 Saves an existing Node on disk, called by Node.save(). This method is preferred in those cases where you need to determine atomically that the node being saved is actually in the list of nodes.
 
 Parameters:
 
 n - the node to be updated.
 
 Returns:
 
 true, if the node was updated. false, if the node was not in the list of nodes.
 
 Throws:
 
 IOException - if the node could not be persisted.
 
 Since:
 
 1.634
 
 See Also:
 
 Nodes.updateNode(hudson.model.Node)
 - setNodes
```
public void setNodes(List<? extends Node> n)
 throws IOException
```
 Throws:
 
 IOException
 - getNodeProperties
```
public DescribableList<NodeProperty<?>,NodePropertyDescriptor> getNodeProperties()
```
 Description copied from class: Node
 
 Gets the NodeProperty instances configured for this Node.
 
 Specified by:
 
 getNodeProperties in class Node
 - getGlobalNodeProperties
```
public DescribableList<NodeProperty<?>,NodePropertyDescriptor> getGlobalNodeProperties()
```
 - getAdministrativeMonitor
```
@CheckForNull
public AdministrativeMonitor getAdministrativeMonitor(String id)
```
 Binds AdministrativeMonitors to URL.
 
 Parameters:
 
 id - Monitor ID
 
 Returns:
 
 The requested monitor or null if it does not exist
 - getActiveAdministrativeMonitors
```
public List<AdministrativeMonitor> getActiveAdministrativeMonitors()
```
 Returns the enabled and activated administrative monitors accessible to the current user.
 
 Since:
 
 2.64
 - getDescriptor
```
public NodeDescriptor getDescriptor()
```
 Description copied from interface: Describable
 
 Gets the descriptor for this instance.
 Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)
 
 Specified by:
 
 getDescriptor in interface Describable<Node>
 
 Specified by:
 
 getDescriptor in class Node
 - getQuietPeriod
```
public int getQuietPeriod()
```
 Gets the system default quiet period.
 - setQuietPeriod
```
public void setQuietPeriod(Integer quietPeriod)
 throws IOException
```
 Sets the global quiet period.
 
 Parameters:
 
 quietPeriod - null to the default value.
 
 Throws:
 
 IOException
 - getScmCheckoutRetryCount
```
public int getScmCheckoutRetryCount()
```
 Gets the global SCM check out retry count.
 - setScmCheckoutRetryCount
```
public void setScmCheckoutRetryCount(int scmCheckoutRetryCount)
 throws IOException
```
 Throws:
 
 IOException
 - getSearchUrl
```
public String getSearchUrl()
```
 Description copied from interface: SearchItem
 
 Returns the URL of this item relative to the parent SearchItem.
 
 Specified by:
 
 getSearchUrl in interface SearchItem
 
 Overrides:
 
 getSearchUrl in class Node
 
 Returns:
 
 URL like "foo" or "foo/bar". The path can end with '/'. The path that starts with '/' will be interpreted as the absolute path (within the context path of Jenkins.)
 - makeSearchIndex
```
public SearchIndexBuilder makeSearchIndex()
```
 Description copied from class: AbstractModelObject
 
 Default implementation that returns empty index.
 
 Overrides:
 
 makeSearchIndex in class AbstractModelObject
 - getUrlChildPrefix
```
public String getUrlChildPrefix()
```
 Description copied from interface: ItemGroup
 
 Gets the URL token that prefixes the URLs for child Items. Like "job", "item", etc.
 
 Specified by:
 
 getUrlChildPrefix in interface ItemGroup<TopLevelItem>
 - getRootUrl
```
@Nullable
public String getRootUrl()
 throws IllegalStateException
```
 Gets the absolute URL of Jenkins, such as http://localhost/jenkins/.
 This method first tries to use the manually configured value, then fall back to getRootUrlFromRequest(). It is done in this order so that it can work correctly even in the face of a reverse proxy.
 
 Returns:
 
 null if this parameter is not configured by the user and the calling thread is not in an HTTP request; otherwise the returned URL will always have the trailing /
 
 Throws:
 
 IllegalStateException - JenkinsLocationConfiguration cannot be retrieved. Jenkins instance may be not ready, or there is an extension loading glitch.
 
 Since:
 
 1.66
 
 See Also:
 
 Hyperlinks in HTML
 - getConfiguredRootUrl
```
@Exported(name="url")
 @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
 @CheckForNull
public String getConfiguredRootUrl()
```
 Exported alias for JenkinsLocationConfiguration.getUrl().
 - isRootUrlSecure
```
public boolean isRootUrlSecure()
```
 Is Jenkins running in HTTPS? Note that we can't really trust ServletRequest.isSecure() because HTTPS might be terminated in the reverse proxy.
 - getRootUrlFromRequest
```
@NonNull
public String getRootUrlFromRequest()
```
 Gets the absolute URL of Jenkins top page, such as http://localhost/jenkins/.
 Unlike getRootUrl(), which uses the manually configured value, this one uses the current request to reconstruct the URL. The benefit is that this is immune to the configuration mistake (users often fail to set the root URL correctly, especially when a migration is involved), but the downside is that unless you are processing a request, this method doesn't work.
 Please note that this will not work in all cases if Jenkins is running behind a reverse proxy which has not been fully configured. Specifically the Host and X-Forwarded-Proto headers must be set. Running Jenkins behind Apache shows some examples of configuration.
 
 Since:
 
 1.263
 - getRootDir
```
public File getRootDir()
```
 Description copied from interface: PersistenceRoot
 
 Gets the root directory on the file system that this Item can use freely for storing the configuration data.
 This parameter is given by the ItemGroup when Item is loaded from memory.
 
 Specified by:
 
 getRootDir in interface PersistenceRoot
 - getWorkspaceFor
```
public FilePath getWorkspaceFor(TopLevelItem item)
```
 Description copied from class: Node
 
 Returns a "workspace" directory for the given TopLevelItem.
 Workspace directory is usually used for keeping out the checked out source code, but it can be used for anything.
 
 Specified by:
 
 getWorkspaceFor in class Node
 
 Returns:
 
 null if this node is not connected hence the path is not available
 - getBuildDirFor
```
public File getBuildDirFor(Job job)
```
 - isDefaultBuildDir
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isDefaultBuildDir()
```
 If the configured buildsDir has it's default value or has been changed.
 
 Returns:
 
 true if default value.
 - expandVariablesForDirectory
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static String expandVariablesForDirectory(String base,
 String itemFullName,
 String itemRootDir)
```
 - getRawWorkspaceDir
```
public String getRawWorkspaceDir()
```
 - getRawBuildsDir
```
public String getRawBuildsDir()
```
 - setRawBuildsDir
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void setRawBuildsDir(String buildsDir)
```
 - getRootPath
```
@NonNull
public FilePath getRootPath()
```
 Description copied from class: Node
 
 Gets the root directory of this node.
 Hudson always owns a directory on every node. This method returns that.
 
 Specified by:
 
 getRootPath in class Node
 
 Returns:
 
 null if the node is offline and hence the FilePath object is not available.
 - createPath
```
public FilePath createPath(String absolutePath)
```
 Description copied from class: Node
 
 Gets the FilePath on this node.
 
 Overrides:
 
 createPath in class Node
 - getClockDifference
```
public ClockDifference getClockDifference()
```
 Description copied from class: Node
 
 Estimates the clock difference with this agent.
 
 Overrides:
 
 getClockDifference in class Node
 
 Returns:
 
 always non-null.
 - getClockDifferenceCallable
```
public hudson.remoting.Callable<ClockDifference,IOException> getClockDifferenceCallable()
```
 Description copied from class: Node
 
 Returns a Callable that when run on the channel, estimates the clock difference.
 
 Specified by:
 
 getClockDifferenceCallable in class Node
 
 Returns:
 
 always non-null.
 - getLog
```
public LogRecorderManager getLog()
```
 For binding LogRecorderManager to "/log". Everything below here is admin-only, so do the check here.
 - isUseSecurity
```
@Exported
public boolean isUseSecurity()
```
 A convenience method to check if there's some security restrictions in place.
 - isUseProjectNamingStrategy
```
public boolean isUseProjectNamingStrategy()
```
 - isUseCrumbs
```
@Exported
public boolean isUseCrumbs()
```
 If true, all the POST requests to Jenkins would have to have crumb in it to protect Jenkins from CSRF vulnerabilities.
 - getSecurity
```
public SecurityMode getSecurity()
```
 Returns the constant that captures the three basic security modes in Jenkins.
 - getSecurityRealm
```
public SecurityRealm getSecurityRealm()
```
 Returns:
 
 never null.
 - setSecurityRealm
```
public void setSecurityRealm(@CheckForNull
 SecurityRealm securityRealm)
```
 Sets a security realm.
 
 Parameters:
 
 securityRealm - Security realm to set. If null, SecurityRealm.NO_AUTHENTICATION will be set.
 - setAuthorizationStrategy
```
public void setAuthorizationStrategy(@CheckForNull
 AuthorizationStrategy a)
```
 Sets a new authorization strategy.
 
 Parameters:
 
 a - Authorization strategy to set. If null, AuthorizationStrategy.UNSECURED will be set
 - isDisableRememberMe
```
public boolean isDisableRememberMe()
```
 - setDisableRememberMe
```
public void setDisableRememberMe(boolean disableRememberMe)
```
 - disableSecurity
```
public void disableSecurity()
```
 - setProjectNamingStrategy
```
public void setProjectNamingStrategy(ProjectNamingStrategy ns)
```
 - getLifecycle
```
public Lifecycle getLifecycle()
```
 - getInjector
```
@CheckForNull
public com.google.inject.Injector getInjector()
```
 Gets the dependency injection container that hosts all the extension implementations and other components in Jenkins.
 
 Since:
 
 1.433
 - getExtensionList
```
public <T> ExtensionList<T> getExtensionList(Class<T> extensionType)
```
 Returns ExtensionList that retains the discovered instances for the given extension type.
 
 Parameters:
 
 extensionType - The base type that represents the extension point. Normally ExtensionPoint subtype but that's not a hard requirement.
 
 Returns:
 
 Can be an empty list but never null.
 
 See Also:
 
 ExtensionList.lookup(java.lang.Class<T>)
 - getExtensionList
```
@StaplerDispatchable
public ExtensionList getExtensionList(String extensionType)
 throws ClassNotFoundException
```
 Used to bind ExtensionLists to URLs.
 
 Throws:
 
 ClassNotFoundException
 
 Since:
 
 1.349
 - getDescriptorList
```
@NonNull
public <T extends Describable<T>,D extends Descriptor<T>> DescriptorExtensionList<T,D> getDescriptorList(Class<T> type)
```
 Returns ExtensionList that retains the discovered Descriptor instances for the given kind of Describable.
 
 Returns:
 
 Can be an empty list but never null.
 - refreshExtensions
```
public void refreshExtensions()
 throws ExtensionRefreshException
```
 Refresh ExtensionLists by adding all the newly discovered extensions. Exposed only for PluginManager.dynamicLoad(File).
 
 Throws:
 
 ExtensionRefreshException
 - getACL
```
@NonNull
public ACL getACL()
```
 Returns the root ACL.
 
 Specified by:
 
 getACL in interface AccessControlled
 
 Overrides:
 
 getACL in class Node
 
 Returns:
 
 never null.
 
 See Also:
 
 AuthorizationStrategy.getRootACL()
 - getAuthorizationStrategy
```
public AuthorizationStrategy getAuthorizationStrategy()
```
 Returns:
 
 never null.
 - getProjectNamingStrategy
```
public ProjectNamingStrategy getProjectNamingStrategy()
```
 The strategy used to check the project names.
 
 Returns:
 
 never null
 - isQuietingDown
```
@Exported
public boolean isQuietingDown()
```
 Returns true if Jenkins is quieting down.
 No further jobs will be executed unless it can be finished while other current pending builds are still in progress.
 - getQuietDownReason
```
@Exported
 @CheckForNull
public String getQuietDownReason()
```
 Returns quiet down reason if it was indicated.
 
 Returns:
 
 Reason if it was indicated. null otherwise
 
 Since:
 
 2.267
 - isTerminating
```
public boolean isTerminating()
```
 Returns true if the container initiated the termination of the web application.
 - getInitLevel
```
public InitMilestone getInitLevel()
```
 Gets the initialization milestone that we've already reached.
 
 Returns:
 
 InitMilestone.STARTED even if the initialization hasn't been started, so that this method never returns null.
 - setNumExecutors
```
public void setNumExecutors(int n)
 throws IOException,
 IllegalArgumentException
```
 Sets a number of executors.
 
 Parameters:
 
 n - Number of executors
 
 Throws:
 
 IOException - Failed to save the configuration
 
 IllegalArgumentException - Negative value has been passed
 - getItem
```
public TopLevelItem getItem(String name)
 throws org.springframework.security.access.AccessDeniedException
```
 Gets the Item inside this group that has a given name, or null if it does not exist.. Note that the look up is case-insensitive.
 
 Specified by:
 
 getItem in interface ItemGroup<TopLevelItem>
 
 Returns:
 
 an item whose Item.getName() is name and whose Item.getParent() is this, or null if there is no such item, or there is but the current user lacks both Item.DISCOVER and Item.READ on it
 
 Throws:
 
 org.springframework.security.access.AccessDeniedException - if the current user has Item.DISCOVER but not Item.READ on this item
 - getItem
```
public Item getItem(String pathName,
 ItemGroup context)
```
 Gets the item by its path name from the given context
 Path Names
 
 If the name starts from '/', like "/foo/bar/zot", then it's interpreted as absolute. Otherwise, the name should be something like "foo/bar" and it's interpreted like relative path name in the file system is, against the given context.
 For compatibility, as a fallback when nothing else matches, a simple path like foo/bar can also be treated with getItemByFullName(java.lang.String, java.lang.Class<T>).
 
 Parameters:
 
 context - null is interpreted as Jenkins. Base 'directory' of the interpretation.
 
 Since:
 
 1.406
 - getItem
```
public final Item getItem(String pathName,
 Item context)
```
 - getItem
```
public final <T extends Item> T getItem(String pathName,
 ItemGroup context,
 @NonNull
 Class<T> type)
```
 - getItem
```
public final <T extends Item> T getItem(String pathName,
 Item context,
 Class<T> type)
```
 - getRootDirFor
```
public File getRootDirFor(TopLevelItem child)
```
 Description copied from interface: ItemGroup
 
 Assigns the root directory for children.
 
 Specified by:
 
 getRootDirFor in interface ItemGroup<TopLevelItem>
 - getItemByFullName
```
@CheckForNull
public <T extends Item> T getItemByFullName(@NonNull
 String fullName,
 Class<T> type)
 throws org.springframework.security.access.AccessDeniedException
```
 Gets the Item object by its full name. Full names are like path names, where each name of Item is combined by '/'.
 
 Returns:
 
 null if either such Item doesn't exist under the given full name, or it exists but it's no an instance of the given type.
 
 Throws:
 
 org.springframework.security.access.AccessDeniedException - as per ItemGroup.getItem(java.lang.String)
 - getItemByFullName
```
@CheckForNull
public Item getItemByFullName(String fullName)
```
 - getUser
```
@CheckForNull
public User getUser(String name)
```
 Gets the user of the given name.
 
 Returns:
 
 the user of the given name (which may or may not be an id), if that person exists; else null
 
 See Also:
 
 User.get(String,boolean), User.getById(String, boolean)
 - createProject
```
public TopLevelItem createProject(TopLevelItemDescriptor type,
 String name)
 throws IOException
```
 Throws:
 
 IOException
 - createProject
```
public TopLevelItem createProject(TopLevelItemDescriptor type,
 String name,
 boolean notify)
 throws IOException
```
 Description copied from interface: ModifiableTopLevelItemGroup
 
 Creates a new job.
 
 Specified by:
 
 createProject in interface ModifiableTopLevelItemGroup
 
 Parameters:
 
 type - Descriptor for job type
 
 name - Name for job
 
 notify - Whether to fire onCreated method for all ItemListeners
 
 Throws:
 
 IOException
 - putItem
```
public void putItem(TopLevelItem item)
 throws IOException,
 InterruptedException
```
 Overwrites the existing item by new one.
 This is a short cut for deleting an existing job and adding a new one.
 
 Throws:
 
 IOException
 
 InterruptedException
 - createProject
```
public <T extends TopLevelItem> T createProject(Class<T> type,
 String name)
 throws IOException
```
 Creates a new job.
 This version infers the descriptor from the type of the top-level item.
 
 Throws:
 
 IllegalArgumentException - if the project of the given name already exists.
 
 IOException
 - onRenamed
```
public void onRenamed(TopLevelItem job,
 String oldName,
 String newName)
 throws IOException
```
 Called by Job.renameTo(String) to update relevant data structure. assumed to be synchronized on Jenkins by the caller.
 
 Specified by:
 
 onRenamed in interface ItemGroup<TopLevelItem>
 
 Throws:
 
 IOException
 - onDeleted
```
public void onDeleted(TopLevelItem item)
 throws IOException
```
 Called in response to AbstractItem.doDoDelete(StaplerRequest, StaplerResponse)
 
 Specified by:
 
 onDeleted in interface ItemGroup<TopLevelItem>
 
 Throws:
 
 IOException
 - canAdd
```
public boolean canAdd(TopLevelItem item)
```
 Description copied from interface: DirectlyModifiableTopLevelItemGroup
 
 Returns true if a particular item may be added to this group.
 
 Specified by:
 
 canAdd in interface DirectlyModifiableTopLevelItemGroup
 
 Parameters:
 
 item - an item currently elsewhere
 
 Returns:
 
 true if DirectlyModifiableTopLevelItemGroup.add(I, java.lang.String) may be called with this item
 - add
```
public  I add(I item,
 String name)
 throws IOException,
 IllegalArgumentException
```
 Description copied from interface: DirectlyModifiableTopLevelItemGroup
 
 Adds an item to this group. Unlike putItem(hudson.model.TopLevelItem) this does not try to call Item.delete() on an existing item, nor does it fire ItemListener.onCreated(hudson.model.Item), nor check permissions. Normally you would call Item.onLoad(hudson.model.ItemGroup<? extends hudson.model.Item>, java.lang.String) after calling this method (the implementation is not expected to do so).
 
 Specified by:
 
 add in interface DirectlyModifiableTopLevelItemGroup
 
 Type Parameters:
 
 I - the kind of item
 
 Parameters:
 
 item - an item to add which is currently elsewhere
 
 name - the desired item name in this group (might simply be the original Item.getName())
 
 Returns:
 
 normally the same item, but might be a new copy if necessary
 
 Throws:
 
 IOException - if adding fails
 
 IllegalArgumentException - if DirectlyModifiableTopLevelItemGroup.canAdd(hudson.model.TopLevelItem) is false, or an item with this name already exists, or this item is as yet unnamed
 - remove
```
public void remove(TopLevelItem item)
 throws IOException,
 IllegalArgumentException
```
 Description copied from interface: DirectlyModifiableTopLevelItemGroup
 
 Removes an item from this group. Unlike ItemGroup.onDeleted(T) this is not expected to fire any events.
 
 Specified by:
 
 remove in interface DirectlyModifiableTopLevelItemGroup
 
 Parameters:
 
 item - an item which was part of this group
 
 Throws:
 
 IOException - if removing fails
 
 IllegalArgumentException - if this was not part of the group to begin with
 - getFingerprintMap
```
public FingerprintMap getFingerprintMap()
```
 - getFingerprint
```
@StaplerDispatchable
public Object getFingerprint(String md5sum)
 throws IOException
```
 Throws:
 
 IOException
 - _getFingerprint
```
public Fingerprint _getFingerprint(String md5sum)
 throws IOException
```
 Gets a Fingerprint object if it exists. Otherwise null.
 
 Throws:
 
 IOException
 - getNumExecutors
```
public int getNumExecutors()
```
 Description copied from class: Node
 
 Returns the number of Executors. This may be different from getExecutors().size() because it takes time to adjust the number of executors.
 
 Specified by:
 
 getNumExecutors in class Node
 - getMode
```
public Node.Mode getMode()
```
 Description copied from class: Node
 
 Returns Node.Mode.EXCLUSIVE if this node is only available for those jobs that exclusively specifies this node as the assigned node.
 
 Specified by:
 
 getMode in class Node
 - setMode
```
public void setMode(Node.Mode m)
 throws IOException
```
 Throws:
 
 IOException
 - getLabelString
```
public String getLabelString()
```
 Description copied from class: Node
 
 Returns the manually configured label for a node. The list of assigned and dynamically determined labels is available via Node.getAssignedLabels() and includes all labels that have been manually configured. Mainly for form binding.
 
 Specified by:
 
 getLabelString in class Node
 - setLabelString
```
public void setLabelString(String label)
 throws IOException
```
 Description copied from class: Node
 
 Sets the label string for a node. This value will be returned by Node.getLabelString().
 
 Overrides:
 
 setLabelString in class Node
 
 Parameters:
 
 label - The new label string to use.
 
 Throws:
 
 IOException
 - getSelfLabel
```
@NonNull
public LabelAtom getSelfLabel()
```
 Description copied from class: Node
 
 Gets the special label that represents this node itself.
 
 Overrides:
 
 getSelfLabel in class Node
 - createComputer
```
@NonNull
public Computer createComputer()
```
 Description copied from class: Node
 
 Creates a new Computer object that acts as the UI peer of this Node. Nobody but updateComputerList() should call this method.
 
 Specified by:
 
 createComputer in class Node
 
 Returns:
 
 Created instance of the computer. Can be null if the Node implementation does not support it (e.g. Cloud agent).
 - save
```
public void save()
 throws IOException
```
 Save the settings to a file.
 
 Specified by:
 
 save in interface Saveable
 
 Overrides:
 
 save in class Node
 
 Throws:
 
 IOException - if the persistence failed.
 - cleanUp
```
public void cleanUp()
```
 Called to shut down the system.
 - getDynamic
```
public Object getDynamic(String token)
```
 - doConfigSubmit
```
@POST
public void doConfigSubmit(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException,
 Descriptor.FormException
```
 Accepts submission from the configuration page.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 
 Descriptor.FormException
 - getCrumbIssuer
```
@CheckForNull
public CrumbIssuer getCrumbIssuer()
```
 Gets the CrumbIssuer currently in use.
 
 Returns:
 
 null if none is in use.
 - setCrumbIssuer
```
public void setCrumbIssuer(CrumbIssuer issuer)
```
 - doTestPost
```
public void doTestPost(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - doConfigExecutorsSubmit
```
@POST
public void doConfigExecutorsSubmit(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException,
 Descriptor.FormException
```
 Accepts submission from the node configuration page.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 
 Descriptor.FormException
 - doSubmitDescription
```
public void doSubmitDescription(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Accepts the new description.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - doQuietDown
```
public org.kohsuke.stapler.HttpRedirect doQuietDown()
```
 - doQuietDown
```
@Deprecated
public org.kohsuke.stapler.HttpRedirect doQuietDown(boolean block,
 int timeout)
```
 Deprecated. since 2.267; use doQuietDown(boolean, int, String) instead.
 
 Quiet down Jenkins - preparation for a restart Presented for compatibility.
 
 Parameters:
 
 block - Block until the system really quiets down and no builds are running
 
 timeout - If non-zero, only block up to the specified number of milliseconds
 - doQuietDown
```
public org.kohsuke.stapler.HttpRedirect doQuietDown(@QueryParameter
 boolean block,
 @QueryParameter
 int timeout,
 @QueryParameter @CheckForNull
 String reason)
 throws InterruptedException,
 IOException
```
 Quiet down Jenkins - preparation for a restart
 
 Parameters:
 
 block - Block until the system really quiets down and no builds are running
 
 timeout - If non-zero, only block up to the specified number of milliseconds
 
 reason - Quiet reason that will be visible to user
 
 Throws:
 
 InterruptedException
 
 IOException
 
 Since:
 
 2.267
 - doCancelQuietDown
```
public org.kohsuke.stapler.HttpRedirect doCancelQuietDown()
```
 Cancel previous quiet down Jenkins - preparation for a restart
 - doToggleCollapse
```
public org.kohsuke.stapler.HttpResponse doToggleCollapse()
 throws javax.servlet.ServletException,
 IOException
```
 Throws:
 
 javax.servlet.ServletException
 
 IOException
 - doClassicThreadDump
```
public void doClassicThreadDump(org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Backward compatibility. Redirect to the thread dump.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - getAllThreadDumps
```
public Map<String,Map<String,String>> getAllThreadDumps()
 throws IOException,
 InterruptedException
```
 Obtains the thread dump of all agents (including the controller/built-in node.)
 Since this is for diagnostics, it has a built-in precautionary measure against hang agents.
 
 Throws:
 
 IOException
 
 InterruptedException
 - doCreateItem
```
public TopLevelItem doCreateItem(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Description copied from interface: ModifiableItemGroup
 
 The request format follows that of <n:form xmlns:n="/lib/form">.
 
 Specified by:
 
 doCreateItem in interface ModifiableItemGroup<TopLevelItem>
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - createProjectFromXML
```
public TopLevelItem createProjectFromXML(String name,
 InputStream xml)
 throws IOException
```
 Description copied from interface: ModifiableTopLevelItemGroup
 
 Creates a new job from its configuration XML. The type of the job created will be determined by what's in this XML.
 
 Specified by:
 
 createProjectFromXML in interface ModifiableTopLevelItemGroup
 
 Parameters:
 
 name - Name of the newly created project.
 
 xml - Item configuration as xml
 
 Returns:
 
 Newly created TopLevelItem.
 
 Throws:
 
 IOException
 
 Since:
 
 1.319
 - copy
```
public <T extends TopLevelItem> T copy(T src,
 String name)
 throws IOException
```
 Description copied from interface: ModifiableTopLevelItemGroup
 
 Copies a job.
 
 Specified by:
 
 copy in interface ModifiableTopLevelItemGroup
 
 Parameters:
 
 src - A TopLevelItem to be copied.
 
 name - Name of the newly created project.
 
 Returns:
 
 Newly created TopLevelItem.
 
 Throws:
 
 IOException
 - copy
```
public <T extends AbstractProject<?,?>> T copy(T src,
 String name)
 throws IOException
```
 Throws:
 
 IOException
 - doCreateView
```
@POST
public void doCreateView(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException,
 Descriptor.FormException
```
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 
 Descriptor.FormException
 - checkGoodName
```
public static void checkGoodName(String name)
 throws Failure
```
 Check if the given name is suitable as a name for job, view, etc.
 
 Throws:
 
 Failure - if the given name is not good
 - doSecured
```
public void doSecured(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Checks if the user was successfully authenticated.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 
 See Also:
 
 BasicAuthenticationFilter
 - doLoginEntry
```
public void doLoginEntry(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException
```
 Called once the user logs in. Just forward to the top page. Used only by LegacySecurityRealm.
 
 Throws:
 
 IOException
 - doLogout
```
public void doLogout(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Logs out the user.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - getJnlpJars
```
public Slave.JnlpJar getJnlpJars(String fileName)
```
 Serves jar files for inbound agents.
 - doJnlpJars
```
public Slave.JnlpJar doJnlpJars(org.kohsuke.stapler.StaplerRequest req)
```
 - doReload
```
public org.kohsuke.stapler.HttpResponse doReload()
 throws IOException
```
 Reloads the configuration.
 
 Throws:
 
 IOException
 - reload
```
public void reload()
 throws IOException,
 InterruptedException,
 org.jvnet.hudson.reactor.ReactorException
```
 Reloads the configuration synchronously. Beware that this calls neither ItemListener.onLoaded() nor Initializers.
 
 Throws:
 
 IOException
 
 InterruptedException
 
 org.jvnet.hudson.reactor.ReactorException
 - doDoFingerprintCheck
```
public void doDoFingerprintCheck(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Do a finger-print check.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - doGc
```
public void doGc(org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException
```
 For debugging. Expose URL to perform GC.
 
 Throws:
 
 IOException
 - doException
```
@StaplerDispatchable
public void doException()
```
 End point that intentionally throws an exception to test the error behaviour.
 
 Since:
 
 1.467
 - doContextMenu
```
public ModelObjectWithContextMenu.ContextMenu doContextMenu(org.kohsuke.stapler.StaplerRequest request,
 org.kohsuke.stapler.StaplerResponse response)
 throws IOException,
 org.apache.commons.jelly.JellyException
```
 Description copied from interface: ModelObjectWithContextMenu
 
 Generates the context menu. The typical implementation is return new ContextMenu().from(this,request,response);, which implements the default behaviour. See ModelObjectWithContextMenu.ContextMenu.from(ModelObjectWithContextMenu, StaplerRequest, StaplerResponse) for more details of what it does. This should suit most implementations.
 
 Specified by:
 
 doContextMenu in interface ModelObjectWithContextMenu
 
 Throws:
 
 IOException
 
 org.apache.commons.jelly.JellyException
 - doChildrenContextMenu
```
public ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest request,
 org.kohsuke.stapler.StaplerResponse response)
 throws Exception
```
 Description copied from interface: ModelObjectWithChildren
 
 Generates the context menu to list up all the children.
 
 Specified by:
 
 doChildrenContextMenu in interface ModelObjectWithChildren
 
 Throws:
 
 Exception
 - getHeapDump
```
public RemotingDiagnostics.HeapDump getHeapDump()
 throws IOException
```
 Obtains the heap dump.
 
 Throws:
 
 IOException
 - doSimulateOutOfMemory
```
public void doSimulateOutOfMemory()
 throws IOException
```
 Simulates OutOfMemoryError. Useful to make sure OutOfMemoryHeapDump setting.
 
 Throws:
 
 IOException
 - doUserContent
```
public DirectoryBrowserSupport doUserContent()
```
 Binds /userContent/... to $JENKINS_HOME/userContent.
 - doRestart
```
@CLIMethod(name="restart")
public void doRestart(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException,
 RestartNotSupportedException
```
 Perform a restart of Jenkins, if we can. This first replaces "app" to HudsonIsRestarting
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 
 RestartNotSupportedException
 - doSafeRestart
```
@CLIMethod(name="safe-restart")
public org.kohsuke.stapler.HttpResponse doSafeRestart(org.kohsuke.stapler.StaplerRequest req)
 throws IOException,
 javax.servlet.ServletException,
 RestartNotSupportedException
```
 Queues up a restart of Jenkins for when there are no builds running, if we can. This first replaces "app" to HudsonIsRestarting
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 
 RestartNotSupportedException
 
 Since:
 
 1.332
 - restart
```
public void restart()
 throws RestartNotSupportedException
```
 Performs a restart.
 
 Throws:
 
 RestartNotSupportedException
 - safeRestart
```
public void safeRestart()
 throws RestartNotSupportedException
```
 Queues up a restart to be performed once there are no builds currently running.
 
 Throws:
 
 RestartNotSupportedException
 
 Since:
 
 1.332
 - doExit
```
@CLIMethod(name="shutdown")
public void doExit(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException
```
 Shutdown the system.
 
 Throws:
 
 IOException
 
 Since:
 
 1.161
 - doSafeExit
```
@CLIMethod(name="safe-shutdown")
public org.kohsuke.stapler.HttpResponse doSafeExit(org.kohsuke.stapler.StaplerRequest req)
 throws IOException
```
 Shutdown the system safely.
 
 Throws:
 
 IOException
 
 Since:
 
 1.332
 - getAuthentication2
```
@NonNull
public static org.springframework.security.core.Authentication getAuthentication2()
```
 Gets the Authentication object that represents the user associated with the current request.
 
 Since:
 
 2.266
 - getAuthentication
```
@Deprecated
 @NonNull
public static Authentication getAuthentication()
```
 Deprecated. use getAuthentication2()
 - doScript
```
public void doScript(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 For system diagnostics. Run arbitrary Groovy script.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - doScriptText
```
public void doScriptText(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Run arbitrary Groovy script and return result as plain text.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - _doScript
```
public static void _doScript(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp,
 javax.servlet.RequestDispatcher view,
 hudson.remoting.VirtualChannel channel,
 ACL acl)
 throws IOException,
 javax.servlet.ServletException
```
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 
 Since:
 
 1.509.1
 - doEval
```
public void doEval(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Evaluates the Jelly script submitted by the client. This is useful for system administration as well as unit testing.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - doSignup
```
public void doSignup(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Sign up for the user account.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - doIconSize
```
public void doIconSize(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Changes the icon size by changing the cookie
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - doFingerprintCleanup
```
public void doFingerprintCleanup(org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException
```
 Throws:
 
 IOException
 - doWorkspaceCleanup
```
public void doWorkspaceCleanup(org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException
```
 Throws:
 
 IOException
 - doDefaultJDKCheck
```
public FormValidation doDefaultJDKCheck(org.kohsuke.stapler.StaplerRequest request,
 @QueryParameter
 String value)
```
 If the user chose the default JDK, make sure we got 'java' in PATH.
 - doCheckViewName
```
public FormValidation doCheckViewName(@QueryParameter
 String value)
```
 Checks if a top-level view with the given name exists and make sure that the name is good as a view name.
 - doViewExistsCheck
```
@Deprecated
public FormValidation doViewExistsCheck(@QueryParameter
 String value)
```
 Deprecated. 1.512
 
 Checks if a top-level view with the given name exists.
 - doResources
```
public void doResources(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
 throws IOException,
 javax.servlet.ServletException
```
 Serves static resources placed along with Jelly view files.
 This method can serve a lot of files, so care needs to be taken to make this method secure. It's not clear to me what's the best strategy here, though the current implementation is based on file extensions.
 
 Throws:
 
 IOException
 
 javax.servlet.ServletException
 - doCheckURIEncoding
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="2.37")
 @Deprecated
public FormValidation doCheckURIEncoding(org.kohsuke.stapler.StaplerRequest request)
 throws IOException
```
 Deprecated.
 
 Checks if container uses UTF-8 to decode URLs. See http://wiki.jenkins-ci.org/display/JENKINS/Tomcat#Tomcat-i18n
 
 Throws:
 
 IOException
 - isCheckURIEncodingEnabled
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="2.37")
 @Deprecated
public static boolean isCheckURIEncodingEnabled()
```
 Deprecated.
 
 Does not check when system default encoding is "ISO-8859-1".
 - rebuildDependencyGraph
```
public void rebuildDependencyGraph()
```
 Rebuilds the dependency map.
 - rebuildDependencyGraphAsync
```
public Future<DependencyGraph> rebuildDependencyGraphAsync()
```
 Rebuilds the dependency map asynchronously.
 This would keep the UI thread more responsive and helps avoid the deadlocks, as dependency graph recomputation tends to touch a lot of other things.
 
 Since:
 
 1.522
 - getDependencyGraph
```
public DependencyGraph getDependencyGraph()
```
 - getManagementLinks
```
public List<ManagementLink> getManagementLinks()
```
 - getCategorizedManagementLinks
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Map<ManagementLink.Category,List<ManagementLink>> getCategorizedManagementLinks()
```
 - getSetupWizard
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public SetupWizard getSetupWizard()
```
 If set, a currently active setup wizard - e.g. installation
 
 Since:
 
 2.0
 - getMe
```
public User getMe()
```
 Exposes the current user to /me URL.
 - getWidgets
```
@StaplerDispatchable
public List<Widget> getWidgets()
```
 Gets the Widgets registered on this object.
 Plugins who wish to contribute boxes on the side panel can add widgets by getWidgets().add(new MyWidget()) from Plugin.start().
 - getTarget
```
public Object getTarget()
```
 Specified by:
 
 getTarget in interface org.kohsuke.stapler.StaplerProxy
 - isSubjectToMandatoryReadPermissionCheck
```
public boolean isSubjectToMandatoryReadPermissionCheck(String restOfPath)
```
 Test a path to see if it is subject to mandatory read permission checks by container-managed security
 
 Parameters:
 
 restOfPath - the URI, excluding the Jenkins root URI and query string
 
 Returns:
 
 true if the path is subject to mandatory read permission checks
 
 Since:
 
 2.37
 - getUnprotectedRootActions
```
public Collection<String> getUnprotectedRootActions()
```
 Gets a list of unprotected root actions. These URL prefixes should be exempted from access control checks by container-managed security. Ideally would be synchronized with getTarget().
 
 Returns:
 
 a list of URL names
 
 Since:
 
 1.495
 - getStaplerFallback
```
public View getStaplerFallback()
```
 Fallback to the primary view.
 
 Specified by:
 
 getStaplerFallback in interface org.kohsuke.stapler.StaplerFallback
 - doCheckDisplayName
```
public FormValidation doCheckDisplayName(@QueryParameter
 String displayName,
 @QueryParameter
 String jobName)
```
 Checks to see if the candidate displayName collides with any existing display names or project names
 
 Parameters:
 
 displayName - The display name to test
 
 jobName - The name of the job the user is configuring
 - lookup
```
@CheckForNull
public static <T> T lookup(Class<T> type)
```
 Shortcut for Jenkins.getInstanceOrNull()?.lookup.get(type)
 - getVersion
```
@CheckForNull
public static VersionNumber getVersion()
```
 Parses VERSION into VersionNumber, or null if it's not parseable as a version number (such as when Jenkins is run with mvn jetty:run)
 - getStoredVersion
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @CheckForNull
public static VersionNumber getStoredVersion()
```
 Get the stored version of Jenkins, as stored by doConfigSubmit(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse).
 Parses the version into VersionNumber, or null if it's not parseable as a version number (such as when Jenkins is run with mvn jetty:run)
 
 Since:
 
 2.0
 - shouldShowStackTrace
```
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean shouldShowStackTrace()
```

Class Jenkins

Nested Class Summary

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

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

Field Summary

Fields inherited from class hudson.model.AbstractCIBase

Fields inherited from class hudson.model.Node

Fields inherited from interface hudson.model.Saveable

Constructor Summary

Method Summary

Methods inherited from class hudson.model.AbstractCIBase

Methods inherited from class hudson.model.Node

Methods inherited from class hudson.model.AbstractModelObject

Methods inherited from class java.lang.Object

Methods inherited from interface hudson.model.ItemGroup

Methods inherited from interface hudson.model.ViewGroup

Methods inherited from interface hudson.security.AccessControlled

Field Detail

lookup

root

computers

clouds

slaves

pluginManager

tcpSlaveAgentListener

overallLoad

unlabeledLoad

unlabeledNodeProvisioner

overallNodeProvisioner

servletContext

administrativeMonitors

proxy

ALLOWED_RESOURCE_EXTENSIONS

logRecords

XSTREAM

XSTREAM2

UNCOMPUTED_VERSION

VERSION

CHANGELOG_URL

VERSION_HASH

SESSION_HASH

RESOURCE_PATH

VIEW_RESOURCE_PATH

PARALLEL_LOAD

KILL_AFTER_LOAD

FLYWEIGHT_SUPPORT

CONCURRENT_BUILD

NAME_VALIDATION_REJECTS_TRAILING_DOT_PROP

AUTOMATIC_SLAVE_LAUNCH

PERMISSIONS

ADMINISTER

MANAGE

SYSTEM_READ

MANAGE_AND_SYSTEM_READ

READ

RUN_SCRIPTS

ANONYMOUS2

ANONYMOUS

Constructor Detail

Jenkins

Jenkins

Method Detail

get

getActiveInstance

getInstanceOrNull

getInstance

readResolve

getProxy

setProxy

getInstallState

setInstallState

getTcpSlaveAgentListener

getAdjuncts

getSlaveAgentPort

isSlaveAgentPortEnforced

setSlaveAgentPort

getAgentProtocols

setAgentProtocols

setNodeName