Simias::Authentication::SimiasCredentials Class Reference

Summary description for Credentials. More...

Inheritance diagram for Simias::Authentication::SimiasCredentials:

Collaboration diagram for Simias::Authentication::SimiasCredentials:

List of all members.

Public Member Functions

SimiasCredentials (string DomainID, string CollectionID, string ID)

Construct a credential set based on Domain, Collection and ID If the domain is of type enterprise and scoping is done solely on the domain, the DomainID should be used for the collection as well. During construction, the system will attempt to find a full credential set in cache. If a full set exists, the Cached property will return true and all credential properties will be vallid.

virtual void Save (bool persistent)

Save the credentials to a volatile cache persistent == true - save to a long term cache.

virtual void Remove ()

Remove the credential from the volatile cache If the credential has been persisted, remove it from that cache as well.

Properties

object Blob [get, set]

Returns true if this credential set has been cached false if the credentials have not been cached.

bool Cached [get]

Returns true if this credential set has been cached false if the credentials have not been cached.

string CollectionID [get]

CollectionID for this credential set.

bool Default [get, set]

Returns true if this credential set is default default is the default Simias domain If default, the credential class will attempt to leverage CASA's "Network" credential set.

string DomainID [get]

DomainID for this credential set.

string ID [get]

Principal or ID for this credential set.

bool Persisted [get]

Returns true if the credentials have been persisted to long term storage false if the credentials are not persisted.

Detailed Description

Summary description for Credentials.

Constructor & Destructor Documentation

Simias::Authentication::SimiasCredentials::SimiasCredentials	(	string	DomainID,
		string	CollectionID,
		string	ID
	)			`[inline]`

Construct a credential set based on Domain, Collection and ID If the domain is of type enterprise and scoping is done solely on the domain, the DomainID should be used for the collection as well. During construction, the system will attempt to find a full credential set in cache. If a full set exists, the Cached property will return true and all credential properties will be vallid.

Member Function Documentation

virtual void Simias::Authentication::SimiasCredentials::Save ( bool persistent ) [inline, virtual]

Save the credentials to a volatile cache persistent == true - save to a long term cache.

Reimplemented in Simias::Authentication::BasicCredentials.

virtual void Simias::Authentication::SimiasCredentials::Remove ( ) [inline, virtual]

Remove the credential from the volatile cache If the credential has been persisted, remove it from that cache as well.

Property Documentation

object Simias::Authentication::SimiasCredentials::Blob [get, set]

Returns true if this credential set has been cached false if the credentials have not been cached.

bool Simias::Authentication::SimiasCredentials::Cached [get]

Returns true if this credential set has been cached false if the credentials have not been cached.

string Simias::Authentication::SimiasCredentials::CollectionID [get]

CollectionID for this credential set.

bool Simias::Authentication::SimiasCredentials::Default [get, set]

Returns true if this credential set is default default is the default Simias domain If default, the credential class will attempt to leverage CASA's "Network" credential set.

string Simias::Authentication::SimiasCredentials::DomainID [get]

DomainID for this credential set.

string Simias::Authentication::SimiasCredentials::ID [get]

Principal or ID for this credential set.

bool Simias::Authentication::SimiasCredentials::Persisted [get]

Returns true if the credentials have been persisted to long term storage false if the credentials are not persisted.

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

src/core/Credentials/Credentials.cs


Public Member Functions
	SimiasCredentials (string DomainID, string CollectionID, string ID)
	Construct a credential set based on Domain, Collection and ID If the domain is of type enterprise and scoping is done solely on the domain, the DomainID should be used for the collection as well. During construction, the system will attempt to find a full credential set in cache. If a full set exists, the Cached property will return true and all credential properties will be vallid.
virtual void	Save (bool persistent)
	Save the credentials to a volatile cache persistent == true - save to a long term cache.
virtual void	Remove ()
	Remove the credential from the volatile cache If the credential has been persisted, remove it from that cache as well.
Properties
object	Blob `[get, set]`
	Returns true if this credential set has been cached false if the credentials have not been cached.
bool	Cached `[get]`
	Returns true if this credential set has been cached false if the credentials have not been cached.
string	CollectionID `[get]`
	CollectionID for this credential set.
bool	Default `[get, set]`
	Returns true if this credential set is default default is the default Simias domain If default, the credential class will attempt to leverage CASA's "Network" credential set.
string	DomainID `[get]`
	DomainID for this credential set.
string	ID `[get]`
	Principal or ID for this credential set.
bool	Persisted `[get]`
	Returns true if the credentials have been persisted to long term storage false if the credentials are not persisted.