shibsp::NameIDAttribute Class Reference

An Attribute whose values are derived from or mappable to a SAML NameID. More...

#include <shibsp/attribute/NameIDAttribute.h>

Inheritance diagram for shibsp::NameIDAttribute:

shibsp::Attribute

List of all members.

Public Member Functions

 NameIDAttribute (const std::vector< std::string > &ids, const char *formatter="$Name!!$NameQualifier!!$SPNameQualifier")
 Constructor.
 NameIDAttribute (DDF &in)
 Constructs based on a remoted NameIDAttribute.
std::vector< Value > & getValues ()
 Returns the set of values encoded as UTF-8 strings.
const std::vector< Value > & getValues () const
 Returns the set of values encoded as UTF-8 strings.
size_t valueCount () const
 Returns the number of values.
void clearSerializedValues ()
 Informs the Attribute that values have changed and any serializations must be cleared.
const char * getString (size_t index) const
 Gets the string equivalent of the value at the specified position (starting from zero).
const char * getScope (size_t index) const
 Gets the "scope" of the value at the specified position (starting from zero).
void removeValue (size_t index)
 Removes the value at the specified position (starting from zero).
const std::vector< std::string > & getSerializedValues () const
 Returns serialized Attribute values encoded as UTF-8 strings.
DDF marshall () const
 Marshalls an Attribute for remoting.

Classes

struct  Value
 Holds all the fields associated with a NameID. More...


Detailed Description

An Attribute whose values are derived from or mappable to a SAML NameID.

Constructor & Destructor Documentation

shibsp::NameIDAttribute::NameIDAttribute ( const std::vector< std::string > &  ids,
const char *  formatter = "$Name!!$NameQualifier!!$SPNameQualifier" 
)

Constructor.

Parameters:
ids array with primary identifier in first position, followed by any aliases
formatter template for serialization of tuple

shibsp::NameIDAttribute::NameIDAttribute ( DDF in  ) 

Constructs based on a remoted NameIDAttribute.

Parameters:
in input object containing marshalled NameIDAttribute


Member Function Documentation

std::vector<Value>& shibsp::NameIDAttribute::getValues (  ) 

Returns the set of values encoded as UTF-8 strings.

Returns:
a mutable vector of the values

const std::vector<Value>& shibsp::NameIDAttribute::getValues (  )  const

Returns the set of values encoded as UTF-8 strings.

Returns:
an immutable vector of the values

size_t shibsp::NameIDAttribute::valueCount (  )  const [virtual]

Returns the number of values.

Returns:
number of values

Reimplemented from shibsp::Attribute.

const char* shibsp::NameIDAttribute::getString ( size_t  index  )  const [virtual]

Gets the string equivalent of the value at the specified position (starting from zero).

Parameters:
index position of value
Returns:
the specified value in its "string" form, or nullptr if undefined

Reimplemented from shibsp::Attribute.

const char* shibsp::NameIDAttribute::getScope ( size_t  index  )  const [virtual]

Gets the "scope" of the value at the specified position (starting from zero).

Parameters:
index position of value
Returns:
the specified value's "scope", or nullptr if attribute is unscoped

Reimplemented from shibsp::Attribute.

void shibsp::NameIDAttribute::removeValue ( size_t  index  )  [virtual]

Removes the value at the specified position (starting from zero).

Parameters:
index position of value to remove

Reimplemented from shibsp::Attribute.

const std::vector<std::string>& shibsp::NameIDAttribute::getSerializedValues (  )  const [virtual]

Returns serialized Attribute values encoded as UTF-8 strings.

Returns:
an immutable vector of values

Reimplemented from shibsp::Attribute.

DDF shibsp::NameIDAttribute::marshall (  )  const [virtual]

Marshalls an Attribute for remoting.

This allows Attribute objects to be communicated across process boundaries without excess XML parsing. The DDF returned must be a struct containing a single list member named with the Attribute's "id". The name of the struct should contain the registered name of the Attribute implementation.

Reimplemented from shibsp::Attribute.


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

Generated on Tue Jul 26 01:11:32 2011 for shibboleth-2.4.3 by  doxygen 1.5.6