opensaml-2.5.0
|
Interface to SAML protocol binding message encoders. More...
#include <saml/binding/MessageEncoder.h>
Classes | |
class | ArtifactGenerator |
Interface to caller-supplied artifact generation mechanism. More... | |
Public Member Functions | |
virtual bool | isCompact () const |
Indicates whether the encoding format requires that messages be as compact as possible. | |
virtual bool | isUserAgentPresent () const |
Indicates whether a web browser or similar user agent will receive the message. | |
virtual const XMLCh * | getProtocolFamily () const |
Returns identifier for the protocol family associated with the encoder. | |
virtual long | encode (xmltooling::GenericResponse &genericResponse, xmltooling::XMLObject *xmlObject, const char *destination, const saml2md::EntityDescriptor *recipient=nullptr, const char *relayState=nullptr, const ArtifactGenerator *artifactGenerator=nullptr, const xmltooling::Credential *credential=nullptr, const XMLCh *signatureAlg=nullptr, const XMLCh *digestAlg=nullptr) const =0 |
Encodes an XML object/message into a binding- and transport-specific response. |
Interface to SAML protocol binding message encoders.
virtual long opensaml::MessageEncoder::encode | ( | xmltooling::GenericResponse & | genericResponse, |
xmltooling::XMLObject * | xmlObject, | ||
const char * | destination, | ||
const saml2md::EntityDescriptor * | recipient = nullptr , |
||
const char * | relayState = nullptr , |
||
const ArtifactGenerator * | artifactGenerator = nullptr , |
||
const xmltooling::Credential * | credential = nullptr , |
||
const XMLCh * | signatureAlg = nullptr , |
||
const XMLCh * | digestAlg = nullptr |
||
) | const [pure virtual] |
Encodes an XML object/message into a binding- and transport-specific response.
The XML content cannot have a parent object, and any existing references to the content will be invalidated if the encode method returns successfully.
If a CredentialResolver is supplied, the message is also signed in a binding-specific manner. The CredentialResolver MUST be locked by the caller.
Artifact-based bindings require an ArtifactGenerator be set to produce an artifact suitable for the intended recipient.
genericResponse | reference to interface for sending transport response |
xmlObject | XML message to encode |
destination | destination URL for message |
recipient | optional message recipient |
relayState | optional RelayState value to accompany message |
artifactGenerator | optional interface for generation of artifacts |
credential | optional Credential to supply signing key |
signatureAlg | optional signature algorithm identifier |
digestAlg | optional reference digest algorithm identifier |
virtual const XMLCh* opensaml::MessageEncoder::getProtocolFamily | ( | ) | const [virtual] |
Returns identifier for the protocol family associated with the encoder.
virtual bool opensaml::MessageEncoder::isCompact | ( | ) | const [virtual] |
Indicates whether the encoding format requires that messages be as compact as possible.
virtual bool opensaml::MessageEncoder::isUserAgentPresent | ( | ) | const [virtual] |
Indicates whether a web browser or similar user agent will receive the message.