Simias::IdentitySync::State Class Reference

Class used to maintain state across an external identity synchronization cycle. More...

Collaboration diagram for Simias::IdentitySync::State:

[legend]

List of all members.

Public Member Functions
	State (string DomainID)
	Constructs a State object.
void	ProcessMember (string UserGuid, string Username, string Given, string Last, string FN, string DN, Property[] Properties)
	External sync providers must call this method after retrieving member information from the external identity store. Username is the distinguishing property validated against the domain.
void	ReportError (string ErrorMsg)
	Method to report errors against a specific sync cycle Used by the Sync Service and Sync Providers.
void	ReportInformation (string Message)
Properties
Domain	SDomain [get]
	Gets the Domain object.
int	Processed [get]
	Gets the number of objects that were processed.
int	Errors [get]
	Gets the number of errors reported.
string[]	Messages [get]
	Gets an array of synchronization messages.
int	Created [get]
	Gets the number of objects that were created.
int	Updated [get]
	Gets the number of objects that were updated.
int	Deleted [get]
	Gets the number of objects that were deleted.
int	Disabled [get]
	Gets the number of objects that were disabled.
DateTime	StartTime [get]
	Gets the time that the synchronization cycle started.
DateTime	EndTime [get, set]
	Gets the time that the synchronization cycle ended.
Property	SyncGuid [get]
	Gets the GUID associated with the current synchronization cycle.

---

Detailed Description

Class used to maintain state across an external identity synchronization cycle.

---

Constructor & Destructor Documentation

Simias::IdentitySync::State::State

(

string

DomainID

)

[inline]

Constructs a State object.

Parameters:

DomainID

The identifier of the domain to synchronize.

---

Member Function Documentation

void Simias::IdentitySync::State::ProcessMember	(	string	UserGuid,
		string	Username,
		string	Given,
		string	Last,
		string	FN,
		string	DN,
		Property[]	Properties
	)			[inline]

External sync providers must call this method after retrieving member information from the external identity store. Username is the distinguishing property validated against the domain.

void Simias::IdentitySync::State::ReportError

(

string

ErrorMsg

)

[inline]

Method to report errors against a specific sync cycle Used by the Sync Service and Sync Providers.

void Simias::IdentitySync::State::ReportInformation

(

string

Message

)

[inline]

Method to report information against a specific sync cycle Used by the Sync Service and Sync Providers.

---

Property Documentation

Domain Simias::IdentitySync::State::SDomain [get]

Gets the Domain object.

int Simias::IdentitySync::State::Processed [get]

Gets the number of objects that were processed.

int Simias::IdentitySync::State::Errors [get]

Gets the number of errors reported.

string [] Simias::IdentitySync::State::Messages [get]

Gets an array of synchronization messages.

int Simias::IdentitySync::State::Created [get]

Gets the number of objects that were created.

int Simias::IdentitySync::State::Updated [get]

Gets the number of objects that were updated.

int Simias::IdentitySync::State::Deleted [get]

Gets the number of objects that were deleted.

int Simias::IdentitySync::State::Disabled [get]

Gets the number of objects that were disabled.

DateTime Simias::IdentitySync::State::StartTime [get]

Gets the time that the synchronization cycle started.

DateTime Simias::IdentitySync::State::EndTime [get, set]

Gets the time that the synchronization cycle ended.

Property Simias::IdentitySync::State::SyncGuid [get]

Gets the GUID associated with the current synchronization cycle.

---

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

• src/server/Simias.Server/IdentitySyncService.cs