opensaml::SAMLArtifact Class Reference

Base class for SAML 1.x and 2.0 artifacts. More...

#include <saml/binding/SAMLArtifact.h>

Inheritance diagram for opensaml::SAMLArtifact:

opensaml::saml1p::SAMLArtifactType0001 opensaml::saml1p::SAMLArtifactType0002 opensaml::saml2p::SAML2Artifact opensaml::saml2p::SAML2ArtifactType0004

List of all members.

Public Member Functions

virtual std::string encode () const
 Returns artifact encoded into null-terminated base64 for transmission.
virtual SAMLArtifactclone () const =0
 Builds a duplicate, independent artifact of the same type.
virtual std::string getBytes () const
 Returns all of the raw binary data that makes up the artifact.
virtual std::string getTypeCode () const
 Returns the binary type code of the artifact.
virtual std::string getRemainingArtifact () const
 Returns the binary artifact data following the type code.
virtual std::string getSource () const =0
 Returns a string that identifies the source of the artifact.
virtual std::string getMessageHandle () const =0
 Returns the binary data that references the message (2.0) or assertion (1.x) The exact form this takes depends on the type.

Static Public Member Functions

static SAMLArtifactparse (const char *s)
 Parses a base64-encoded null-terminated string into an artifact, if the type is known.
static SAMLArtifactparse (const XMLCh *s)
 Parses a base64-encoded null-terminated string into an artifact, if the type is known.
static std::string toHex (const std::string &s)
 Converts binary data to hex notation.

Static Public Attributes

static const unsigned int TYPECODE_LENGTH
 Length of type code.

Protected Member Functions

 SAMLArtifact (const char *s)
 Decodes a base64-encoded artifact into its raw form.
 SAMLArtifact (const SAMLArtifact &src)

Protected Attributes

std::string m_raw
 Raw binary data that makes up an artifact.


Detailed Description

Base class for SAML 1.x and 2.0 artifacts.

Constructor & Destructor Documentation

opensaml::SAMLArtifact::SAMLArtifact ( const char *  s  )  [protected]

Decodes a base64-encoded artifact into its raw form.

Parameters:
s NULL-terminated base64-encoded string


Member Function Documentation

virtual SAMLArtifact* opensaml::SAMLArtifact::clone (  )  const [pure virtual]

Builds a duplicate, independent artifact of the same type.

Returns:
the new artifact

Implemented in opensaml::saml1p::SAMLArtifactType0001, opensaml::saml1p::SAMLArtifactType0002, and opensaml::saml2p::SAML2ArtifactType0004.

virtual std::string opensaml::SAMLArtifact::getBytes (  )  const [virtual]

Returns all of the raw binary data that makes up the artifact.

The result is NOT null-terminated.

Returns:
the binary artifact data

virtual std::string opensaml::SAMLArtifact::getTypeCode (  )  const [virtual]

Returns the binary type code of the artifact.

The result MAY contain embedded null characters.

Returns:
the binary type code

virtual std::string opensaml::SAMLArtifact::getRemainingArtifact (  )  const [virtual]

Returns the binary artifact data following the type code.

The result MAY contain embedded null characters.

Returns:
the binary artifact data

virtual std::string opensaml::SAMLArtifact::getSource (  )  const [pure virtual]

Returns a string that identifies the source of the artifact.

The exact form this takes depends on the type but should match the syntax needed for metadata lookup.

Returns:
null-terminated source string

Implemented in opensaml::saml1p::SAMLArtifactType0001, opensaml::saml1p::SAMLArtifactType0002, and opensaml::saml2p::SAML2ArtifactType0004.

virtual std::string opensaml::SAMLArtifact::getMessageHandle (  )  const [pure virtual]

Returns the binary data that references the message (2.0) or assertion (1.x) The exact form this takes depends on the type.

The result MAY contain embedded null characters.

Returns:
the binary reference data

Implemented in opensaml::saml1p::SAMLArtifactType0001, opensaml::saml1p::SAMLArtifactType0002, and opensaml::saml2p::SAML2ArtifactType0004.

static SAMLArtifact* opensaml::SAMLArtifact::parse ( const char *  s  )  [static]

Parses a base64-encoded null-terminated string into an artifact, if the type is known.

Parameters:
s base64-encoded artifact
Returns:
the decoded artifact

static SAMLArtifact* opensaml::SAMLArtifact::parse ( const XMLCh *  s  )  [static]

Parses a base64-encoded null-terminated string into an artifact, if the type is known.

Parameters:
s base64-encoded artifact
Returns:
the decoded artifact

static std::string opensaml::SAMLArtifact::toHex ( const std::string &  s  )  [static]

Converts binary data to hex notation.

Parameters:
s the bytes to convert
Returns:
the data in hex form, 2 characters per byte


Member Data Documentation

std::string opensaml::SAMLArtifact::m_raw [protected]

Raw binary data that makes up an artifact.


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

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