Class SupportProvider
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<SupportProvider>
-
- com.cloudbees.jenkins.support.api.SupportProvider
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<SupportProvider>
public abstract class SupportProvider extends AbstractDescribableImpl<SupportProvider> implements ExtensionPoint
The provider of support.- Author:
- Stephen Connolly
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description SupportProvider()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract org.jvnet.localizer.Localizable
getActionBlurb()
Returns the blurb to put on the support action page.abstract org.jvnet.localizer.Localizable
getActionTitle()
Returns the title to put on the support action page.SupportProviderDescriptor
getDescriptor()
abstract String
getDisplayName()
Returns the display name of the provider.abstract String
getName()
Returns the name of the provider.abstract void
printAboutJenkins(PrintWriter out)
Allows a provider to print additional information about Jenkins into theabout.md
file.
-
-
-
Method Detail
-
getName
public abstract String getName()
Returns the name of the provider. This name will be used for the download bundles, so no spaces or other silly characters.- Returns:
- the name of the provider
-
getDisplayName
public abstract String getDisplayName()
Returns the display name of the provider.- Returns:
- the display name of the provider.
-
getActionTitle
public abstract org.jvnet.localizer.Localizable getActionTitle()
Returns the title to put on the support action page.- Returns:
- the title to put on the support action page.
-
getActionBlurb
public abstract org.jvnet.localizer.Localizable getActionBlurb()
Returns the blurb to put on the support action page.- Returns:
- the blurb to put on the support action page.
-
printAboutJenkins
public abstract void printAboutJenkins(PrintWriter out) throws IOException
Allows a provider to print additional information about Jenkins into theabout.md
file.- Parameters:
out
- the print writer.- Throws:
IOException
- if things go wrong.
-
getDescriptor
public SupportProviderDescriptor getDescriptor()
- Specified by:
getDescriptor
in interfaceDescribable<SupportProvider>
- Overrides:
getDescriptor
in classAbstractDescribableImpl<SupportProvider>
-
-