org.springframework.security.web.header.writers.frameoptions
Class XFrameOptionsHeaderWriter

java.lang.Object
  org.springframework.security.web.header.writers.frameoptions.XFrameOptionsHeaderWriter

All Implemented Interfaces:

HeaderWriter

public final class XFrameOptionsHeaderWriter
extends Object
implements HeaderWriter

HeaderWriter implementation for the X-Frame-Options headers. When using the ALLOW-FROM directive the actual value is determined by a AllowFromStrategy.

Since:

3.2

See Also:

AllowFromStrategy

Nested Class Summary

static class

XFrameOptionsHeaderWriter.XFrameOptionsMode The possible values for the X-Frame-Options header.

Field Summary

static String

XFRAME_OPTIONS_HEADER

Constructor Summary

XFrameOptionsHeaderWriter()
Creates an instance with XFrameOptionsHeaderWriter.XFrameOptionsMode.DENY

XFrameOptionsHeaderWriter(AllowFromStrategy allowFromStrategy)
Creates a new instance with XFrameOptionsHeaderWriter.XFrameOptionsMode.ALLOW_FROM.

XFrameOptionsHeaderWriter(XFrameOptionsHeaderWriter.XFrameOptionsMode frameOptionsMode)
Creates a new instance

Method Summary

void	writeHeaders(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Create a Header instance.

Methods inherited from class java.lang.Object

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

Field Detail

XFRAME_OPTIONS_HEADER

public static final String XFRAME_OPTIONS_HEADER

See Also:

Constant Field Values

Constructor Detail

XFrameOptionsHeaderWriter

public XFrameOptionsHeaderWriter()

Creates an instance with XFrameOptionsHeaderWriter.XFrameOptionsMode.DENY

XFrameOptionsHeaderWriter

public XFrameOptionsHeaderWriter(XFrameOptionsHeaderWriter.XFrameOptionsMode frameOptionsMode)

Creates a new instance

Parameters:

frameOptionsMode - the XFrameOptionsHeaderWriter.XFrameOptionsMode to use. If using XFrameOptionsHeaderWriter.XFrameOptionsMode.ALLOW_FROM, use #FrameOptionsHeaderWriter(AllowFromStrategy) instead.

XFrameOptionsHeaderWriter

public XFrameOptionsHeaderWriter(AllowFromStrategy allowFromStrategy)

Creates a new instance with XFrameOptionsHeaderWriter.XFrameOptionsMode.ALLOW_FROM.

Parameters:

allowFromStrategy - the strategy for determining what the value for ALLOW_FROM is.

Method Detail

writeHeaders

public void writeHeaders(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)

Description copied from interface: HeaderWriter

Create a Header instance.

Specified by:

writeHeaders in interface HeaderWriter

Parameters:

request - the request

response - the response