Uses of Interface
hudson.model.Describable
Packages that use Describable
Package
Description
Beef up the plain text console output by adding HTML markup.
Core object model that are bound to URLs via stapler, rooted at
Jenkins.Boolean expression over labels.
Code that monitors the health of agents
Jenkins's interface with source code management systems.
QuickSilver-like search/jump capability for better navigation around Jenkins.
Security-related code.
Code related to agents.
Built-in
Triggers that run periodically to kick a new build.Other miscellaneous utility code
-
Uses of Describable in hudson
Classes in hudson with type parameters of type DescribableModifier and TypeClassDescriptionclassDescriptorExtensionList<T extends Describable<T>,D extends Descriptor<T>> ExtensionListfor holding a set ofDescriptors, which is a group of descriptors for the same extension point.Classes in hudson that implement DescribableModifier and TypeClassDescriptionclassDeprecated.Unused.static final classDeprecated.final classHTTP proxy configuration.classMethods in hudson with type parameters of type DescribableModifier and TypeMethodDescriptionstatic <T extends Describable<T>,D extends Descriptor<T>>
DescriptorExtensionList<T, D> DescriptorExtensionList.createDescriptorList(Hudson hudson, Class<T> describableType) Deprecated.as of 1.416 UseExtensionList.create(Jenkins, Class)static <T extends Describable<T>,D extends Descriptor<T>>
DescriptorExtensionList<T, D> DescriptorExtensionList.createDescriptorList(Jenkins jenkins, Class<T> describableType) Creates a new instance.Method parameters in hudson with type arguments of type DescribableModifier and TypeMethodDescriptionbooleanExtensionComponent.isDescriptorOf(Class<? extends Describable> c) Checks if this component is aDescriptordescribing the given type For example,component.isDescriptorOf(Builder.class) -
Uses of Describable in hudson.console
Classes in hudson.console that implement DescribableModifier and TypeClassDescriptionclassConsoleNote<T>Data that hangs off from a console output.classRenders a button that can be clicked to reveal additional block tag (and HTML inside it.)classTurns a text into a hyperlink by specifying the URL separately.classHyperlinkNotethat links to a model object, which in the UI gets rendered with context menu and etc. -
Uses of Describable in hudson.markup
Classes in hudson.markup that implement DescribableModifier and TypeClassDescriptionclassMarkupFormatterthat treats the input as the escaped html.classGeneralization of a function that takes text with some markup and converts that to HTML. -
Uses of Describable in hudson.model
Classes in hudson.model with type parameters of type DescribableModifier and TypeInterfaceDescriptioninterfaceDescribable<T extends Describable<T>>Classes that are described byDescriptor.classDescriptor<T extends Describable<T>>Metadata about a configurable instance.Subinterfaces of Describable in hudson.modelModifier and TypeInterfaceDescriptioninterfaceReconfigurableDescribable<T extends ReconfigurableDescribable<T>>Marks modernDescribables that allow the current instances to pass information down to the next instance when the configuration is submitted.interfaceClasses in hudson.model that implement DescribableModifier and TypeClassDescriptionclassclassAbstractDescribableImpl<T extends AbstractDescribableImpl<T>>Deprecated.ImplementDescribabledirectly.classViewthat contains everything.classParameterDefinitionthat is either 'true' or 'false'.classfinal classServes as the top ofComputers in the URL hierarchy.classParameterDefinitionfor doing file upload.classFree-style software project.classfinal classInformation about JDK installation.classJobProperty<J extends Job<?,?>> Extensible property ofJob.classDisplaysJobs in a flat list view.classViewthat only contains projects for which the current user has access to.classA UserProperty that remembers user-private views.classBase type of Jenkins agents (although in practice, you probably extendSlaveto define a new agent type).classParticipates in the rendering of HTML pages for all pages of Hudson.classclassDefines a parameter for a build.classKeeps a list of the parameters defined for a project.classParameter whose value is aSecretand is hidden from the UI.classA view that delegates to another.classclassConvenient base class forParameterDefinitionwhose value can be represented in a context-independent single string token.classInformation about a Hudson agent node.classParameter whose value is a string value.classStringParameterDefinitionthat uses textarea, instead of text box.classA UserProperty that allows a user to specify a time zone for displaying time.classstatic classResolves User IDs by ID, full names or other strings.static classResolve user ID from full namestatic classTries to verify if an ID is valid.classExtensible property ofUser.classEncapsulates the rendering of the list ofTopLevelItems thatJenkinsowns.classExtensible property ofView.Methods in hudson.model with type parameters of type DescribableModifier and TypeMethodDescriptionprotected final <T extends Describable<T>>
voidprotected final <T extends Describable<T>>
List<T> AbstractProject.buildDescribable(org.kohsuke.stapler.StaplerRequest2 req, List<? extends Descriptor<T>> descriptors) protected final <T extends Describable<T>>
List<T> AbstractProject.buildDescribable(org.kohsuke.stapler.StaplerRequest req, List<? extends Descriptor<T>> descriptors, String prefix) Deprecated.As of 1.261.static <T extends Describable<T>>
List<T> Descriptor.newInstancesFromHeteroList(org.kohsuke.stapler.StaplerRequest2 req, Object formData, Collection<? extends Descriptor<T>> descriptors) static <T extends Describable<T>>
List<T> Descriptor.newInstancesFromHeteroList(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData, String key, Collection<? extends Descriptor<T>> descriptors) Used to buildDescribableinstance list from<f:hetero-list>tag.static <T extends Describable<T>>
List<T> Descriptor.newInstancesFromHeteroList(org.kohsuke.stapler.StaplerRequest req, Object formData, Collection<? extends Descriptor<T>> descriptors) static <T extends Describable<T>>
List<T> Descriptor.newInstancesFromHeteroList(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData, String key, Collection<? extends Descriptor<T>> descriptors) protected final <T extends Describable<T>>
voidAbstractProject.removeFromList(Descriptor<T> item, List<T> collection) static <T extends Describable<T>>
Map<Descriptor<T>, T> Method parameters in hudson.model with type arguments of type DescribableModifier and TypeMethodDescriptionprotected voidDescriptor.addHelpFileRedirect(String fieldName, Class<? extends Describable> owner, String fieldNameToRedirectTo) Tells Jenkins that the help file for the field 'fieldName' is defined in the help file for the 'fieldNameToRedirectTo' in the 'owner' class. -
Uses of Describable in hudson.model.labels
Classes in hudson.model.labels that implement Describable -
Uses of Describable in hudson.node_monitors
Classes in hudson.node_monitors that implement DescribableModifier and TypeClassDescriptionclassclassDiscovers the architecture of the system to display in the agent list page.classNodeMonitorthat checks clock ofNodeto detect out of sync clocks.classChecks available disk space of the remote FS root.classNodePropertythat allows users to set agent specific disk space thresholds.classExtension point for managing and monitoringNodes.classMonitors the round-trip response time to this agent.classChecks the swap space availability.classMonitors the disk space of "/tmp". -
Uses of Describable in hudson.scm
Classes in hudson.scm that implement DescribableModifier and TypeClassDescriptionclassNoSCM.classRepositoryBrowser<E extends ChangeLogSet.Entry>Connects Hudson to repository browsers like ViewCVS or FishEye, so that Hudson can generate links to them.classCaptures the configuration information in it. -
Uses of Describable in hudson.search
Classes in hudson.search that implement Describable -
Uses of Describable in hudson.security
Classes in hudson.security that implement DescribableModifier and TypeClassDescriptionclassPartial implementation ofSecurityRealmfor username/password based authentication.classControls authorization throughout Hudson.static final classclassRemembers identifiers given byFederatedLoginServiceto this user.classAuthorizationStrategythat grants full-control to authenticated user and optionally read access to anonymous usersclassSecurity configuration.classSecurityRealmthat performs authentication by looking upUser.static final classUserPropertythat provides theUserDetailsview of the User object.final classAuthorizationStrategyimplementation that emulates the legacy behavior.final classSecurityRealmthat acceptsContainerAuthenticationobject without any check (that is, by assuming that the such token is already authenticated by the container.)classPluggable security realm that connects external user database to Hudson. -
Uses of Describable in hudson.security.captcha
Classes in hudson.security.captcha that implement DescribableModifier and TypeClassDescriptionclassExtension point for adding Captcha Support to User Registration PageCaptchaSupport. -
Uses of Describable in hudson.security.csrf
Classes in hudson.security.csrf that implement DescribableModifier and TypeClassDescriptionclassA CrumbIssuer represents an algorithm to generate a nonce value, known as a crumb, to counter cross site request forgery exploits.classA crumb issuing algorithm based on the request principal and the remote address.classShow the crumb configuration to the system config page. -
Uses of Describable in hudson.slaves
Classes in hudson.slaves that implement DescribableModifier and TypeClassDescriptionclassclassPartial implementation ofSlaveto be used byAbstractCloudImpl.classCreatesNodes to dynamically expand/shrink the agents attached to Hudson.classRetentionStrategyimplementation forAbstractCloudComputerthat terminates it if it remains idle for X minutes.classCloudSlaveRetentionStrategy<T extends Computer>Default convenience implementation ofRetentionStrategyfor agents provisioned fromCloud.classFactory ofComputerLauncher.classExtension point to allow control over howComputers are "launched", meaning how they get connected to their agent program.classComputerLauncherfilter that can be used as a base class for decorators.classBase implementation ofComputerLauncherthat to be used by launchers that perform some initialization (typically something cloud/v12n related to power up the machine), and then delegate to anotherComputerLauncherto connect.final classDefaultSlaveimplementation for computers that do not belong to a higher level structure, like grid or cloud.classNodePropertythat sets additional environment variables.classComputerLaunchervia inbound connections.classNodeProperty<N extends Node>Extensible property ofNode.classRetentionStrategy<T extends Computer>Controls when to takeComputeroffline, bring it back online, or even to destroy it.static classRetentionStrategythat tries to keep the node online all the time.static classRetentionStrategythat tries to keep the node offline when not in use.classRetentionStrategythat controls the agent based on a schedule. -
Uses of Describable in hudson.tasks
Classes in hudson.tasks with type parameters of type DescribableClasses in hudson.tasks that implement DescribableModifier and TypeClassDescriptionclassCopies the artifacts into an archive directory.classExecutes commands by using Windows batch file.classBuildSteps that perform the actual build.classTriggers builds of other projects.classPluggability point for performing pre/post actions for the build process.classclassRecords fingerprints of the specified files.classDefault implementation ofBuildDiscarder.classBuild by using Maven.static final classRepresents a Maven installation in a system.static classAutomatic Maven installer from apache.org.classBuildSteps that run after the build is completed.classBuildSteps that run after the build is completed.classBuildSteps that run after the build is completed.classExecutes a series of commands by using a shell.Methods in hudson.tasks with type parameters of type DescribableModifier and TypeMethodDescriptionstatic <T extends BuildStep & Describable<T>>
List<Descriptor<T>> BuildStepDescriptor.filter(List<Descriptor<T>> base, Class<? extends AbstractProject> type) Filters a descriptor forBuildSteps by usingBuildStepDescriptor.isApplicable(Class). -
Uses of Describable in hudson.tasks._maven
Classes in hudson.tasks._maven that implement DescribableModifier and TypeClassDescriptionclassMarks the log line that reports that Maven3 is executing a mojo.classclassMarks the log line that reports that Maven is executing a mojo.classMarks the warning messages from Maven. -
Uses of Describable in hudson.tools
Classes in hudson.tools with type parameters of type DescribableModifier and TypeClassDescriptionclassPropertyDescriptor<P extends Describable<P>,T> BaseDescriptortype used forXyzPropertyclasses.Classes in hudson.tools that implement DescribableModifier and TypeClassDescriptionclassA generic script-based installer.classInstalls tool via script execution of Batch script.classInstalls a tool by running an arbitrary shell command.classPartial convenience implementation ofToolInstallerthat just downloads an archive from the URL and extracts it.classToolPropertythat shows auto installation options.classFormalization of a tool installed in nodes used for builds.classAn object which can ensure that a genericToolInstallationin fact exists on a node.classNodePropertythat allows users to specify different locations forToolInstallations.classToolProperty<T extends ToolInstallation>Extensible property ofToolInstallation.classInstalls a tool into the Hudson working area by downloading and unpacking a ZIP file. -
Uses of Describable in hudson.triggers
Classes in hudson.triggers that implement Describable -
Uses of Describable in hudson.util
Classes in hudson.util with type parameters of type DescribableModifier and TypeClassDescriptionclassDescribableList<T extends Describable<T>,D extends Descriptor<T>> Persisted list ofDescribables with some operations specific toDescriptors.final classDescriptorList<T extends Describable<T>>List ofDescriptors.Methods in hudson.util that return DescribableMethods in hudson.util with parameters of type DescribableMethod parameters in hudson.util with type arguments of type DescribableModifier and TypeMethodDescriptionvoidDescriptorList.load(Class<? extends Describable> c) No-op method used to force the class initialization of the given class. -
Uses of Describable in hudson.views
Classes in hudson.views that implement DescribableModifier and TypeClassDescriptionclassclassDeprecated.No longer usedclassThe Default ViewsTabBar Extension forViewsTabBar.classAdds the default view configuration to the system config page.classRendersItem.getName()classclassclassclassclassclassDeprecated.ImplementViewsTabBarstatic classDeprecated.ConfiguresViewsTabBarin the system configuration.classShows the status icon for item.final classJob Filter that will filter jobs based on its disabled statusclassEach ViewJobFilter contributes to or removes from the list of Jobs for a view.classExtension point for adding a ViewsTabBar header to ProjectsListView.static classConfiguresViewsTabBarin the system configuration.class -
Uses of Describable in jenkins.agents
Classes in jenkins.agents that implement Describable -
Uses of Describable in jenkins.console
Subinterfaces of Describable in jenkins.consoleModifier and TypeInterfaceDescriptioninterfaceExtension point that allows implementations to redirect build console links to a specified URL.Classes in jenkins.console that implement DescribableModifier and TypeClassDescriptionclassAllows administrators to activate and sortConsoleUrlProviderextensions to set defaults for all users.classAllows users to activate and sortConsoleUrlProviderextensions based on their preferences.classDefault implementation ofConsoleUrlProviderthat uses the standard Jenkins console view. -
Uses of Describable in jenkins.fingerprints
Classes in jenkins.fingerprints that implement DescribableModifier and TypeClassDescriptionclassDefault file system storage implementation for fingerprints.classPluggable fingerprint storage API for fingerprints.classAllows configuring the settings of fingerprints. -
Uses of Describable in jenkins.formelementpath
Classes in jenkins.formelementpath that implement Describable -
Uses of Describable in jenkins.install
Classes in jenkins.install that implement DescribableModifier and TypeClassDescriptionclassA Jenkins instance used during first-run to provide a limited set of services while initial installation is in progress -
Uses of Describable in jenkins.management
Classes in jenkins.management that implement Describable -
Uses of Describable in jenkins.model
Classes in jenkins.model that implement DescribableModifier and TypeClassDescriptionclassDefault base implementation ofTopLevelItem.classList of configuredArtifactManagerFactorys.classPluggable ability to manage transfer and/or storage of build artifacts.classImplementation of "Discard old build records" feature.classDefines aBuildDiscarder.classIn case there are no other implementations we will fallback to this implementation.classDefault User.CanonicalIdResolver to escape unsupported characters and generate user ID.classGlobal configuration UI for background build discardersclassExtension point for global background build discarders.classConfigures check interval for computer retention.classConvenient base class for extensions that contributes to the system configuration page but nothing else, or to manage the global configuration of a plugin implementing several extension points.classIncludeNodePropertyDescriptorconfigurations.classInclude config.jelly defined forPlugins.classConfigures the project naming strategy.classConfigures the system-default quiet period.classConfigures global SCM retry count default.classThe strategy to use for manipulating converting names (e.g.static classThe default case insensitiveIdStrategystatic classA case sensitiveIdStrategystatic classA case sensitive email addressIdStrategy.classRoot object of the system.classStores the location of Jenkins (e-mail address and the HTTP URL.)classPeriodically call a job's configured build discarder in the background.classAdds the configuration regarding building on the built-in node.classOptionalJobProperty<J extends Job<?,?>> Job property which may or may not be present.classThis ExtensionPoint allows to enforce the name of projects/jobs.static final classDefault implementation which does not restrict the name to any form.static final classNaming strategy which allows the admin to define a pattern a job's name has to follow.classApply a user-specified build discarder periodically on all jobs.classParticipates in the rendering of the login pageMethods in jenkins.model with type parameters of type DescribableModifier and TypeMethodDescription<T extends Describable<T>,D extends Descriptor<T>>
DescriptorExtensionList<T, D> Jenkins.getDescriptorList(Class<T> type) ReturnsExtensionListthat retains the discoveredDescriptorinstances for the given kind ofDescribable.Method parameters in jenkins.model with type arguments of type DescribableModifier and TypeMethodDescriptionJenkins.getDescriptor(Class<? extends Describable> type) Gets theDescriptorthat corresponds to the givenDescribabletype.Jenkins.getDescriptorOrDie(Class<? extends Describable> type) Works just likeJenkins.getDescriptor(Class)but don't take no for an answer. -
Uses of Describable in jenkins.model.experimentalflags
Classes in jenkins.model.experimentalflags that implement DescribableModifier and TypeClassDescriptionclassPer user experimental flags to enable features that still not completely ready to be active by default. -
Uses of Describable in jenkins.mvn
Classes in jenkins.mvn that implement DescribableModifier and TypeClassDescriptionclassclassclassclassclassclassclass -
Uses of Describable in jenkins.scm
Classes in jenkins.scm that implement DescribableModifier and TypeClassDescriptionclassDefaultSCMCheckoutStrategyimplementation.classControls the check out behavior inAbstractBuild. -
Uses of Describable in jenkins.security
Classes in jenkins.security that implement DescribableModifier and TypeClassDescriptionclassRemembers the API token for this user, that can be used like a password to login.classAdds the 'X-Frame-Options' header to all web pages.classRemembers the set ofGrantedAuthoritys that was obtained the last time the user has logged in.classExtension point to runQueue.Executables under a specific identity for better access control.classShow theQueueItemAuthenticatorconfigurations on the system config page.final classConfigure the resource root URL, an alternative root URL to serve resources from to not need Content-Security-Policy headers, which mess with desired complex output.classConfiguration for update site-provided warnings. -
Uses of Describable in jenkins.security.apitoken
Classes in jenkins.security.apitoken that implement DescribableModifier and TypeClassDescriptionclassConfiguration for the new token generation when a user is created -
Uses of Describable in jenkins.security.seed
Classes in jenkins.security.seed that implement DescribableModifier and TypeClassDescriptionclassThe seed stored in this property is used to have a revoke feature on the session without having to hack the session management that depends on the application server used to run the instance. -
Uses of Describable in jenkins.slaves
Classes in jenkins.slaves that implement DescribableModifier and TypeClassDescriptionclassDeprecated.only used with deprecated-jnlpUrlmode -
Uses of Describable in jenkins.tasks
Classes in jenkins.tasks that implement DescribableModifier and TypeClassDescriptionclassA generalization ofBuildWrapperthat, likeSimpleBuildStep, may be called at various points within a build. -
Uses of Describable in jenkins.tasks.filters
Subinterfaces of Describable in jenkins.tasks.filtersModifier and TypeInterfaceDescriptioninterfaceEnvironment variables filter rule that is configured globally for all jobs.interfaceEnvironment variables filter rule that is specific to a job configuration, using script-specific variables, etc.Classes in jenkins.tasks.filters that implement DescribableModifier and TypeClassDescriptionclassConfiguration of the filter rules that are applied globally, after filtering which rule applies on which builder -
Uses of Describable in jenkins.tasks.filters.impl
Classes in jenkins.tasks.filters.impl that implement DescribableModifier and TypeClassDescriptionclassLocal rule that removes all the non-retained variables for that step. -
Uses of Describable in jenkins.telemetry
Classes in jenkins.telemetry that implement DescribableModifier and TypeClassDescriptionclassThis class stores a UUID identifying this instance for telemetry reporting to allow deduplication or merging of submitted records. -
Uses of Describable in jenkins.triggers
Classes in jenkins.triggers that implement DescribableModifier and TypeClassDescriptionfinal classLikeBuildTriggerbut defined on the downstream project. -
Uses of Describable in jenkins.views
Classes in jenkins.views that implement Describable