Simias::Host::HostAdmin Class Reference

HostAdmin -. More...

Inheritance diagram for Simias::Host::HostAdmin:

[legend]

Collaboration diagram for Simias::Host::HostAdmin:

[legend]

List of all members.

Public Member Functions
	HostAdmin ()
	HostAdmin - default constructor.
bool	SetHomeServer (string userID, string serverID)
	Set home server for this user on the server.
bool	MigrateUser (string userID)
	returns false always
bool	ProvisionUser ()
	Provision the user.
string	AddHost (string name, string publicAddress, string privateAddress, string publicKey, out bool created)
	add host into domain
void	DeleteHost (string id)
	delete this host
void	DeleteHostByName (string Name)
	DeleteHostByName deletes the slave entry by name.
string	GetConfiguration ()
	Get the configuration from this server.
string	GetDomain ()
	Get the domain.
string	GetDomainOwner ()
	get domain owner
void	SetHostAddress (string Host, string PublicUrl, string PrivateUrl)
	Method to set/reset public and private addresses of a host Note: The Host parameter can be represented as the Host ID or the Host name. If the Host is null local host is assumed.
	HostAdmin ()
	HostAdmin - default constructor.
bool	SetHomeServer (string userID, string serverID)
	Set the home server.
bool	MigrateUser (string userID)
	currently it returns false always
bool	ProvisionUser ()
	returns false
string	AddHost (string name, string publicAddress, string privateAddress, string publicKey, out bool created)
	Add the host into domain.
void	DeleteHost (string id)
	delete the host from domain
string	GetConfiguration ()
	Get the configuration from this server.
string	GetDomain ()
	Get the local domain properties.
string	GetDomainOwner ()
	get the domain owner

---

Detailed Description

HostAdmin -.

---

Constructor & Destructor Documentation

Simias::Host::HostAdmin::HostAdmin

(

)

[inline]

HostAdmin - default constructor.

Simias::Host::HostAdmin::HostAdmin

(

)

[inline]

HostAdmin - default constructor.

---

Member Function Documentation

bool Simias::Host::HostAdmin::SetHomeServer	(	string	userID,
		string	serverID
	)			[inline]

Set home server for this user on the server.

Parameters:

	userID	user id
	server	server id

Returns:

true if set successfully

bool Simias::Host::HostAdmin::MigrateUser

(

string

userID

)

[inline]

returns false always

Parameters:

userID

Returns:

false

bool Simias::Host::HostAdmin::ProvisionUser

(

)

[inline]

Provision the user.

Returns:

false

string Simias::Host::HostAdmin::AddHost	(	string	name,
		string	publicAddress,
		string	privateAddress,
		string	publicKey,
		out bool	created
	)			[inline]

add host into domain

Parameters:

	name	host name
	publicAddress	public address of host
	privateAddress	private address of host
	publicKey	public key of host

Returns:

host properties as string

void Simias::Host::HostAdmin::DeleteHost

(

string

id

)

[inline]

delete this host

Parameters:

id

host id to be deleted

void Simias::Host::HostAdmin::DeleteHostByName

(

string

Name

)

[inline]

DeleteHostByName deletes the slave entry by name.

Parameters:

Name

Slave Server's name

string Simias::Host::HostAdmin::GetConfiguration

(

)

[inline]

Get the configuration from this server.

Returns:

XML string that represents the configuration.

string Simias::Host::HostAdmin::GetDomain

(

)

[inline]

Get the domain.

Returns:

domain properties as string

string Simias::Host::HostAdmin::GetDomainOwner

(

)

[inline]

get domain owner

Returns:

domain's owner properties

void Simias::Host::HostAdmin::SetHostAddress	(	string	Host,
		string	PublicUrl,
		string	PrivateUrl
	)			[inline]

Method to set/reset public and private addresses of a host Note: The Host parameter can be represented as the Host ID or the Host name. If the Host is null local host is assumed.

Parameters:

	Host	host
	PublicAddress	public address of host
	PrivateAddress	private address of host

Returns:

N/A

bool Simias::Host::HostAdmin::SetHomeServer	(	string	userID,
		string	serverID
	)			[inline]

Set the home server.

Parameters:

	userID	userid
	server	server id

Returns:

true if successful

bool Simias::Host::HostAdmin::MigrateUser

(

string

userID

)

[inline]

currently it returns false always

Parameters:

userID

Returns:

false

bool Simias::Host::HostAdmin::ProvisionUser

(

)

[inline]

returns false

Returns:

false

string Simias::Host::HostAdmin::AddHost	(	string	name,
		string	publicAddress,
		string	privateAddress,
		string	publicKey,
		out bool	created
	)			[inline]

Add the host into domain.

Parameters:

	name	name to be added
	publicAddress	public address of host
	privateAddress	private address of host
	publicKey	public key of host

Returns:

property of new host as string

void Simias::Host::HostAdmin::DeleteHost

(

string

id

)

[inline]

delete the host from domain

Parameters:

id

id to be deleted

string Simias::Host::HostAdmin::GetConfiguration

(

)

[inline]

Get the configuration from this server.

Returns:

XML string that represents the configuration.

string Simias::Host::HostAdmin::GetDomain

(

)

[inline]

Get the local domain properties.

Returns:

domain properties as string

string Simias::Host::HostAdmin::GetDomainOwner

(

)

[inline]

get the domain owner

Returns:

owner's properties as string

---

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

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