com.abiquo.Grid Class Reference

Client entry point to the grid. More...

List of all members.

Public Member Functions
IGridAccess	getAccess ()
	Get the access used on this Grid.
	Grid (IGridAccess gridAccess, FrameworkConfiguration gridConfig)
	Creates a new grid instance form the given configuration using the incoming access.
	Grid (Framework frame)
	Crate an access from a given framework.
	Grid (FrameworkConfiguration inConfiguration) throws FrameworkException
	Creates a new grid instance from the given configuration.
	Grid (FrameworkConfiguration inConfiguration, GSSCredential cred) throws FrameworkException, GSSException
	Creates a new secured instance of the Grid class.
ResourceInstance	deployService (IService resJava) throws ProvisionException
List< ResourceInstance >	forceProvisionResources (String resourceName, int numReso) throws ProvisionException
ResourceInstance	forceProvisionResource (String resourceName, String nodeName) throws ProvisionException
	Require a new instance of resource resourceName on node nodeName.
List< ResourceInstance >	forceProvisionResourcesOnAllNodes (String resourceName) throws ProvisionException
synchronized Communication	getCommunication ()
	Returns the Communication layer used by the grid access.
FrameworkConfiguration	getFrameworkConfiguration ()
	Returns the used configuration on this Grid.
IFileSystemService	getFSService ()
	Returns a default file system service implementation to use on file transmission.
IGridModel	getModel ()
	Returns the model to knowledge queries.
ResourceInstance	getResource (String resourceName) throws NoEnoughResourcesException
ResourceInstance	getResource (String resourceName, String nodeName) throws ProvisionException
List< ResourceInstance >	getResources (String resourceName, int numReso) throws NoEnoughResourcesException, FrameworkException
Iterator< ResourceInstance >	getResourceSequence (String resourceName)
Grid	getSecured (GSSCredential credential) throws GSSException
	Changes the access to allow secure communications.
ISecurityModel	getSecurityModel ()
	Returns a model to know which Users and Policies are used.
void	terminate () throws FrameworkException
	Stops immediately the framework execution associated to this grid instance.

---

Detailed Description

Client entry point to the grid.

It references to a FW instance. It exposes all functionalities a framework allow to use on a service. It allows writing API services through the features exposed. - Resource selection (Resolution): getResources. - Queries on the model: getAllNodes.

---

Constructor & Destructor Documentation

com.abiquo.Grid.Grid	(	IGridAccess	gridAccess,
		FrameworkConfiguration	gridConfig
	)

Creates a new grid instance form the given configuration using the incoming access.

Parameters:

	gridAccess,the	access used to contact the framework instance
	gridConfig,the	configuration used to create a framework instance on local access

com.abiquo.Grid.Grid

(

Framework

frame

)

Crate an access from a given framework.

Used on service (Service) deploy Using an FrameworkAccess

Parameters:

frame

existing framework instance

com.abiquo.Grid.Grid

(

FrameworkConfiguration

inConfiguration

)

throws FrameworkException

Creates a new grid instance from the given configuration.

Parameters:

inConfiguration

configuration used to determine witch access to use (or new fw instance creation)

Exceptions:

FrameworkException

if configuration is invalid or some error on framework instantiation on local access

com.abiquo.Grid.Grid	(	FrameworkConfiguration	inConfiguration,
		GSSCredential	cred
	)			throws FrameworkException, GSSException

Creates a new secured instance of the Grid class.

Parameters:

	inConfiguration	configuration used to determine witch access to use (or new fw instance creation)
	cred	user credential to secure communications

Exceptions:

	FrameworkException	if configuration is invalid or some error on framework instantiation on local access
	GSSException	if the credential is invalid

---

Member Function Documentation

IGridAccess com.abiquo.Grid.getAccess

(

)

Get the access used on this Grid.

Returns:

the access used on this Grid to contact the framework instance

ResourceInstance com.abiquo.Grid.deployService

(

IService

resJava

)

throws ProvisionException

See also:

com.abiquo.GridResourceProvider.deployService

List<ResourceInstance> com.abiquo.Grid.forceProvisionResources	(	String	resourceName,
		int	numReso
	)			throws ProvisionException

See also:

com.abiquo.GridResourceProvider.forceProvisionResources

ResourceInstance com.abiquo.Grid.forceProvisionResource	(	String	resourceName,
		String	nodeName
	)			throws ProvisionException

Require a new instance of resource resourceName on node nodeName.

Parameters:

	resourceName	is the resource type (abstract name of the resource instance)
	nodeName	the desired node (FQDN, alias or nodeName session)

Exceptions:

ProvisionException

if there aren't any resource to book or there are too many instances of this resource

Returns:

the resource instance binding object to use this resource

List<ResourceInstance> com.abiquo.Grid.forceProvisionResourcesOnAllNodes

(

String

resourceName

)

throws ProvisionException

See also:

com.abiquo.GridResourceProvider.forceProvisionResourcesOnAllNodes

synchronized Communication com.abiquo.Grid.getCommunication

(

)

Returns the Communication layer used by the grid access.

It can be the same communication layer than the Framework if it's in local mode access or a new communication (on remote access)

Returns:

the communication layer on grid access

Deprecated:

MUST use send though access

FrameworkConfiguration com.abiquo.Grid.getFrameworkConfiguration

(

)

Returns the used configuration on this Grid.

Returns:

the configuration (on local access it is the framework configuration)

IFileSystemService com.abiquo.Grid.getFSService

(

)

Returns a default file system service implementation to use on file transmission.

Deprecated:

SHOULD use FSSBinding and compose its jobs like other resource (use the deployed service)

IGridModel com.abiquo.Grid.getModel

(

)

Returns the model to knowledge queries.

Returns:

a model interface implementation: on RemoteAccess use QueryModel and for Local share framework model

ResourceInstance com.abiquo.Grid.getResource

(

String

resourceName

)

throws NoEnoughResourcesException

See also:

com.abiquo.GridResourceProvider.getResource

ResourceInstance com.abiquo.Grid.getResource	(	String	resourceName,
		String	nodeName
	)			throws ProvisionException

See also:

com.abiquo.GridResourceProvider.getResource

Todo:

see go to getResources correct paramaters

List<ResourceInstance> com.abiquo.Grid.getResources	(	String	resourceName,
		int	numReso
	)			throws NoEnoughResourcesException, FrameworkException

See also:

com.abiquo.GridResourceProvider.getResource

Todo:

see go to getResources correct paramaters

Iterator<ResourceInstance> com.abiquo.Grid.getResourceSequence

(

String

resourceName

)

See also:

com.abiquo.GridResourceProvider.getResourceSequence

Grid com.abiquo.Grid.getSecured

(

GSSCredential

credential

)

throws GSSException

Changes the access to allow secure communications.

Parameters:

credential

the user credential used on secure communication

Returns:

the same Grid configured with the specified credential

Exceptions:

GSSException

it he credential is invalid

ISecurityModel com.abiquo.Grid.getSecurityModel

(

)

Returns a model to know which Users and Policies are used.

Returns:

an implementation of the security model interface

void com.abiquo.Grid.terminate

(

)

throws FrameworkException

Stops immediately the framework execution associated to this grid instance.

Useful to destroy the framework instance created by the local access (configuartion.getFqdn == local)

Exceptions:

FrameworkException

if it is not on LocalAccess mode

---

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

• src/com/abiquo/Grid.java