org.jenkins.ci.plugins.xframe_filter

Class XFrameFilterPageDecorator

java.lang.Object

hudson.model.Descriptor<hudson.model.PageDecorator>

hudson.model.PageDecorator

org.jenkins.ci.plugins.xframe_filter.XFrameFilterPageDecorator

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.PageDecorator>, hudson.model.Saveable

@Extension
public final class XFrameFilterPageDecorator
extends hudson.model.PageDecorator

The XFrame Filter Plugin provides a very simple filter which optionally adds an X-Frame-Options response header. The X-Frame-Options HTTP response header can be used to indicate whether or not a browser should be allowed to render a page in a <frame> or <iframe>. Sites can use this to avoid clickjacking attacks, by ensuring that their content is not embedded into other sites.

Author:

Jesse Farinacci

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

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 and Description
XFrameFilterPageDecorator() Create a default HSTS Filter PageDecorator.
XFrameFilterPageDecorator(boolean sendHeader, String options) Create a HSTS Filter PageDecorator with the specified configuration.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest request, net.sf.json.JSONObject json)
String	getDisplayName()
String	getOptions()
boolean	isSendHeader()
void	setOptions(String options)
void	setSendHeader(boolean sendHeader)

Methods inherited from class hudson.model.PageDecorator

all, getDescriptor, getUrl

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, 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, 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

XFrameFilterPageDecorator

public XFrameFilterPageDecorator()

Create a default HSTS Filter PageDecorator.

XFrameFilterPageDecorator

public XFrameFilterPageDecorator(boolean sendHeader,
                         String options)

Create a HSTS Filter PageDecorator with the specified configuration.

Method Detail

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class hudson.model.PageDecorator

configure

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

Overrides:

configure in class hudson.model.Descriptor<hudson.model.PageDecorator>

Throws:

hudson.model.Descriptor.FormException

isSendHeader

public boolean isSendHeader()

setSendHeader

public void setSendHeader(boolean sendHeader)

getOptions

public String getOptions()

setOptions

public void setOptions(String options)