Package jenkins.model

Class SimplePageDecorator

java.lang.Object

hudson.model.Descriptor<SimplePageDecorator>

jenkins.model.SimplePageDecorator

All Implemented Interfaces:

ExtensionPoint, Describable<SimplePageDecorator>, Saveable, Loadable, OnMaster

Direct Known Subclasses:

DefaultSimplePageDecorator

public class SimplePageDecorator
extends Descriptor<SimplePageDecorator>
implements ExtensionPoint, Describable<SimplePageDecorator>

Participates in the rendering of the login page

This class provides a few hooks to augment the HTML of the login page.

simple-branding.jelly

This view contributes to the branding section, usually located on the left side of the login/register pages.

simple-footer.jelly

This view contributes to the footer section, located below the login/register form.

simple-head.jelly

This view contributes to the head section.

simple-header.jelly

This view contributes to the header section just above the login/register form.

Since:

2.128

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimplePageDecorator()

Method Summary

Modifier and Type	Method	Description
static List<SimplePageDecorator>	all()	Returns all login page decorators.
static SimplePageDecorator	first()	The first found LoginDecorator, there can only be one.
final Descriptor<SimplePageDecorator>	getDescriptor()	Gets the descriptor for this instance.
final String	getUrl()	Obtains the URL of this object, excluding the context path.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, 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 Details

SimplePageDecorator

protected SimplePageDecorator()

Method Details

getDescriptor

public final Descriptor<SimplePageDecorator> 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<SimplePageDecorator>

getUrl

public final String getUrl()

Obtains the URL of this object, excluding the context path.

Every SimplePageDecorator is bound to URL via Jenkins.getDescriptor(). This method returns such an URL.

all

public static List<SimplePageDecorator> all()

Returns all login page decorators.

Since:

2.156

first

public static SimplePageDecorator first()

The first found LoginDecorator, there can only be one.

Returns:

the first found SimplePageDecorator