com.abiquo.api.access.RemoteAccess Class Reference

Client mode access using a new communication layer to contact a remote framework instance. More...

Inherits IGridAccess.

List of all members.

Public Member Functions
	RemoteAccess (FrameworkConfiguration configuration) throws NoDefaultRemoteFwException
	The remote access class constructor.
Communication	getCommunication ()
	Returns a communication layer pointing to framework remote entity to send messages to it.
FrameworkConfiguration	getConfiguration ()
	Gets the configuration used to access the framework.
AccessMode	getConnectionMode ()
	Returns on which mode are accessing the grid.
GSSCredential	getCredential ()
	Gets the credential used for the client access the framework.
IFileSystemService	getFileSystemService ()
	Returns the default file system implementation to thread data files.
IGridModel	getModel ()
	Gets the IGridModel implementation used on this access.
ISecurityModel	getSecurityModel ()
	Return the ISecurityModel used on this access.
ITransaction	send (IXMLMessage messageRequest) throws CommunicationException
	Sends a message using communication gateway to default framework gateway.
void	setCredential (GSSCredential credential)
	Changes the credential used to access the framework.
void	terminate () throws FrameworkException
	Terminates the framework instance.

---

Detailed Description

Client mode access using a new communication layer to contact a remote framework instance.

The communication layer will be secured depending on the boolean flag "secured" of the framework configuration. By default a secured communication is configured with the default credential, to use an specific credential the method setCredential should be used

---

Constructor & Destructor Documentation

com.abiquo.api.access.RemoteAccess.RemoteAccess

(

FrameworkConfiguration

configuration

)

throws NoDefaultRemoteFwException

The remote access class constructor.

Configure an access to reach a remote framework instance.

Parameters:

configuration

the configuration, where the default framework is read from "FQDN" attribute

Exceptions:

NoDefaultRemoteFwException

can not establish the client-framework communication

---

Member Function Documentation

Communication com.abiquo.api.access.RemoteAccess.getCommunication

(

)

Returns a communication layer pointing to framework remote entity to send messages to it.

Returns:

the communication used on this access

FrameworkConfiguration com.abiquo.api.access.RemoteAccess.getConfiguration

(

)

Gets the configuration used to access the framework.

Returns:

the framework configuration

AccessMode com.abiquo.api.access.RemoteAccess.getConnectionMode

(

)

Returns on which mode are accessing the grid.

Returns:

RemoteAccess

GSSCredential com.abiquo.api.access.RemoteAccess.getCredential

(

)

Gets the credential used for the client access the framework.

Returns:

the credential used on access

IFileSystemService com.abiquo.api.access.RemoteAccess.getFileSystemService

(

)

Returns the default file system implementation to thread data files.

Returns:

the file system service used on this access

IGridModel com.abiquo.api.access.RemoteAccess.getModel

(

)

Gets the IGridModel implementation used on this access.

Returns:

QueryModel (based on remote query transactions)

ISecurityModel com.abiquo.api.access.RemoteAccess.getSecurityModel

(

)

Return the ISecurityModel used on this access.

Returns:

the ISecurityModel implementation where ask for users/credentials

ITransaction com.abiquo.api.access.RemoteAccess.send

(

IXMLMessage

messageRequest

)

throws CommunicationException

Sends a message using communication gateway to default framework gateway.

Parameters:

messageRequest

the message Request starting the communication

Exceptions:

CommunicationException

if the message transaction do not success

void com.abiquo.api.access.RemoteAccess.setCredential

(

GSSCredential

credential

)

Changes the credential used to access the framework.

Cause communication layer to use a secure implementation.

Parameters:

credential

the new user credential for the secure communication

---

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

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