Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.infrastructure

Class VirtualServer

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,VirtualServer>

com.aoindustries.aoserv.client.CachedObject<Integer,VirtualServer>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<VirtualServer>

com.aoindustries.aoserv.client.infrastructure.VirtualServer

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, SingleTableObject<Integer,VirtualServer>

public final class VirtualServer
extends CachedObjectIntegerKey<VirtualServer>

A VirtualServer consumes physical resources within the virtualization layer.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BLOCKED	The possible state flags for the virtual server.
static final int	CRASHED	The possible state flags for the virtual server.
static final int	DESTROYED	The possible state flags for the virtual server.
static final int	DYING	The possible state flags for the virtual server.
static final int	PAUSED	The possible state flags for the virtual server.
static final int	RUNNING	The possible state flags for the virtual server.
static final int	SHUTDOWN	The possible state flags for the virtual server.

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
VirtualServer()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
String	create()	Calls "xm create" on the current primary physical server.
String	destroy()	Calls "xm destroy" on the current primary physical server.
protected Object	getColumnImpl(int i)
Host	getHost()
Architecture	getMinimumProcessorArchitecture()	Gets the minimum processor architecture.
int	getMinimumProcessorSpeed()	Gets the minimum processor speed or -1 for none.
int	getMinimumProcessorSpeedTarget()	Gets the minimum processor speed target or -1 for none.
ProcessorType	getMinimumProcessorType()	Gets the minimum processor type or null if none.
PhysicalServer	getPrimaryPhysicalServer()	Gets the physical server that is currently the primary node for this virtual server.
int	getPrimaryRam()
int	getPrimaryRamTarget()
short	getProcessorCores()	Gets the processor cores.
short	getProcessorCoresTarget()
short	getProcessorWeight()	Gets the processor weight.
short	getProcessorWeightTarget()
boolean	getRequiresHvm()	Gets if this virtual requires full hardware virtualization support.
PhysicalServer	getSecondaryPhysicalServer()	Gets the physical server that is currently the secondary node for this virtual server.
int	getSecondaryRam()	Gets the secondary RAM allocation or -1 if no secondary required.
int	getSecondaryRamTarget()
int	getStatus()	Calls "xm list" to get the current state on the current primary physical server.
static String	getStatusList(int status)	Gets a human readable, but constant and not translated, comma-separated list of current status flags.
Table.TableId	getTableId()
VirtualDisk	getVirtualDisk(String device)	Gets the virtual disk for this virtual server and the provided device name.
List<VirtualDisk>	getVirtualDisks()
String	getVncPassword()	Gets the VNC password for this virtual server or null if VNC is disabled.
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isPrimaryPhysicalServerLocked()	Gets if the primary server is locked (manually set).
boolean	isSecondaryPhysicalServerLocked()	Gets if the secondary server is locked (manually set).
String	pause()	Calls "xm pause" on the current primary physical server.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
String	reboot()	Calls "xm reboot" on the current primary physical server.
Server.DaemonAccess	requestVncConsoleAccess()
String	shutdown()	Calls "xm shutdown" on the current primary physical server.
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
String	unpause()	Calls "xm unpause" on the current primary physical server.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

RUNNING

public static final int RUNNING

The possible state flags for the virtual server. At least one of these flags will be enable in the result. Any number of them may be present concurrently, as returned by "xm list".

See Also:

• Constant Field Values

BLOCKED

public static final int BLOCKED

The possible state flags for the virtual server. At least one of these flags will be enable in the result. Any number of them may be present concurrently, as returned by "xm list".

See Also:

• Constant Field Values

PAUSED

public static final int PAUSED

The possible state flags for the virtual server. At least one of these flags will be enable in the result. Any number of them may be present concurrently, as returned by "xm list".

See Also:

• Constant Field Values

SHUTDOWN

public static final int SHUTDOWN

The possible state flags for the virtual server. At least one of these flags will be enable in the result. Any number of them may be present concurrently, as returned by "xm list".

See Also:

• Constant Field Values

CRASHED

public static final int CRASHED

The possible state flags for the virtual server. At least one of these flags will be enable in the result. Any number of them may be present concurrently, as returned by "xm list".

See Also:

• Constant Field Values

DYING

public static final int DYING

The possible state flags for the virtual server. At least one of these flags will be enable in the result. Any number of them may be present concurrently, as returned by "xm list".

See Also:

• Constant Field Values

DESTROYED

public static final int DESTROYED

The possible state flags for the virtual server. At least one of these flags will be enable in the result. Any number of them may be present concurrently, as returned by "xm list".

See Also:

• Constant Field Values

Constructor Details

VirtualServer

@Deprecated
public VirtualServer()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,VirtualServer>

getHost

public Host getHost()
             throws SQLException,
IOException

Throws:

SQLException

IOException

getPrimaryRam

public int getPrimaryRam()

getPrimaryRamTarget

public int getPrimaryRamTarget()

getSecondaryRam

public int getSecondaryRam()

Gets the secondary RAM allocation or -1 if no secondary required. When RAM allocation is -1, the VM will not be able to run on the secondary server - it only provides block device replication. Therefore, other things like processor type, speed, architecture, processor cores and processor weights will also not be allocated.

getSecondaryRamTarget

public int getSecondaryRamTarget()

getMinimumProcessorType

public ProcessorType getMinimumProcessorType()
                                      throws IOException,
SQLException

Gets the minimum processor type or null if none.

Throws:

IOException

SQLException

getMinimumProcessorArchitecture

public Architecture getMinimumProcessorArchitecture()
                                             throws IOException,
SQLException

Gets the minimum processor architecture.

Throws:

IOException

SQLException

getMinimumProcessorSpeed

public int getMinimumProcessorSpeed()

Gets the minimum processor speed or -1 for none.

getMinimumProcessorSpeedTarget

public int getMinimumProcessorSpeedTarget()

Gets the minimum processor speed target or -1 for none.

getProcessorCores

public short getProcessorCores()

Gets the processor cores.

getProcessorCoresTarget

public short getProcessorCoresTarget()

getProcessorWeight

public short getProcessorWeight()

Gets the processor weight.

getProcessorWeightTarget

public short getProcessorWeightTarget()

isPrimaryPhysicalServerLocked

public boolean isPrimaryPhysicalServerLocked()

Gets if the primary server is locked (manually set).

isSecondaryPhysicalServerLocked

public boolean isSecondaryPhysicalServerLocked()

Gets if the secondary server is locked (manually set).

getRequiresHvm

public boolean getRequiresHvm()

Gets if this virtual requires full hardware virtualization support.

getVncPassword

public String getVncPassword()

Gets the VNC password for this virtual server or null if VNC is disabled. The password must be unique between virtual servers because the password is used behind the scenes to resolve the actual IP and port for VNC proxying.

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,VirtualServer>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,VirtualServer>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,VirtualServer>

Throws:

IOException

toStringImpl

public String toStringImpl()
                    throws SQLException,
IOException

Description copied from class: AoservObject

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<VirtualServer>

Throws:

SQLException

IOException

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,VirtualServer>

Throws:

IOException

getVirtualDisks

public List<VirtualDisk> getVirtualDisks()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getVirtualDisk

public VirtualDisk getVirtualDisk(String device)
                           throws IOException,
SQLException

Gets the virtual disk for this virtual server and the provided device name.

Parameters:

device - should be xvd[a-z]

Returns:

the disk or null if not found

Throws:

IOException

SQLException

requestVncConsoleAccess

public Server.DaemonAccess requestVncConsoleAccess()
                                            throws IOException,
SQLException

Throws:

IOException

SQLException

create

public String create()
              throws IOException,
SQLException

Calls "xm create" on the current primary physical server.

Returns:

the output of the command.

Throws:

IOException - any non-zero exit code will result in an exception with the standard error in the exception message.

SQLException

reboot

public String reboot()
              throws IOException,
SQLException

Calls "xm reboot" on the current primary physical server.

Returns:

the output of the command.

Throws:

IOException - any non-zero exit code will result in an exception with the standard error in the exception message.

SQLException

shutdown

public String shutdown()
                throws IOException,
SQLException

Calls "xm shutdown" on the current primary physical server.

Returns:

the output of the command.

Throws:

IOException - any non-zero exit code will result in an exception with the standard error in the exception message.

SQLException

destroy

public String destroy()
               throws IOException,
SQLException

Calls "xm destroy" on the current primary physical server.

Returns:

the output of the command.

Throws:

IOException - any non-zero exit code will result in an exception with the standard error in the exception message.

SQLException

pause

public String pause()
             throws IOException,
SQLException

Calls "xm pause" on the current primary physical server.

Returns:

the output of the command.

Throws:

IOException - any non-zero exit code will result in an exception with the standard error in the exception message.

SQLException

unpause

public String unpause()
               throws IOException,
SQLException

Calls "xm unpause" on the current primary physical server.

Returns:

the output of the command.

Throws:

IOException - any non-zero exit code will result in an exception with the standard error in the exception message.

SQLException

getStatusList

public static String getStatusList(int status)

Gets a human readable, but constant and not translated, comma-separated list of current status flags.

getStatus

public int getStatus()
              throws IOException,
SQLException

Calls "xm list" to get the current state on the current primary physical server.

Returns:

the OR of all state bits.

Throws:

IOException - any non-zero exit code will result in an exception with the standard error in the exception message.

SQLException

getPrimaryPhysicalServer

public PhysicalServer getPrimaryPhysicalServer()
                                        throws IOException,
SQLException

Gets the physical server that is currently the primary node for this virtual server.

Throws:

IOException

SQLException

getSecondaryPhysicalServer

public PhysicalServer getSecondaryPhysicalServer()
                                          throws IOException,
SQLException

Gets the physical server that is currently the secondary node for this virtual server.

Throws:

IOException

SQLException