Simias::IDomainProvider Interface Reference

Interface for a Domain Provider Service. More...

Inheritance diagram for Simias::IDomainProvider:

[legend]

List of all members.

Public Member Functions
Authentication.Status	Authenticate (Domain domain, HttpContext httpContext)
	Performs authentication to the specified domain.
void	DeleteLocation (string domainID, string collectionID)
	Indicates to the provider that the specified collection has been deleted and a mapping is no longer required.
void	FindCloseDomainMembers (string searchContext)
	End the search for domain members.
bool	FindFirstDomainMembers (string domainID, int count, out string searchContext, out Member[] memberList, out int total)
	Starts a search for all domain members.
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.
bool	FindNextDomainMembers (ref string searchContext, int count, out Member[] memberList)
	Continues the search for domain members from the current record location.
bool	FindPreviousDomainMembers (ref string searchContext, int count, out Member[] memberList)
	Continues the search for domain members previous to the current record location.
bool	FindSeekDomainMembers (ref string searchContext, int offset, int count, out Member[] memberList)
	Continues the search for domain members from the specified record location.
bool	OwnsDomain (string domainID)
	Determines if the provider claims ownership for the specified domain.
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.
Uri	ResolveLocation (string domainID)
	Returns the network location for the the specified domain.
Uri	ResolveLocation (string domainID, string collectionID)
	Returns the network location for the the specified collection.
Uri	ResolveLocation (string domainID, string userID, string collectionID)
	Returns the network location of where to create a collection.
Uri	ResolvePOBoxLocation (string domainID, string userID)
	Returns the network location of where to the specified user's POBox is located.
Uri	ResolveHostAddress (string domainID, string hostID)
	Returns the network address of the host.
void	SetHostLocation (string domainID, Uri hostLocation)
	Sets a new host address for the domain.
Properties
string	Name [get]
	Gets the name of the domain provider.
string	Description [get]
	Gets the description of the domain provider.

---

Detailed Description

Interface for a Domain Provider Service.

---

Member Function Documentation

Authentication.Status Simias::IDomainProvider::Authenticate	(	Domain	domain,
		HttpContext	httpContext
	)

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.

Implemented in Simias::EnterpriseProvider, and Simias::LocalProvider.

void Simias::IDomainProvider::DeleteLocation	(	string	domainID,
		string	collectionID
	)

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

Parameters:

	domainID	The identifier for the domain from where the collection has been deleted.
	collectionID	Identifier of the collection that is being deleted.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

void Simias::IDomainProvider::FindCloseDomainMembers

(

string

searchContext

)

End the search for domain members.

Parameters:

searchContext

Domain provider specific search context returned by FindFirstDomainMembers or FindNextDomainMembers methods.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

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

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. This object must be serializable.
	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.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

bool Simias::IDomainProvider::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.

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. This object must be serializable.
	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.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

bool Simias::IDomainProvider::FindNextDomainMembers	(	ref string	searchContext,
		int	count,
		out Member[]	memberList
	)

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

Parameters:

	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.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

bool Simias::IDomainProvider::FindPreviousDomainMembers	(	ref string	searchContext,
		int	count,
		out Member[]	memberList
	)

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

Parameters:

	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.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

bool Simias::IDomainProvider::FindSeekDomainMembers	(	ref string	searchContext,
		int	offset,
		int	count,
		out Member[]	memberList
	)

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

Parameters:

	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.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

bool Simias::IDomainProvider::OwnsDomain

(

string

domainID

)

Determines if the provider claims ownership for the specified domain.

Parameters:

domainID

Identifier of a domain.

Returns:

True if the provider claims ownership for the specified domain. Otherwise, False is returned.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

void Simias::IDomainProvider::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.

Parameters:

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

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

Uri Simias::IDomainProvider::ResolveLocation

(

string

domainID

)

Returns the network location for the the specified domain.

Parameters:

domainID

Identifier for the domain.

Returns:

A Uri object that contains the network location.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

Uri Simias::IDomainProvider::ResolveLocation	(	string	domainID,
		string	collectionID
	)

Returns the network location for the the specified collection.

Parameters:

	domainID	Identifier for the domain that the collection belongs to.
	collectionID	Identifier of the collection to find the network location for.

Returns:

A Uri object that contains the network location.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

Uri Simias::IDomainProvider::ResolveLocation	(	string	domainID,
		string	userID,
		string	collectionID
	)

Returns the network location of where to create a collection.

Parameters:

	domainID	Identifier of the domain where a collection is to be created.
	userID	The member that will own the collection.
	collectionID	Identifier of the collection that is being created.

Returns:

A Uri object that contains the network location.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

Uri Simias::IDomainProvider::ResolvePOBoxLocation	(	string	domainID,
		string	userID
	)

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.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

Uri Simias::IDomainProvider::ResolveHostAddress	(	string	domainID,
		string	hostID
	)

Returns the network address of the host.

Parameters:

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

Returns:

A Uri object that contains the network location.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

void Simias::IDomainProvider::SetHostLocation	(	string	domainID,
		Uri	hostLocation
	)

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.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

---

Property Documentation

string Simias::IDomainProvider::Name [get]

Gets the name of the domain provider.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

string Simias::IDomainProvider::Description [get]

Gets the description of the domain provider.

Implemented in Simias::EnterpriseProvider, Simias::LocalProvider, and Simias::Server::Authentication.

---

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

• src/core/DomainProvider/IDomainProvider.cs