Package org.springframework.security.web.access.channel

Class SecureChannelProcessor

java.lang.Object

org.springframework.security.web.access.channel.SecureChannelProcessor

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, ChannelProcessor

public class SecureChannelProcessor
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean, ChannelProcessor

Ensures channel security is active by review of HttpServletRequest.isSecure() responses.

The class responds to one case-sensitive keyword, getSecureKeyword(). If this keyword is detected, HttpServletRequest.isSecure() is used to determine the channel security offered. If channel security is not present, the configured ChannelEntryPoint is called. By default the entry point is RetryWithHttpsEntryPoint.

The default secureKeyword is REQUIRES_SECURE_CHANNEL.

Constructor Summary

Constructors

Constructor	Description
SecureChannelProcessor()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	decide(FilterInvocation invocation, java.util.Collection<ConfigAttribute> config)	Decided whether the presented FilterInvocation provides the appropriate level of channel security based on the requested list of ConfigAttributes.
ChannelEntryPoint	getEntryPoint()
java.lang.String	getSecureKeyword()
void	setEntryPoint(ChannelEntryPoint entryPoint)
void	setSecureKeyword(java.lang.String secureKeyword)
boolean	supports(ConfigAttribute attribute)	Indicates whether this ChannelProcessor is able to process the passed ConfigAttribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecureChannelProcessor

public SecureChannelProcessor()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

decide

public void decide(FilterInvocation invocation,
                   java.util.Collection<ConfigAttribute> config)
            throws java.io.IOException,
                   javax.servlet.ServletException

Description copied from interface: ChannelProcessor

Decided whether the presented FilterInvocation provides the appropriate level of channel security based on the requested list of ConfigAttributes.

Specified by:

decide in interface ChannelProcessor

Throws:

java.io.IOException

javax.servlet.ServletException

getEntryPoint

public ChannelEntryPoint getEntryPoint()

getSecureKeyword

public java.lang.String getSecureKeyword()

setEntryPoint

public void setEntryPoint(ChannelEntryPoint entryPoint)

setSecureKeyword

public void setSecureKeyword(java.lang.String secureKeyword)

supports

public boolean supports(ConfigAttribute attribute)

Description copied from interface: ChannelProcessor

Indicates whether this ChannelProcessor is able to process the passed ConfigAttribute.

This allows the ChannelProcessingFilter to check every configuration attribute can be consumed by the configured ChannelDecisionManager.

Specified by:

supports in interface ChannelProcessor

Parameters:

attribute - a configuration attribute that has been configured against the ChannelProcessingFilter.

Returns:

true if this ChannelProcessor can support the passed configuration attribute