DecodeMessage (OpenSAML 4.3.3-SNAPSHOT API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.profile.action.AbstractProfileAction
  - - org.opensaml.profile.action.impl.DecodeMessage

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction
```
public class DecodeMessage
extends AbstractProfileAction
```
Action that decodes an incoming request into a MessageContext.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.UNABLE_TO_DECODE

Postcondition:

If decode succeeds, ProfileRequestContext.getInboundMessageContext() != null, The injected MessageDecoder is destroyed.

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  private MessageDecoder decoder
  The MessageDecoder instance used to decode the incoming message.
  
  private org.slf4j.Logger log
  Class logger.
- Constructor Summary
  
  Constructors
  Constructor Description
  
  DecodeMessage(MessageDecoder messageDecoder)
  Constructor.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  protected void doExecute(ProfileRequestContext profileRequestContext)
  Performs this action.
  - Methods inherited from class org.opensaml.profile.action.AbstractProfileAction
    doPostExecute, doPostExecute, doPreExecute, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, setHttpServletRequest, setHttpServletRequestSupplier, setHttpServletResponse, setHttpServletResponseSupplier
  - 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
  - log
```
@Nonnull
private final org.slf4j.Logger log
```
    Class logger.
  - decoder
```
@Nonnull
private final MessageDecoder decoder
```
    The MessageDecoder instance used to decode the incoming message.
- Constructor Detail
  - DecodeMessage
```
public DecodeMessage(@Nonnull
                     MessageDecoder messageDecoder)
```
    Constructor.
    
    Parameters:
    
    messageDecoder - the MessageDecoder used for the incoming request
- Method Detail
  - doExecute
```
protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext)
```
    Performs this action. Actions must override this method to perform their work.
    
    Overrides:
    
    doExecute in class AbstractProfileAction
    
    Parameters:
    
    profileRequestContext - the current IdP profile request context