AbstractMessageChannelSecurity (OpenSAML :: Messaging Implementations 4.1.0 API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.messaging.handler.AbstractMessageHandler
  - - org.opensaml.messaging.handler.impl.AbstractMessageChannelSecurity

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

Direct Known Subclasses:

StaticMessageChannelSecurity, URLEvaluatingMessageChannelSecurity
```
public abstract class AbstractMessageChannelSecurity
extends AbstractMessageHandler
```
Abstract base class for message handlers which populate a MessageChannelSecurityContext on a BaseContext, where the latter is located using a lookup strategy.

Field Summary

Fields
Modifier and Type	Field	Description
`private BaseContext`	`parentContext`	Parent for eventual context.
`private Function<MessageContext,BaseContext>`	`parentContextLookupStrategy`	Strategy used to look up the parent `BaseContext` on which the `MessageChannelSecurityContext` will be populated.

Constructor Summary

Constructors
Constructor Description

AbstractMessageChannelSecurity()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`doPreInvoke(MessageContext messageContext)`
`protected BaseContext`	`getParentContext()`	Get the parent context on which the `MessageChannelSecurityContext` will be populated.
`void`	`setParentContextLookupStrategy(Function<MessageContext,BaseContext> strategy)`	Set the strategy used to look up the parent `BaseContext` on which the `MessageChannelSecurityContext` will be populated.

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler
doInvoke, doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent
initialize, isInitialized

- Field Detail
  - parentContextLookupStrategy
```
@Nonnull
private Function<MessageContext,BaseContext> parentContextLookupStrategy
```
    Strategy used to look up the parent BaseContext on which the MessageChannelSecurityContext will be populated.
  - parentContext
```
@Nullable
private BaseContext parentContext
```
    Parent for eventual context.
- Constructor Detail
  - AbstractMessageChannelSecurity
```
public AbstractMessageChannelSecurity()
```
    Constructor.
- Method Detail
  - setParentContextLookupStrategy
```
public void setParentContextLookupStrategy(@Nonnull
                                           Function<MessageContext,BaseContext> strategy)
```
    Set the strategy used to look up the parent BaseContext on which the MessageChannelSecurityContext will be populated.
    
    Parameters:
    
    strategy - strategy used to look up the parent BaseContext on which to populate the MessageChannelSecurityContext
  - doPreInvoke
```
protected boolean doPreInvoke(@Nonnull
                              MessageContext messageContext)
                       throws MessageHandlerException
```
    Overrides:
    
    doPreInvoke in class AbstractMessageHandler
    
    Throws:
    
    MessageHandlerException
  - getParentContext
```
protected BaseContext getParentContext()
```
    Get the parent context on which the MessageChannelSecurityContext will be populated.
    
    Returns:
    
    the parent context