Simias::DomainServices::DomainAgent Class Reference

Simias Domain Agent. More...

Collaboration diagram for Simias::DomainServices::DomainAgent:

[legend]

List of all members.

Public Member Functions
	DomainAgent ()
	Constructor.
Simias.Authentication.Status	Attach (string host, string user, string password)
	Attach to an enterprise system.
bool	IsDomainActive (string DomainID)
	Check if the domain is marked Active or in a connected state.
Simias.Authentication.Status	Login (string DomainID, string Username, string Password)
	Login to a remote domain using username and password Assumes a slave domain has been provisioned locally.
Simias.Authentication.Status	ProvisionToNewHomeServer (string DomainID, NetworkCredential creds)
	Provision the user to new server where he has been moved, Also update local store with new server's ip.
Simias.Authentication.Status	Logout (string DomainID)
	Logout from a domain.
bool	Ping (string DomainID)
	Attempts to "ping" the remote domain.
void	SetDomainActive (string DomainID)
	Sets the status of the specified domain to Active.
void	SetDomainInactive (string DomainID)
	Sets the status of the specified domain to Inactive. setting a domain to inactive will disable all synchronization activity.
void	Unattach (string domainID, bool localOnly)
	Removes this workstation from the domain or removes the workstation from all machines owned by the user.
void	CreateMaster (Collection collection)
	Create the master on the server.
long	GetDomainDiskSpaceForMember (string memberID, out long limit)
	Gets the amount of disk space used on the server by the specified user.
long	GetDomainDiskSpaceForCollection (string collectionID, out long limit)
	Gets the amount of disk space used on the server by the specified collection.

---

Detailed Description

Simias Domain Agent.

---

Constructor & Destructor Documentation

Simias::DomainServices::DomainAgent::DomainAgent

(

)

[inline]

Constructor.

---

Member Function Documentation

Simias.Authentication.Status Simias::DomainServices::DomainAgent::Attach	(	string	host,
		string	user,
		string	password
	)			[inline]

Attach to an enterprise system.

Parameters:

	host	Url of the enterprise server.
	user	User to provision on the server.
	password	Password to validate user.

Returns:

The Domain ID of the newly attached Domain

There was a failure in obtaining the service url. Try a hard coded one.

change to SSL

changing to default port - this needs to be fixed once we change the client UI to have the SSL port

always use SSL for auth

bool Simias::DomainServices::DomainAgent::IsDomainActive

(

string

DomainID

)

[inline]

Check if the domain is marked Active or in a connected state.

Parameters:

DomainID

The identifier of the domain to check status on.

Simias.Authentication.Status Simias::DomainServices::DomainAgent::Login	(	string	DomainID,
		string	Username,
		string	Password
	)			[inline]

Login to a remote domain using username and password Assumes a slave domain has been provisioned locally.

Parameters:

	DomainID	ID of the remote domain.
	Username	Member to login as
	Password	Password to validate user.

Returns:

The status of the remote authentication

only if the URL has http, then we default to default SSL port, otherwise use the port that is mentioned in the URL itself

Simias.Authentication.Status Simias::DomainServices::DomainAgent::ProvisionToNewHomeServer	(	string	DomainID,
		NetworkCredential	creds
	)			[inline]

Provision the user to new server where he has been moved, Also update local store with new server's ip.

Parameters:

	DomainID	The ID of the domain.
	Creds	Network credential of the user

Returns:

The status of the provisioning.

Simias.Authentication.Status Simias::DomainServices::DomainAgent::Logout

(

string

DomainID

)

[inline]

Logout from a domain.

Parameters:

DomainID

The ID of the domain.

Returns:

The status of the logout.

bool Simias::DomainServices::DomainAgent::Ping

(

string

DomainID

)

[inline]

Attempts to "ping" the remote domain.

Parameters:

DomainID

The identifier of the domain.

void Simias::DomainServices::DomainAgent::SetDomainActive

(

string

DomainID

)

[inline]

Sets the status of the specified domain to Active.

Parameters:

DomainID

The identifier of the domain.

void Simias::DomainServices::DomainAgent::SetDomainInactive

(

string

DomainID

)

[inline]

Sets the status of the specified domain to Inactive. setting a domain to inactive will disable all synchronization activity.

Parameters:

DomainID

The identifier of the domain.

void Simias::DomainServices::DomainAgent::Unattach	(	string	domainID,
		bool	localOnly
	)			[inline]

Removes this workstation from the domain or removes the workstation from all machines owned by the user.

Parameters:

	domainID	The identifier of the domain to remove.
	localOnly	If true then only this workstation is removed from the domain. If false, then the domain will be deleted from every workstation that the user owns.

remove rest of the nodes in the domain

void Simias::DomainServices::DomainAgent::CreateMaster

(

Collection

collection

)

[inline]

Create the master on the server.

Parameters:

collection

Collection to create on the enterprise server.

long Simias::DomainServices::DomainAgent::GetDomainDiskSpaceForMember	(	string	memberID,
		out long	limit
	)			[inline]

Gets the amount of disk space used on the server by the specified user.

Parameters:

	memberID	Member ID for the user.
	limit	Gets the disk space limit for this user.

Returns:

The amount of disk space used on the server. Zero indicates that there is no disk space restriction.

long Simias::DomainServices::DomainAgent::GetDomainDiskSpaceForCollection	(	string	collectionID,
		out long	limit
	)			[inline]

Gets the amount of disk space used on the server by the specified collection.

Parameters:

	collectionID	Collection ID to get disk space for.
	limit	Gets the disk space limit for this collection.

Returns:

The amount of disk space used on the server by the specified collection.

---

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

• src/core/Domain/DomainAgent.cs