Package org.jenkins.ci.plugins.hsts_filter

Class HstsFilterPageDecorator

java.lang.Object

hudson.model.Descriptor<PageDecorator>

hudson.model.PageDecorator

org.jenkins.ci.plugins.hsts_filter.HstsFilterPageDecorator

All Implemented Interfaces:

ExtensionPoint, Describable<PageDecorator>, Saveable, OnMaster

@Extension
public class HstsFilterPageDecorator
extends PageDecorator

The HSTS Filter Plugin provides a very simple filter which adds a response header indicating that HTTP Strict Transport Security (HSTS) response headers should be utilized.

Author:

Jesse Farinacci

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

Modifier and Type	Field	Description
protected static boolean	DEFAULT_INCLUDE_SUB_DOMAINS	The default value for includeSubDomains.
protected static String	DEFAULT_MAX_AGE	The default value for maxAge.
protected static boolean	DEFAULT_SEND_HEADER	The default value for sendHeader.

Fields inherited from class hudson.model.PageDecorator

ALL

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
HstsFilterPageDecorator()	Create a default HSTS Filter PageDecorator.
HstsFilterPageDecorator(boolean sendHeader, String maxAge, boolean includeSubDomains)	Create a HSTS Filter PageDecorator with the specified configuration.

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest request, net.sf.json.JSONObject json)
String	getDisplayName()
String	getMaxAge()
boolean	isIncludeSubDomains()
boolean	isSendHeader()
void	setIncludeSubDomains(boolean includeSubDomains)
void	setMaxAge(String maxAge)
void	setSendHeader(boolean sendHeader)

Methods inherited from class hudson.model.PageDecorator

all, getDescriptor, getUrl

Methods inherited from class hudson.model.Descriptor

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

Field Detail

DEFAULT_SEND_HEADER

protected static final boolean DEFAULT_SEND_HEADER

The default value for sendHeader.

See Also:

Constant Field Values

DEFAULT_MAX_AGE

protected static final String DEFAULT_MAX_AGE

The default value for maxAge.

See Also:

Constant Field Values

DEFAULT_INCLUDE_SUB_DOMAINS

protected static final boolean DEFAULT_INCLUDE_SUB_DOMAINS

The default value for includeSubDomains.

See Also:

Constant Field Values

Constructor Detail

HstsFilterPageDecorator

public HstsFilterPageDecorator()

Create a default HSTS Filter PageDecorator.

HstsFilterPageDecorator

@DataBoundConstructor
public HstsFilterPageDecorator(boolean sendHeader,
                               String maxAge,
                               boolean includeSubDomains)

Create a HSTS Filter PageDecorator with the specified configuration.

Method Detail

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<PageDecorator>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest request,
                         net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Overrides:

configure in class Descriptor<PageDecorator>

Throws:

Descriptor.FormException

isSendHeader

public boolean isSendHeader()

setSendHeader

public void setSendHeader(boolean sendHeader)

getMaxAge

public String getMaxAge()

setMaxAge

public void setMaxAge(String maxAge)

isIncludeSubDomains

public boolean isIncludeSubDomains()

setIncludeSubDomains

public void setIncludeSubDomains(boolean includeSubDomains)