AuthenticationSecretTokenInterceptor (xdi2-transport 0.7.3 API)

java.lang.Object
- xdi2.messaging.target.impl.AbstractExtension<CONTAINER>
- - xdi2.messaging.target.interceptor.AbstractInterceptor<MessagingTarget>
  - - xdi2.messaging.target.interceptor.impl.authentication.secrettoken.AuthenticationSecretTokenInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingTarget>, Interceptor<MessagingTarget>, MessageInterceptor, Prototype<AuthenticationSecretTokenInterceptor>
```
public class AuthenticationSecretTokenInterceptor
extends AbstractInterceptor<MessagingTarget>
implements MessageInterceptor, Prototype<AuthenticationSecretTokenInterceptor>
```
This interceptor looks for a secret token on an incoming XDI message, and invokes an instance of SecretTokenAuthenticator to authenticate the message.

Nested Class Summary
- Nested classes/interfaces inherited from interface xdi2.messaging.target.Extension
  Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator
- Nested classes/interfaces inherited from interface xdi2.messaging.target.Prototype
  Prototype.PrototypingContext

Field Summary
- Fields inherited from class xdi2.messaging.target.impl.AbstractExtension
  DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors
Constructor and Description

AuthenticationSecretTokenInterceptor()

Constructors
Constructor and Description
`AuthenticationSecretTokenInterceptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`InterceptorResult`	`after(Message message, MessageResult messageResult, ExecutionContext executionContext)`
`InterceptorResult`	`before(Message message, MessageResult messageResult, ExecutionContext executionContext)`
`SecretTokenAuthenticator`	`getSecretTokenAuthenticator()`
`void`	`init(MessagingTarget messagingTarget)`
`AuthenticationSecretTokenInterceptor`	`instanceFor(Prototype.PrototypingContext prototypingContext)`
`void`	`setSecretTokenAuthenticator(SecretTokenAuthenticator secretTokenAuthenticator)`
`void`	`shutdown(MessagingTarget messagingTarget)`

Methods inherited from class xdi2.messaging.target.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.target.Extension
clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, skip

Constructor Detail
- AuthenticationSecretTokenInterceptor
```
public AuthenticationSecretTokenInterceptor()
```

Method Detail

instanceFor

public AuthenticationSecretTokenInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)
                                                 throws Xdi2MessagingException

Specified by:: instanceFor in interface Prototype<AuthenticationSecretTokenInterceptor>
Throws:: Xdi2MessagingException

init
```
public void init(MessagingTarget messagingTarget)
          throws Exception
```
Specified by:

init in interface Extension<MessagingTarget>

Overrides:

init in class AbstractExtension<MessagingTarget>

Throws:

Exception

shutdown
```
public void shutdown(MessagingTarget messagingTarget)
              throws Exception
```
Specified by:

shutdown in interface Extension<MessagingTarget>

Overrides:

shutdown in class AbstractExtension<MessagingTarget>

Throws:

Exception

before

public InterceptorResult before(Message message,
                       MessageResult messageResult,
                       ExecutionContext executionContext)
                         throws Xdi2MessagingException

Specified by:: before in interface MessageInterceptor
Throws:: Xdi2MessagingException

after

public InterceptorResult after(Message message,
                      MessageResult messageResult,
                      ExecutionContext executionContext)
                        throws Xdi2MessagingException

Specified by:: after in interface MessageInterceptor
Throws:: Xdi2MessagingException

getSecretTokenAuthenticator

public SecretTokenAuthenticator getSecretTokenAuthenticator()

setSecretTokenAuthenticator

public void setSecretTokenAuthenticator(SecretTokenAuthenticator secretTokenAuthenticator)

Class AuthenticationSecretTokenInterceptor

Nested Class Summary

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

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface xdi2.messaging.target.Extension

Constructor Detail

AuthenticationSecretTokenInterceptor

Method Detail

instanceFor

init

shutdown

before

after

getSecretTokenAuthenticator

setSecretTokenAuthenticator