com.abiquo.api.access.LocalAccess Class Reference

Client mode access creates a new framework entity instance and uses its communication and model. More...

Inherits IGridAccess.

List of all members.

Public Member Functions
	LocalAccess (FrameworkConfiguration inConfiguration) throws UpdateModelException
	The local access class constructor.
Communication	getCommunication ()
	Gets the communication (layer) take from the framework.
FrameworkConfiguration	getConfiguration ()
	Returns the configuration used to access and construct the framework.
AccessMode	getConnectionMode ()
	Returns the type of access implemented.
GSSCredential	getCredential ()
	Returns the credential used to access and construct the secured framework.
IFileSystemService	getFileSystemService ()
	Returns the default file system implementation.
IGridModel	getModel ()
	Gets the IGridModel implementation taken from the framework.
ISecurityModel	getSecurityModel ()
	Returns the ISecurityModel implementation taken from the framework.
ITransaction	send (IXMLMessage messageRequest)
	Sends a request message using DispachCommunication to on memory Framework entity.
void	setCredential (GSSCredential inCredential)
	Changes the credential used on both access and framework communication.
void	terminate () throws FrameworkException
	Shuts down the framework instance.

---

Detailed Description

Client mode access creates a new framework entity instance and uses its communication and model.

If no other framework is present on configuration file, it is the default access.

---

Constructor & Destructor Documentation

com.abiquo.api.access.LocalAccess.LocalAccess

(

FrameworkConfiguration

inConfiguration

)

throws UpdateModelException

The local access class constructor.

It creates a new framework entity and waits until its update model process ends.

Parameters:

inConfiguration

the configuration used to instantiate the new instance

Exceptions:

UpdateModelException,if

the constructed framework can not reach any node

---

Member Function Documentation

Communication com.abiquo.api.access.LocalAccess.getCommunication

(

)

Gets the communication (layer) take from the framework.

Returns:

the framework communication shared by this access

FrameworkConfiguration com.abiquo.api.access.LocalAccess.getConfiguration

(

)

Returns the configuration used to access and construct the framework.

Returns:

the configuration

AccessMode com.abiquo.api.access.LocalAccess.getConnectionMode

(

)

Returns the type of access implemented.

Returns:

LocalAccess

GSSCredential com.abiquo.api.access.LocalAccess.getCredential

(

)

Returns the credential used to access and construct the secured framework.

Returns:

the user credential for secure communication layer (access and framework share it)

IFileSystemService com.abiquo.api.access.LocalAccess.getFileSystemService

(

)

Returns the default file system implementation.

Returns:

the file system service used on this access

IGridModel com.abiquo.api.access.LocalAccess.getModel

(

)

Gets the IGridModel implementation taken from the framework.

Returns:

the framework model used on this access

ISecurityModel com.abiquo.api.access.LocalAccess.getSecurityModel

(

)

Returns the ISecurityModel implementation taken from the framework.

Returns:

the ISecurityModel implementation where ask for users/credentials used on this access

ITransaction com.abiquo.api.access.LocalAccess.send

(

IXMLMessage

messageRequest

)

Sends a request message using DispachCommunication to on memory Framework entity.

Parameters:

messageRequest

the request message starting the transaction

Returns:

the transaction interface to achieve the communication

void com.abiquo.api.access.LocalAccess.setCredential

(

GSSCredential

inCredential

)

Changes the credential used on both access and framework communication.

Parameters:

inCredential

the new user credential for secure communication

void com.abiquo.api.access.LocalAccess.terminate

(

)

throws FrameworkException

Shuts down the framework instance.

Exceptions:

FrameworkException

the general exception

---

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

• src/com/abiquo/api/access/LocalAccess.java