Simias::DomainProvider Class Reference

Class that implements the domain provider functionality. More...

Collaboration diagram for Simias::DomainProvider:

List of all members.

Static Public Member Functions

static Authentication.Status Authenticate (Domain domain, HttpContext httpContext)

Performs authentication to the specified domain.

static void DeleteLocation (Collection collection)

Indicates to the provider that the specified collection has been deleted and a mapping is no longer required.

static void FindCloseDomainMembers (string domainID, string searchContext)

End the search for domain members.

static bool FindFirstDomainMembers (string domainID, int count, out string searchContext, out Member[] memberList, out int total)

Starts a search for all domain members.

static bool FindFirstDomainMembers (string domainID, string attributeName, string searchString, SearchOp operation, int count, out string searchContext, out Member[] memberList, out int total)

Starts a search for a specific set of domain members.

static bool FindNextDomainMembers (string domainID, ref string searchContext, int count, out Member[] memberList)

Continues the search for domain members from the current record location.

static bool FindPreviousDomainMembers (string domainID, ref string searchContext, int count, out Member[] memberList)

Continues the search for domain members previous to the current record location.

static bool FindSeekDomainMembers (string domainID, ref string searchContext, int offset, int count, out Member[] memberList)

Continues the search for domain members from the specified record location.

static void PreCommit (string domainID, Member member)

Informs the domain provider that the specified member object is about to be committed to the domain's member list. This allows an opportunity for the domain provider to add any domain specific attributes to the member object.

static void RegisterProvider (IDomainProvider provider)

Registers the specified domain provider with the domain provider service.

static Uri ResolveLocation (Collection collection)

Returns the network location for the the specified collection.

static Uri ResolveLocation (string domainID)

Returns the network location for the the specified domain.

static Uri ResolvePOBoxLocation (string domainID, string userID)

Returns the network location of where to the specified user's POBox is located.

static Uri ResolveHostAddress (string domainID, string hostID)

Returns the network location of the specified host.

static void Unregister (IDomainProvider provider)

Unregisters this domain provider from the domain provider service.

static void SetHostLocation (string domainID, Uri hostLocation)

Sets a new host address for the domain.

Properties

static int Count [get]

Gets the number of registered providers.

static IDomainProvider[] Providers [get]

Returns the registered domain providers.

Detailed Description

Class that implements the domain provider functionality.

Member Function Documentation

static Authentication.Status Simias::DomainProvider::Authenticate	(	Domain	domain,
		HttpContext	httpContext
	)			`[inline, static]`

Performs authentication to the specified domain.

Parameters:

	domain	Domain to authenticate to.
	httpContext	HTTP-specific request information. This is passed as a parameter so that a domain provider may modify the HTTP request by adding special headers as necessary.

NOTE: The domain provider must NOT end the HTTP request.

Returns:: The status from the authentication.

static void Simias::DomainProvider::DeleteLocation ( Collection collection ) [inline, static]

Indicates to the provider that the specified collection has been deleted and a mapping is no longer required.

Parameters:

collection

Collection that is being deleted.

static void Simias::DomainProvider::FindCloseDomainMembers	(	string	domainID,
		string	searchContext
	)			`[inline, static]`

End the search for domain members.

Parameters:

	domainID	The identifier of the domain.
	searchContext	Domain provider specific search context returned by FindFirstDomainMembers or FindNextDomainMembers methods.

static bool Simias::DomainProvider::FindFirstDomainMembers	(	string	domainID,
		int	count,
		out string	searchContext,
		out Member[]	memberList,
		out int	total
	)			`[inline, static]`

Starts a search for all domain members.

Parameters:

	domainID	The identifier of the domain to search for members in.
	count	Maximum number of member objects to return.
	searchContext	Receives a provider specific search context object.
	memberList	Receives an array object that contains the domain Member objects.
	total	Receives the total number of objects found in the search.

Returns:: True if there are more domain members. Otherwise false is returned.

static bool Simias::DomainProvider::FindFirstDomainMembers	(	string	domainID,
		string	attributeName,
		string	searchString,
		SearchOp	operation,
		int	count,
		out string	searchContext,
		out Member[]	memberList,
		out int	total
	)			`[inline, static]`

Starts a search for a specific set of domain members.

Parameters:

	domainID	The identifier of the domain to search for members in.
	attributeName	Attribute name to search.
	searchString	String that contains a pattern to search for.
	operation	Type of search operation to perform.
	count	Maximum number of member objects to return.
	searchContext	Receives a provider specific search context object.
	memberList	Receives an array object that contains the domain Member objects.
	total	Receives the total number of objects found in the search.

Returns:: True if there are more domain members. Otherwise false is returned.

static bool Simias::DomainProvider::FindNextDomainMembers	(	string	domainID,
		ref string	searchContext,
		int	count,
		out Member[]	memberList
	)			`[inline, static]`

Continues the search for domain members from the current record location.

Parameters:

	domainID	The identifier of the domain to search for members in.
	searchContext	Domain provider specific search context returned by FindFirstDomainMembers method.
	count	Maximum number of member objects to return.
	memberList	Receives an array object that contains the domain Member objects.

Returns:: True if there are more domain members. Otherwise false is returned.

static bool Simias::DomainProvider::FindPreviousDomainMembers	(	string	domainID,
		ref string	searchContext,
		int	count,
		out Member[]	memberList
	)			`[inline, static]`

Continues the search for domain members previous to the current record location.

Parameters:

	domainID	The identifier of the domain to search for members in.
	searchContext	Domain provider specific search context returned by FindFirstDomainMembers method.
	count	Maximum number of member objects to return.
	memberList	Receives an array object that contains the domain Member objects.

Returns:: True if there are more domain members. Otherwise false is returned.

static bool Simias::DomainProvider::FindSeekDomainMembers	(	string	domainID,
		ref string	searchContext,
		int	offset,
		int	count,
		out Member[]	memberList
	)			`[inline, static]`

Continues the search for domain members from the specified record location.

Parameters:

	domainID	The identifier of the domain to search for members in.
	searchContext	Domain provider specific search context returned by FindFirstDomainMembers method.
	offset	Record offset to return members from.
	count	Maximum number of member objects to return.
	memberList	Receives an array object that contains the domain Member objects.

Returns:: True if there are more domain members. Otherwise false is returned.

static void Simias::DomainProvider::PreCommit	(	string	domainID,
		Member	member
	)			`[inline, static]`

Informs the domain provider that the specified member object is about to be committed to the domain's member list. This allows an opportunity for the domain provider to add any domain specific attributes to the member object.

Parameters:

	domainID	Identifier of a domain.
	member	Member object that is about to be committed to the domain's member list.

static void Simias::DomainProvider::RegisterProvider ( IDomainProvider provider ) [inline, static]

Registers the specified domain provider with the domain provider service.

Parameters:

provider

An ILocationProvider interface object.

static Uri Simias::DomainProvider::ResolveLocation ( Collection collection ) [inline, static]

Returns the network location for the the specified collection.

Parameters:

collection

Collection to find the network location for.

Returns:: A Uri object that contains the network location. If the network location could not be determined, a null is returned.

static Uri Simias::DomainProvider::ResolveLocation ( string domainID ) [inline, static]

Returns the network location for the the specified domain.

Parameters:

domainID

Identifier for the domain.

Returns:: A Uri object that contains the network location.

static Uri Simias::DomainProvider::ResolvePOBoxLocation	(	string	domainID,
		string	userID
	)			`[inline, static]`

Returns the network location of where to the specified user's POBox is located.

Parameters:

	domainID	Identifier of the domain where a collection is to be created.
	userID	The member that will owns the POBox.

Returns:: A Uri object that contains the network location.

static Uri Simias::DomainProvider::ResolveHostAddress	(	string	domainID,
		string	hostID
	)			`[inline, static]`

Returns the network location of the specified host.

Parameters:

	domainID	Identifier of the domain where a collection is to be created.
	userID	The host to resolve.

Returns:: A Uri object that contains the network location.

static void Simias::DomainProvider::Unregister ( IDomainProvider provider ) [inline, static]

Unregisters this domain provider from the domain provider service.

Parameters:

provider

Domain provider to unregister.

static void Simias::DomainProvider::SetHostLocation	(	string	domainID,
		Uri	hostLocation
	)			`[inline, static]`

Sets a new host address for the domain.

Parameters:

	domainID	Identifier of the domain for network address to be changed.
	hostLocation	A Uri object containing the new network address for the domain.

Property Documentation

int Simias::DomainProvider::Count [static, get]

Gets the number of registered providers.

IDomainProvider [] Simias::DomainProvider::Providers [static, get]

Returns the registered domain providers.

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

src/core/DomainProvider/DomainProvider.cs


Static Public Member Functions
static Authentication.Status	Authenticate (Domain domain, HttpContext httpContext)
	Performs authentication to the specified domain.
static void	DeleteLocation (Collection collection)
	Indicates to the provider that the specified collection has been deleted and a mapping is no longer required.
static void	FindCloseDomainMembers (string domainID, string searchContext)
	End the search for domain members.
static bool	FindFirstDomainMembers (string domainID, int count, out string searchContext, out Member[] memberList, out int total)
	Starts a search for all domain members.
static bool	FindFirstDomainMembers (string domainID, string attributeName, string searchString, SearchOp operation, int count, out string searchContext, out Member[] memberList, out int total)
	Starts a search for a specific set of domain members.
static bool	FindNextDomainMembers (string domainID, ref string searchContext, int count, out Member[] memberList)
	Continues the search for domain members from the current record location.
static bool	FindPreviousDomainMembers (string domainID, ref string searchContext, int count, out Member[] memberList)
	Continues the search for domain members previous to the current record location.
static bool	FindSeekDomainMembers (string domainID, ref string searchContext, int offset, int count, out Member[] memberList)
	Continues the search for domain members from the specified record location.
static void	PreCommit (string domainID, Member member)
	Informs the domain provider that the specified member object is about to be committed to the domain's member list. This allows an opportunity for the domain provider to add any domain specific attributes to the member object.
static void	RegisterProvider (IDomainProvider provider)
	Registers the specified domain provider with the domain provider service.
static Uri	ResolveLocation (Collection collection)
	Returns the network location for the the specified collection.
static Uri	ResolveLocation (string domainID)
	Returns the network location for the the specified domain.
static Uri	ResolvePOBoxLocation (string domainID, string userID)
	Returns the network location of where to the specified user's POBox is located.
static Uri	ResolveHostAddress (string domainID, string hostID)
	Returns the network location of the specified host.
static void	Unregister (IDomainProvider provider)
	Unregisters this domain provider from the domain provider service.
static void	SetHostLocation (string domainID, Uri hostLocation)
	Sets a new host address for the domain.
Properties
static int	Count `[get]`
	Gets the number of registered providers.
static IDomainProvider[]	Providers `[get]`
	Returns the registered domain providers.