opensaml-2.5.5

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Namespace List
- Namespace Members

Namespaces | Classes | Functions
opensaml Namespace Reference

Common classes for OpenSAML library. More...

## Namespaces
| saml1
| SAML 1.x assertion namespace.
| saml1p
| SAML 1.x protocol namespace.
| saml2
| SAML 2.0 assertion namespace.
| saml2md
| SAML 2.0 metadata namespace.
| saml2p
| SAML 2.0 protocol namespace.

## Classes
class | ArtifactMap
| Helper class for SAMLArtifact mapping and retrieval. More...
class | Assertion
| Base class for SAML assertions. More...
class | CommonDomainCookie
| Helper class for maintaining discovery cookie. More...
class | ContentReference
| SAML-specific signature reference profile. More...
class | EncryptedKeyResolver
| SAML-specific encrypted key resolver. More...
class | MessageDecoder
| Interface to SAML protocol binding message decoders. More...
class | MessageEncoder
| Interface to SAML protocol binding message encoders. More...
class | RootObject
| Base class for SAML objects at the root of core schemas. More...
class | SAMLArtifact
| Base class for SAML 1.x and 2.0 artifacts. More...
class | SAMLConfig
| Singleton object that manages library startup/shutdown.configuration. More...
class | SecurityPolicy
| A policy used to verify the security of an incoming message. More...
class | SecurityPolicyRule
| A rule that a protocol request and message must meet in order to be valid and secure. More...
class | SignableObject
| Base class for SAML objects that can be signed. More...
class | SignatureProfileValidator
| SAML-specific signature profile validator. More...
class | SOAPClient
| Specialized SOAPClient for SAML SOAP bindings. More...
class | Status
| Base class for SAML status codes. More...

## Functions
void | registerMessageDecoders ()
| Registers MessageDecoder plugins into the runtime.
void | registerMessageEncoders ()
| Registers MessageEncoder plugins into the runtime.
| DECL_XMLTOOLING_EXCEPTION (ArtifactException,, opensaml, xmltooling::XMLToolingException, Exceptions related to artifact parsing)
void | registerSAMLArtifacts ()
| Registers SAMLArtifact subclasses into the runtime.
void | registerSecurityPolicyRules ()
| Registers SecurityPolicyRule plugins into the runtime.
| DECL_XMLTOOLING_EXCEPTION (SecurityPolicyException,, opensaml, xmltooling::XMLToolingException, Exceptions in security policy processing)
| DECL_XMLTOOLING_EXCEPTION (BindingException,, opensaml, xmltooling::XMLToolingException, Exceptions in SAML binding processing)
| DECL_XMLTOOLING_EXCEPTION (ProfileException,, opensaml, xmltooling::ValidationException, Exceptions in SAML profile processing)
| DECL_XMLTOOLING_EXCEPTION (FatalProfileException,, opensaml, ProfileException, Fatal exceptions in SAML profile processing)
| DECL_XMLTOOLING_EXCEPTION (RetryableProfileException,, opensaml, ProfileException, Non-fatal exceptions in SAML profile processing)
void | annotateException (xmltooling::XMLToolingException *e, const saml2md::EntityDescriptor *entity, const Status *status=nullptr, bool rethrow=true)
| Attaches metadata-derived information as exception properties and optionally rethrows the object. More...
void | annotateException (xmltooling::XMLToolingException *e, const saml2md::RoleDescriptor *role, const Status *status=nullptr, bool rethrow=true)
| Attaches metadata-derived information as exception properties and optionally rethrows the object. More...

## Detailed Description

Common classes for OpenSAML library.

## Function Documentation

void opensaml::annotateException | ( | xmltooling::XMLToolingException * | e,
|  | const saml2md::EntityDescriptor * | entity,
|  | const Status * | status = `nullptr`,
|  | bool | rethrow = `true`
| ) |  |

Attaches metadata-derived information as exception properties and optionally rethrows the object.

The following named properties are attached, when possible:

entityID
  The unique ID of the entity
errorURL
  The error support URL of a random role
contactName
  A formatted support or technical contact name
contactEmail
  A contact email address
statusCode
  Top-level status code from Status object
statusCode2
  Second-level status code from Status object
statusMessage
  StatusMessage from Status object

Parameters

  e | pointer to exception object
  entity | pointer to entity
  status | pointer to Status from message
  rethrow | true iff the exception should be rethrown

void opensaml::annotateException | ( | xmltooling::XMLToolingException * | e,
|  | const saml2md::RoleDescriptor * | role,
|  | const Status * | status = `nullptr`,
|  | bool | rethrow = `true`
| ) |  |

Attaches metadata-derived information as exception properties and optionally rethrows the object.

The following named properties are attached, when possible:

entityID
  The unique ID of the entity
errorURL
  The error support URL of the role
contactName
  A formatted support or technical contact name
contactEmail
  A contact email address
statusCode
  Top-level status code from Status object
statusCode2
  Second-level status code from Status object

Parameters

  e | pointer to exception object
  entity | pointer to role
  status | pointer to Status from message
  rethrow | true iff the exception should be rethrown