opensaml::saml2::SAML2AssertionPolicy Class Reference

Policy subclass to track SAML 2.0 Assertion SubjectConfirmation. More...

#include <saml/saml2/profile/SAML2AssertionPolicy.h>

Inheritance diagram for opensaml::saml2::SAML2AssertionPolicy:

opensaml::SecurityPolicy

List of all members.

Public Member Functions

 SAML2AssertionPolicy (const saml2md::MetadataProvider *metadataProvider=nullptr, const xmltooling::QName *role=nullptr, const xmltooling::TrustEngine *trustEngine=nullptr, bool validate=true)
 Constructor for policy.
virtual void reset (bool messageOnly=false)
 Resets the policy object and/or clears any per-message state.
void _reset (bool messageOnly=false)
 Resets the policy object and/or clears any per-message state for only this specific class.
const saml2::SubjectConfirmation * getSubjectConfirmation () const
 Returns the subject confirmation that was successfully accepted by the policy.
void setSubjectConfirmation (const saml2::SubjectConfirmation *confirmation)
 Sets the SubjectConfirmation that was successfully accepted by the policy.


Detailed Description

Policy subclass to track SAML 2.0 Assertion SubjectConfirmation.

Constructor & Destructor Documentation

opensaml::saml2::SAML2AssertionPolicy::SAML2AssertionPolicy ( const saml2md::MetadataProvider metadataProvider = nullptr,
const xmltooling::QName *  role = nullptr,
const xmltooling::TrustEngine *  trustEngine = nullptr,
bool  validate = true 
)

Constructor for policy.

Parameters:
metadataProvider locked MetadataProvider instance
role identifies the role (generally IdP or SP) of the policy peer
trustEngine TrustEngine to authenticate policy peer
validate true iff XML parsing should be done with validation


Member Function Documentation

virtual void opensaml::saml2::SAML2AssertionPolicy::reset ( bool  messageOnly = false  )  [virtual]

Resets the policy object and/or clears any per-message state.

Resets can be complete (the default) or merely clear the previous message ID and timestamp when evaluating multiple layers of a message.

Parameters:
messageOnly true iff security and issuer state should be left in place

Reimplemented from opensaml::SecurityPolicy.

void opensaml::saml2::SAML2AssertionPolicy::_reset ( bool  messageOnly = false  ) 

Resets the policy object and/or clears any per-message state for only this specific class.

Resets can be complete (the default) or merely clear the previous message ID and timestamp when evaluating multiple layers of a message.

Parameters:
messageOnly true iff security and issuer state should be left in place

Reimplemented from opensaml::SecurityPolicy.

const saml2::SubjectConfirmation* opensaml::saml2::SAML2AssertionPolicy::getSubjectConfirmation (  )  const

Returns the subject confirmation that was successfully accepted by the policy.

Returns:
a successfully evaluated SubjectConfirmation

void opensaml::saml2::SAML2AssertionPolicy::setSubjectConfirmation ( const saml2::SubjectConfirmation *  confirmation  ) 

Sets the SubjectConfirmation that was successfully accepted by the policy.

The lifetime of the SubjectConfirmation object MUST be longer than the lifetime of the policy object.

Parameters:
confirmation the successfully evaluated SubjectConfirmation


The documentation for this class was generated from the following file:

Generated on Mon Dec 10 19:28:30 2012 for opensaml-2.5.1 by  doxygen 1.5.6