AddFrameworkHandler (Shibboleth IdP :: SAML Profile Implementation 4.2.1 API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.messaging.handler.AbstractMessageHandler
  - - org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler
    - - net.shibboleth.idp.saml.saml2.profile.delegation.messaging.impl.AddFrameworkHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler
```
public class AddFrameworkHandler
extends AbstractHeaderGeneratingMessageHandler
```
Handler implementation that adds a Liberty sbf:Framework header to the outbound SOAP envelope.

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_VERSION
Default Framework version.

private org.slf4j.Logger log
Logger.

private String version
The Version value.

Constructor Summary

Constructors
Constructor Description

AddFrameworkHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doInvoke(MessageContext messageContext)`
`String`	`getVersion()`	Get the version value.
`void`	`setVersion(String newVersion)`	Set the version value.

Methods inherited from class org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler
decorateGeneratedHeader, doPreInvoke, getEffectiveTargetNode, isEffectiveMustUnderstand, setMustUnderstand, setMustUnderstandStrategy, setTargetNode, setTargetNodeStrategy

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler
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
- DEFAULT_VERSION
```
public static final String DEFAULT_VERSION
```
  Default Framework version.
  
  See Also:
  
  Constant Field Values
- log
```
private org.slf4j.Logger log
```
  Logger.
- version
```
private String version
```
  The Version value.

Constructor Detail
- AddFrameworkHandler
```
public AddFrameworkHandler()
```

Method Detail

getVersion
```
@Nullable
public String getVersion()
```
Get the version value.

Returns:

the version, or null

setVersion

public void setVersion(@Nullable
                       String newVersion)

Set the version value.

Parameters:: newVersion - the new version value

doInvoke

protected void doInvoke(@Nonnull
                        MessageContext messageContext)
                 throws MessageHandlerException

Specified by:: doInvoke in class AbstractMessageHandler
Throws:: MessageHandlerException