MessageDecoder (OpenSAML :: Messaging API 4.0.0-beta2 API)

All Superinterfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

All Known Subinterfaces:

HttpClientResponseMessageDecoder, HttpServletRequestMessageDecoder

All Known Implementing Classes:

AbstractHttpClientResponseMessageDecoder, AbstractHttpServletRequestMessageDecoder, AbstractMessageDecoder, BaseHttpClientResponseXMLMessageDecoder, BaseHttpServletRequestXMLMessageDecoder
```
public interface MessageDecoder
extends net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.DestructableComponent
```
Interface for component that decodes message data from a source into a MessageContext. Before the decoder can be used the InitializableComponent.initialize() method must be called. After the decoder has been used the DestructableComponent.destroy() method should be invoked in order to clean up any resources.
The data on which the decoder operates is supplied in an implementation-specific manner.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`decode()`	Decode message data from the source and store it so that it may be retrieved via `getMessageContext()`.
`MessageContext`	`getMessageContext()`	Get the decoded message context.

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent
destroy, isDestroyed

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

- Method Detail
  - decode
```
void decode()
     throws MessageDecodingException
```
    Decode message data from the source and store it so that it may be retrieved via getMessageContext().
    
    Throws:
    
    MessageDecodingException - if there is a problem decoding the message context
  - getMessageContext
```
MessageContext getMessageContext()
```
    Get the decoded message context.
    
    Returns:
    
    the decoded message context