hydra

Class ClientVmInfo

java.lang.Object

hydra.ClientVmInfo

All Implemented Interfaces:

Serializable

public class ClientVmInfo
extends Object
implements Serializable

This class provides objects used to describe client VMs. These objects are integral to the implementation of the ClientVmMgr API, which allows hydra clients to stop and start client VMs.

The info objects are used to pass in descriptions of the source VM (the one calling the stop or start method) and the target VM (the one which will be stopped or started). Information about the target VM can be specific enough to match only one VM or vague enough so that more than one VM might match (though only one will be chosen and acted upon).

Methods in the ClientVmMgr API return another info object containing full information about the selected target VM.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientVmInfo() Creates an object describing this client VM, for use with the ClientVmMgr API.
	ClientVmInfo(BridgeHelper.Endpoint endpoint) Creates an object describing a specific bridge server VM, for use with the ClientVmMgr API.
	ClientVmInfo(int vmid) Creates an object describing a client VM, for use with the ClientVmMgr API.
	ClientVmInfo(Integer vmid, String clientName, String logicalHost) Creates an object describing a client VM, for use with the ClientVmMgr API.

Method Summary

Modifier and Type	Method and Description
protected boolean	clientNameMatches(String aClientName)
String	getClientName()
String	getLogicalHost()
Integer	getVmid()
protected void	setClientName(String clientName)
protected void	setLogicalHost(String logicalHost)
protected void	setVmid(Integer vmid)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientVmInfo

protected ClientVmInfo()

Creates an object describing this client VM, for use with the ClientVmMgr API.

For internal hydra use only.

ClientVmInfo

public ClientVmInfo(int vmid)

Creates an object describing a client VM, for use with the ClientVmMgr API.

Parameters:

vmid - The unique logical id for the client VM.

Throws:

IllegalArgumentException - if the info provided does not exist.

ClientVmInfo

public ClientVmInfo(Integer vmid,
                    String clientName,
                    String logicalHost)

Creates an object describing a client VM, for use with the ClientVmMgr API.

Parameters:

vmid - The unique logical id for the client VM. Use null to allow a VM with any ID to match.

clientName - One of the values in ClientPrms.names. Use null to match any logical client name.

logicalHost - One of the values in HostPrms.names. Use null to match any logical host name.

Throws:

IllegalArgumentException - if any of info provided does not exist.

ClientVmInfo

public ClientVmInfo(BridgeHelper.Endpoint endpoint)

Creates an object describing a specific bridge server VM, for use with the ClientVmMgr API. To describe a more generic server, use ClientVmInfo(Integer,String,String).

Parameters:

endpoint - The BridgeHelper.Endpoint for the server.

Throws:

IllegalArgumentException - if the endpoint is null.

Method Detail

getVmid

public Integer getVmid()

Returns:

Unique logical id for the client VM.

setVmid

protected void setVmid(Integer vmid)

getClientName

public String getClientName()

Returns:

Logical name of the client VM from hydra.ClientPrms-names.

setClientName

protected void setClientName(String clientName)

clientNameMatches

protected boolean clientNameMatches(String aClientName)

getLogicalHost

public String getLogicalHost()

Returns:

Logical name of the client VM's host from hydra.HostPrms-names.

setLogicalHost

protected void setLogicalHost(String logicalHost)

toString

public String toString()

Overrides:

toString in class Object

Returns:

Stringified client VM information.