com.abiquo.api.resources.PingResource Class Reference

This class represents a PingResource, and works as a simple echo service (for a question, an echo response). More...

Inherits ResourceInstance.

List of all members.

Public Member Functions
	PingResource ()
	Creates a new PingResource with the default values.
	PingResource (ResourceInstance resourceInstance)
	Creates a new PingResource based on a generic ResourceInstance.
	PingResource (String localId, InstanceName name, List< Property > propertyList)
	Creates a new PingResource based on the parameters.
Job	doEcho (String message)
	Creates a new Job which once executed, sends a simply echo message to a remote middleware.
Static Public Member Functions
static PingResource	cast (ResourceInstance resourceInstance)
	Converts a generic ResourceInstance into a new one of type PingResource.
Static Public Attributes
static final String	ID = "Ping"
	String containing the identifier for this resource.

---

Detailed Description

This class represents a PingResource, and works as a simple echo service (for a question, an echo response).

---

Constructor & Destructor Documentation

com.abiquo.api.resources.PingResource.PingResource

(

ResourceInstance

resourceInstance

)

Creates a new PingResource based on a generic ResourceInstance.

Parameters:

resourceInstance

The generic ResourceInstance

com.abiquo.api.resources.PingResource.PingResource	(	String	localId,
		InstanceName	name,
		List< Property >	propertyList
	)

Creates a new PingResource based on the parameters.

Parameters:

	localId	the local id
	name	the instance name
	propertyList	the property list

---

Member Function Documentation

static PingResource com.abiquo.api.resources.PingResource.cast

(

ResourceInstance

resourceInstance

)

[static]

Converts a generic ResourceInstance into a new one of type PingResource.

Parameters:

resourceInstance

The generic ResourceInstance

Returns:

The resultant PingResource

Job com.abiquo.api.resources.PingResource.doEcho

(

String

message

)

Creates a new Job which once executed, sends a simply echo message to a remote middleware.

Parameters:

message

The string to send

Returns:

The Job to perform the demand

---

Member Data Documentation

final String com.abiquo.api.resources.PingResource.ID = "Ping" [static]

String containing the identifier for this resource.

Note:

To avoid misspellings when provision a resource, you should use this constant ID instead of a manually typed string.

---

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

• src/com/abiquo/api/resources/PingResource.java