xdi2.messaging.container.interceptor.impl.security.secrettoken

Class SecretTokenInterceptor

java.lang.Object

xdi2.messaging.container.impl.AbstractExtension<CONTAINER>

xdi2.messaging.container.interceptor.impl.AbstractInterceptor<MessagingContainer>

xdi2.messaging.container.interceptor.impl.security.secrettoken.SecretTokenInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingContainer>, Interceptor<MessagingContainer>, MessageInterceptor, Prototype<SecretTokenInterceptor>

public class SecretTokenInterceptor
extends AbstractInterceptor<MessagingContainer>
implements MessageInterceptor, Prototype<SecretTokenInterceptor>

This interceptor looks for a secret token on an incoming XDI message, and invokes an instance of SecretTokenValidator to validate it.

Nested Class Summary

Nested classes/interfaces inherited from interface xdi2.messaging.container.Extension

Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator

Nested classes/interfaces inherited from interface xdi2.messaging.container.Prototype

Prototype.PrototypingContext

Field Summary

Fields

Modifier and Type	Field and Description
static SecretTokenValidator	DEFAULT_SECRET_TOKEN_VALIDATOR

Fields inherited from class xdi2.messaging.container.impl.AbstractExtension

DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
SecretTokenInterceptor()
SecretTokenInterceptor(SecretTokenValidator secretTokenValidator)

Method Summary

Modifier and Type	Method and Description
InterceptorResult	after(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run after a message is executed.
InterceptorResult	before(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message is executed.
SecretTokenValidator	getSecretTokenValidator()
void	init(MessagingContainer messagingContainer)
SecretTokenInterceptor	instanceFor(Prototype.PrototypingContext prototypingContext)
void	setSecretTokenValidator(SecretTokenValidator secretTokenValidator)
void	shutdown(MessagingContainer messagingContainer)

Methods inherited from class xdi2.messaging.container.impl.AbstractExtension

clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, skip

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdi2.messaging.container.Extension

clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, skip

Field Detail

DEFAULT_SECRET_TOKEN_VALIDATOR

public static final SecretTokenValidator DEFAULT_SECRET_TOKEN_VALIDATOR

Constructor Detail

SecretTokenInterceptor

public SecretTokenInterceptor(SecretTokenValidator secretTokenValidator)

SecretTokenInterceptor

public SecretTokenInterceptor()

Method Detail

instanceFor

public SecretTokenInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)
                                   throws Xdi2MessagingException

Specified by:

instanceFor in interface Prototype<SecretTokenInterceptor>

Throws:

Xdi2MessagingException

init

public void init(MessagingContainer messagingContainer)
          throws Exception

Specified by:

init in interface Extension<MessagingContainer>

Overrides:

init in class AbstractExtension<MessagingContainer>

Throws:

Exception

shutdown

public void shutdown(MessagingContainer messagingContainer)
              throws Exception

Specified by:

shutdown in interface Extension<MessagingContainer>

Overrides:

shutdown in class AbstractExtension<MessagingContainer>

Throws:

Exception

before

public InterceptorResult before(Message message,
                                ExecutionContext executionContext,
                                ExecutionResult executionResult)
                         throws Xdi2MessagingException

Description copied from interface: MessageInterceptor

Run before a message is executed.

Specified by:

before in interface MessageInterceptor

Parameters:

message - The message to process.

executionContext - The current execution context.

executionResult - The execution result.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

after

public InterceptorResult after(Message message,
                               ExecutionContext executionContext,
                               ExecutionResult executionResult)
                        throws Xdi2MessagingException

Description copied from interface: MessageInterceptor

Run after a message is executed.

Specified by:

after in interface MessageInterceptor

Parameters:

message - The message to process.

executionContext - The current execution context.

executionResult - The execution result.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

getSecretTokenValidator

public SecretTokenValidator getSecretTokenValidator()

setSecretTokenValidator

public void setSecretTokenValidator(SecretTokenValidator secretTokenValidator)