jenkins.model

Class GlobalConfigurationCategory

java.lang.Object

jenkins.model.GlobalConfigurationCategory

All Implemented Interfaces:

ExtensionPoint, ModelObject

Direct Known Subclasses:

GlobalConfigurationCategory.Security, GlobalConfigurationCategory.Unclassified, ToolConfigurationCategory

public abstract class GlobalConfigurationCategory
extends Object
implements ExtensionPoint, ModelObject

Grouping of related GlobalConfigurations.

To facilitate the separation of the global configuration into multiple pages, tabs, and so on, GlobalConfigurations are classified into categories (such as "security", "tools", as well as the catch all "unclassified".) Categories themselves are extensible — plugins may introduce its own category as well, although that should only happen if you are creating a big enough subsystem.

The primary purpose of this is to enable future UIs to split the global configurations to smaller pieces that can be individually looked at and updated.

Since:

1.494

Author:

Kohsuke Kawaguchi

See Also:

GlobalConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalConfigurationCategory.Security Security related configurations.
static class	GlobalConfigurationCategory.Unclassified This category represents the catch-all I-dont-know-what-category-it-is instance, used for those GlobalConfigurations that don't really deserve/need a separate category.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
GlobalConfigurationCategory()

Method Summary

Modifier and Type	Method and Description
static ExtensionList<GlobalConfigurationCategory>	all() Returns all the registered GlobalConfiguration descriptors.
static <T extends GlobalConfigurationCategory> T	get(Class<T> type)
abstract String	getShortDescription() One-line plain text message that explains what this category is about.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Constructor Detail

GlobalConfigurationCategory

public GlobalConfigurationCategory()

Method Detail

getShortDescription

public abstract String getShortDescription()

One-line plain text message that explains what this category is about. This can be used in the UI to help the user pick the right category. The text should be longer than ModelObject.getDisplayName()

all

public static ExtensionList<GlobalConfigurationCategory> all()

Returns all the registered GlobalConfiguration descriptors.

get

@NonNull
public static <T extends GlobalConfigurationCategory> T get(Class<T> type)