org.springframework.security.messaging.context

Class SecurityContextChannelInterceptor

java.lang.Object

ChannelInterceptorAdapter

org.springframework.security.messaging.context.SecurityContextChannelInterceptor

public final class SecurityContextChannelInterceptor
extends ChannelInterceptorAdapter

Creates a ExecutorChannelInterceptor that will obtain the Authentication from the specified Message#getHeaders().

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
SecurityContextChannelInterceptor() Creates a new instance using the header of the name SimpMessageHeaderAccessor#USER_HEADER.
SecurityContextChannelInterceptor(java.lang.String authenticationHeaderName) Creates a new instance that uses the specified header to obtain the Authentication.

Method Summary

Modifier and Type	Method and Description
void	afterMessageHandled(<any> message, MessageChannel channel, MessageHandler handler, java.lang.Exception ex)
void	afterSendCompletion(<any> message, MessageChannel channel, boolean sent, java.lang.Exception ex)
<any>	beforeHandle(<any> message, MessageChannel channel, MessageHandler handler)
<any>	preSend(<any> message, MessageChannel channel)
void	setAnonymousAuthentication(Authentication authentication) Allows setting the Authentication used for anonymous authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityContextChannelInterceptor

public SecurityContextChannelInterceptor()

Creates a new instance using the header of the name SimpMessageHeaderAccessor#USER_HEADER.

SecurityContextChannelInterceptor

public SecurityContextChannelInterceptor(java.lang.String authenticationHeaderName)

Creates a new instance that uses the specified header to obtain the Authentication.

Parameters:

authenticationHeaderName - the header name to obtain the Authentication. Cannot be null.

Method Detail

setAnonymousAuthentication

public void setAnonymousAuthentication(Authentication authentication)

Allows setting the Authentication used for anonymous authentication. Default is:

 new AnonymousAuthenticationToken("key", "anonymous",
                AuthorityUtils.createAuthorityList("ROLE_ANONYMOUS"));
 

Parameters:

authentication - the Authentication used for anonymous authentication. Cannot be null.

preSend

public <any> preSend(<any> message,
                     MessageChannel channel)

afterSendCompletion

public void afterSendCompletion(<any> message,
                                MessageChannel channel,
                                boolean sent,
                                java.lang.Exception ex)

beforeHandle

public <any> beforeHandle(<any> message,
                          MessageChannel channel,
                          MessageHandler handler)

afterMessageHandled

public void afterMessageHandled(<any> message,
                                MessageChannel channel,
                                MessageHandler handler,
                                java.lang.Exception ex)