An Attribute whose values are derived from or mappable to a SAML NameID.
More...
#include <shibsp/attribute/NameIDAttribute.h>
|
struct | Value |
| Holds all the fields associated with a NameID. More...
|
|
An Attribute whose values are derived from or mappable to a SAML NameID.
shibsp::NameIDAttribute::NameIDAttribute |
( |
const std::vector< std::string > & |
ids, |
|
|
const char * |
formatter = "$Name!!$NameQualifier!!$SPNameQualifier" , |
|
|
const char * |
hashAlg = nullptr |
|
) |
| |
Constructor.
- Parameters
-
ids | array with primary identifier in first position, followed by any aliases |
formatter | template for serialization of tuple |
hashAlg | hash algorithm to apply in producing serialized values |
shibsp::NameIDAttribute::NameIDAttribute |
( |
DDF & |
in | ) |
|
const char* shibsp::NameIDAttribute::getScope |
( |
size_t |
index | ) |
const |
|
virtual |
Gets the "scope" of the value at the specified position (starting from zero).
- Parameters
-
- Returns
- the specified value's "scope", or nullptr if attribute is unscoped
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.
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
-
- Returns
- the specified value in its "string" form, or nullptr if undefined
Reimplemented from shibsp::Attribute.
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
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.
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.
size_t shibsp::NameIDAttribute::valueCount |
( |
| ) |
const |
|
virtual |
Returns the number of values.
- Returns
- number of values
Reimplemented from shibsp::Attribute.
The documentation for this class was generated from the following file: