opensaml-3.1.0

opensaml Namespace Reference

Common classes for OpenSAML library. More...

Namespaces

namespace  saml1p
 

SAML 1.x protocol namespace.


namespace  saml2
 

SAML 2.0 assertion namespace.


namespace  saml2md
 

SAML 2.0 metadata namespace.


namespace  saml2p
 

SAML 2.0 protocol namespace.


Classes

class  ArtifactMap
 Helper class for SAMLArtifact mapping and retrieval. More...
class  MessageDecoder
 Interface to SAML protocol binding message decoders. More...
class  MessageEncoder
 Interface to SAML protocol binding message encoders. More...
class  SAMLArtifact
 Base class for SAML 1.x and 2.0 artifacts. 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  SOAPClient
 Specialized SOAPClient for SAML SOAP bindings. More...
class  EncryptedKeyResolver
 SAML-specific encrypted key resolver. More...
class  RootObject
 Base class for SAML objects at the root of core schemas. More...
class  Assertion
 Base class for SAML assertions. More...
class  Status
 Base class for SAML status codes. More...
class  SAMLConfig
 Singleton object that manages library startup/shutdown.configuration. More...
class  ContentReference
 SAML-specific signature reference profile. More...
class  SignableObject
 Base class for SAML objects that can be signed. More...
class  SignatureProfileValidator
 SAML-specific signature profile validator. More...
class  CommonDomainCookie
 Helper class for maintaining discovery cookie. More...

Functions

void SAML_API registerMessageDecoders ()
 Registers MessageDecoder plugins into the runtime.
void SAML_API registerMessageEncoders ()
 Registers MessageEncoder plugins into the runtime.
 XMLTOOLING_DOXYGEN (Exceptions related to artifact parsing) class SAML_EXCEPTIONAPI(SAML_API) ArtifactException
void SAML_API registerSAMLArtifacts ()
 Registers SAMLArtifact subclasses into the runtime.
void SAML_API registerSecurityPolicyRules ()
 Registers SecurityPolicyRule plugins into the runtime.
 DECL_XMLTOOLING_EXCEPTION (SecurityPolicyException, SAML_EXCEPTIONAPI(SAML_API), opensaml, xmltooling::XMLToolingException, Exceptions in security policy processing)
 DECL_XMLTOOLING_EXCEPTION (BindingException, SAML_EXCEPTIONAPI(SAML_API), opensaml, xmltooling::XMLToolingException, Exceptions in SAML binding processing)
 DECL_XMLTOOLING_EXCEPTION (ProfileException, SAML_EXCEPTIONAPI(SAML_API), opensaml, xmltooling::ValidationException, Exceptions in SAML profile processing)
 DECL_XMLTOOLING_EXCEPTION (FatalProfileException, SAML_EXCEPTIONAPI(SAML_API), opensaml, ProfileException, Fatal exceptions in SAML profile processing)
 DECL_XMLTOOLING_EXCEPTION (RetryableProfileException, SAML_EXCEPTIONAPI(SAML_API), opensaml, ProfileException, Non-fatal exceptions in SAML profile processing)
void SAML_API 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.
void SAML_API 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.

Variables

class SAML_API SAMLArtifact
class SAML_DLLLOCAL ArtifactMappings
class SAML_API SecurityPolicy
class SAML_API SecurityPolicyRule
class SAML_API Status
class SAML_API SOAPClient
class SAML_API ArtifactMap
class SAML_API MessageEncoder
class SAML_API MessageDecoder
class SAML_API SignableObject

Detailed Description

Common classes for OpenSAML library.


Function Documentation

void SAML_API 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:
epointer to exception object
entitypointer to entity
statuspointer to Status from message
rethrowtrue iff the exception should be rethrown
void SAML_API 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:
epointer to exception object
entitypointer to role
statuspointer to Status from message
rethrowtrue iff the exception should be rethrown