Interface to SAML protocol binding message decoders.
More...
#include <saml/binding/MessageDecoder.h>
|
virtual void | extractMessageDetails (const xmltooling::XMLObject &message, const xmltooling::GenericRequest &request, const XMLCh *protocol, SecurityPolicy &policy) const =0 |
| Extracts policy-relevant message details. More...
|
|
Interface to SAML protocol binding message decoders.
◆ decode() [1/2]
virtual xmltooling::XMLObject* opensaml::MessageDecoder::decode |
( |
std::string & |
relayState, |
|
|
const xmltooling::GenericRequest & |
genericRequest, |
|
|
SecurityPolicy & |
policy |
|
) |
| const |
|
virtual |
The future version is the variant below that also takes a response object.
- Parameters
-
relayState | will be set to RelayState/TARGET value accompanying message |
genericRequest | reference to interface for accessing transport request to decode |
policy | reference to policy containing rules, MetadataProvider, TrustEngine, etc. |
- Returns
- the decoded message, or nullptr if the decoder did not recognize the request content
◆ decode() [2/2]
virtual xmltooling::XMLObject* opensaml::MessageDecoder::decode |
( |
std::string & |
relayState, |
|
|
const xmltooling::GenericRequest & |
genericRequest, |
|
|
xmltooling::GenericResponse * |
genericResponse, |
|
|
SecurityPolicy & |
policy |
|
) |
| const |
|
virtual |
Decodes a transport request into a SAML protocol message, and evaluates it against a supplied SecurityPolicy.
If the transport request does not contain the information necessary to decode the request, nullptr will be returned. Errors during the decoding process will be raised as exceptions.
Artifact-based bindings require an ArtifactResolver be set to turn an artifact into the corresponding message.
- Parameters
-
relayState | will be set to RelayState/TARGET value accompanying message |
genericRequest | reference to interface for accessing transport request to decode |
genericResponse | optional interface for accessing transport response |
policy | reference to policy containing rules, MetadataProvider, TrustEngine, etc. |
- Returns
- the decoded message, or nullptr if the decoder did not recognize the request content
◆ extractMessageDetails()
virtual void opensaml::MessageDecoder::extractMessageDetails |
( |
const xmltooling::XMLObject & |
message, |
|
|
const xmltooling::GenericRequest & |
request, |
|
|
const XMLCh * |
protocol, |
|
|
SecurityPolicy & |
policy |
|
) |
| const |
|
protectedpure virtual |
◆ getProtocolFamily()
virtual const XMLCh* opensaml::MessageDecoder::getProtocolFamily |
( |
| ) |
const |
|
virtual |
◆ isUserAgentPresent()
virtual bool opensaml::MessageDecoder::isUserAgentPresent |
( |
| ) |
const |
|
virtual |
Indicates whether a web browser or similar user agent delivered the message.
- Returns
- true iff the message was delivered by a user agent
◆ setArtifactResolver()
void opensaml::MessageDecoder::setArtifactResolver |
( |
const ArtifactResolver * |
artifactResolver | ) |
|
Provides an ArtifactResolver implementation for the MessageDecoder to use.
The implementation's lifetime must be longer than the lifetime of this object. This method must be externally synchronized.
- Parameters
-
◆ m_artifactResolver
The documentation for this class was generated from the following file: