com.cloudbees.hudson.plugins.folder

Class AbstractFolderDescriptor

java.lang.Object

hudson.model.Descriptor<hudson.model.TopLevelItem>

hudson.model.TopLevelItemDescriptor

com.cloudbees.hudson.plugins.folder.AbstractFolderDescriptor

All Implemented Interfaces:

hudson.model.Saveable, org.jenkins.ui.icon.IconSpec

Direct Known Subclasses:

Folder.DescriptorImpl

public abstract class AbstractFolderDescriptor
extends hudson.model.TopLevelItemDescriptor
implements org.jenkins.ui.icon.IconSpec

Category of AbstractFolder.

Since:

4.11-beta-1

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFolderDescriptor() Default constructor.
protected	AbstractFolderDescriptor(Class<? extends AbstractFolder> clazz) Explicit constructor.

Method Summary

Modifier and Type	Method and Description
<I extends hudson.model.TopLevelItem> ChildNameGenerator<AbstractFolder<I>,I>	childNameGenerator() Folders, especially computed folders, may have requirements for using a different on-disk file name for child items than the url-segment name.
String	getCategoryId() Needed if it wants AbstractFolderDescriptor implementations are categorized in Jenkins 2.x.
String	getDescription()
String	getDisplayName()
List<FolderHealthMetricDescriptor>	getHealthMetricDescriptors() Health metrics that can be configured for this type of AbstractFolder subtype.
String	getIconClassName()
List<FolderIconDescriptor>	getIconDescriptors() Gets the FolderIconDescriptors applicable for this folder type.
String	getIconFilePathPattern() Needed if it wants Folder are categorized in Jenkins 2.x.
List<AbstractFolderPropertyDescriptor>	getPropertyDescriptors() Properties that can be configured for this type of AbstractFolder subtype.
boolean	isIconConfigurable()
boolean	isLookAndFeelConfigurable(AbstractFolder<?> folder)
boolean	isTabBarConfigurable()

Methods inherited from class hudson.model.TopLevelItemDescriptor

all, checkApplicableIn, isApplicable, isApplicableIn, newInstance, newInstance, newInstance, testInstance

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFolderDescriptor

protected AbstractFolderDescriptor(Class<? extends AbstractFolder> clazz)

Explicit constructor.

Parameters:

clazz - the explicit AbstractFolder sub-class that this descriptor is for.

See Also:

TopLevelItemDescriptor.TopLevelItemDescriptor(Class)

AbstractFolderDescriptor

protected AbstractFolderDescriptor()

Default constructor.

See Also:

TopLevelItemDescriptor.TopLevelItemDescriptor()

Method Detail

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class hudson.model.TopLevelItemDescriptor

getCategoryId

public String getCategoryId()

Needed if it wants AbstractFolderDescriptor implementations are categorized in Jenkins 2.x. TODO: Override when the baseline is upgraded to 2.x TODO: Replace to NestedProjectsCategory.ID

Returns:

A string it represents a ItemCategory identifier.

getPropertyDescriptors

public List<AbstractFolderPropertyDescriptor> getPropertyDescriptors()

Properties that can be configured for this type of AbstractFolder subtype.

Returns:

the property descriptors.

getHealthMetricDescriptors

public List<FolderHealthMetricDescriptor> getHealthMetricDescriptors()

Health metrics that can be configured for this type of AbstractFolder subtype.

Returns:

the health metric descriptors.

getIconDescriptors

public List<FolderIconDescriptor> getIconDescriptors()

Gets the FolderIconDescriptors applicable for this folder type.

Returns:

the icon descriptors.

Since:

5.14

getDescription

public String getDescription()

getIconFilePathPattern

public String getIconFilePathPattern()

Needed if it wants Folder are categorized in Jenkins 2.x. TODO: Override when the baseline is upgraded to 2.x

Returns:

A string it represents a URL pattern to get the Item icon in different sizes.

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface org.jenkins.ui.icon.IconSpec

isIconConfigurable

public boolean isIconConfigurable()

isTabBarConfigurable

public boolean isTabBarConfigurable()

isLookAndFeelConfigurable

public boolean isLookAndFeelConfigurable(AbstractFolder<?> folder)

childNameGenerator

@CheckForNull
public <I extends hudson.model.TopLevelItem> ChildNameGenerator<AbstractFolder<I>,I> childNameGenerator()

Folders, especially computed folders, may have requirements for using a different on-disk file name for child items than the url-segment name. Typically this is to work around filesystem naming rules. Regular folders typically would leave the naming of child items to ProjectNamingStrategy and thereby prevent users from creating child items with names that do not comply with the ProjectNamingStrategy.

However, ComputedFolder instances may not have that luxury. The children of a ComputedFolder may have names that come from an external system and the matching item must be created, always. The obvious solution is that the ComputedFolder should mangle the supplied Item.getName() but the side-effect is that the URLs of the child items will now be mangled. Additionally the filename requirements can be rather onerous. Here is the most portable list of filename specification:

• Assume case insensitive
• Assume no filename can be longer than 32 characters
• Assume that only the characters A-Za-z0-9_.- are available
• Assume that there are some special reserved names such as . and ..
• Assume that there are some problematic names to avoid such as AUX, CON, NUL, etc. See Microsoft's page on "Naming Files, Paths, and Namespaces" (What's that you say, "Oh but we only run on Linux", perhaps but users may want to migrate from one OS to an other by moving their JENKINS_HOME (or even parts of it) so if you are mangling names, be sure to ensure that the mangled name is the same on all OSes
• NFC vs. NFD may be a concern as different filesystems apply different rules and normalization to the filenames. This is primarily a concern when migrating from before having a ChildNameGenerator to having a ChildNameGenerator as the migration will require inference of the un-mangled name from the filesystem, which may or may not match the un-mangled name from the source of the computation. Now POSIX does not specify how the filesystem is supposed to handle encoding of filenames and there can be strange behaviours, e.g. File.listFiles() is rumoured to always return NFC on OS-X

The ChildNameGenerator at least allows an AbstractFolder to apply an on-disk naming strategy that differs from the names used for the URLs.

If you implement a ChildNameGenerator it is strongly recommended to return a singleton for performance reasons.

Type Parameters:

I - A wildcard parameter to assist type matching.

Returns:

a (ideally singleton) instance of ChildNameGenerator for all instances of the concrete AbstractFolder class or null if no name mangling will be performed.

Since:

5.17