org.libvirt
Class Network

java.lang.Object
  org.libvirt.Network

public class Network
extends java.lang.Object

A network object defined by libvirt.

Field Summary

protected Libvirt	libvirt The libvirt connection from the hypervisor
protected Connect	virConnect The Connect Object that represents the Hypervisor of this Network

Method Summary

void	create() Creates and starts this defined network.
void	destroy() Destroy this network object.
void	finalize()
int	free() Frees this network object.
boolean	getAutostart() Provides a boolean value indicating whether this network is configured to be automatically started when the host machine boots.
java.lang.String	getBridgeName() Provides a bridge interface name to which a domain may connect a network interface in order to join this network.
Connect	getConnect() Provides the connection pointer associated with this network.
java.lang.String	getName() Gets the public name for this network
int[]	getUUID() Gets the UUID for this network
java.lang.String	getUUIDString() Gets the UUID for a network as string.
java.lang.String	getXMLDesc(int flags) Provides an XML description of this network.
int	isActive() Determine if the network is currently running
int	isPersistent() Determine if the network has a persistent configuration which means it will still exist after shutting down
protected void	processError()
void	setAutostart(boolean autostart) Configures this network to be automatically started when the host machine boots.
void	undefine() Undefines this network but does not stop it if it is running

Methods inherited from class java.lang.Object

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

Field Detail

virConnect

protected Connect virConnect

The Connect Object that represents the Hypervisor of this Network

libvirt

protected Libvirt libvirt

The libvirt connection from the hypervisor

Method Detail

create

public void create()
            throws LibvirtException

Creates and starts this defined network. If the call succeeds the network moves from the defined to the running networks pools.

Throws:

LibvirtException

destroy

public void destroy()
             throws LibvirtException

Destroy this network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The object becomes invalid and should not be used thereafter if the call does not return an error. This function may require priviledged access

Throws:

LibvirtException

finalize

public void finalize()
              throws LibvirtException

Overrides:

finalize in class java.lang.Object

Throws:

LibvirtException

free

public int free()
         throws LibvirtException

Frees this network object. The running instance is kept alive. The object becomes invalid and should not be used thereafter if the call does not return an error.

Returns:

number of references left (>= 0) for success, -1 for failure.

Throws:

LibvirtException

getAutostart

public boolean getAutostart()
                     throws LibvirtException

Provides a boolean value indicating whether this network is configured to be automatically started when the host machine boots.

Returns:

true if autostarted, false otherwise

Throws:

LibvirtException

getBridgeName

public java.lang.String getBridgeName()
                               throws LibvirtException

Provides a bridge interface name to which a domain may connect a network interface in order to join this network.

Returns:

the interface name

Throws:

LibvirtException

getConnect

public Connect getConnect()

Provides the connection pointer associated with this network.

Returns:

the Connect object

getName

public java.lang.String getName()
                         throws LibvirtException

Gets the public name for this network

Returns:

the public name

Throws:

LibvirtException

getUUID

public int[] getUUID()
              throws LibvirtException

Gets the UUID for this network

Returns:

the UUID as an unpacked int array

Throws:

LibvirtException

See Also:

rfc4122

getUUIDString

public java.lang.String getUUIDString()
                               throws LibvirtException

Gets the UUID for a network as string.

Returns:

the UUID in canonical String format

Throws:

LibvirtException

See Also:

rfc4122

getXMLDesc

public java.lang.String getXMLDesc(int flags)
                            throws LibvirtException

Provides an XML description of this network. The description may be reused later to relaunch the network with Virconnect.virNetworkCreateXML().

Parameters:

flags - and OR'ed set of extraction flags, not used yet

Returns:

The XML representation of this network

Throws:

LibvirtException

isActive

public int isActive()
             throws LibvirtException

Determine if the network is currently running

Returns:

1 if running, 0 if inactive, -1 on error

Throws:

LibvirtException

See Also:

Libvirt Documentation

isPersistent

public int isPersistent()
                 throws LibvirtException

Determine if the network has a persistent configuration which means it will still exist after shutting down

Returns:

1 if persistent, 0 if transient, -1 on error

Throws:

LibvirtException

See Also:

Libvirt Documentation

processError

protected void processError()
                     throws LibvirtException

Throws:

LibvirtException

setAutostart

public void setAutostart(boolean autostart)
                  throws LibvirtException

Configures this network to be automatically started when the host machine boots.

Parameters:

autostart - whether the network should be automatically started 0 or 1

Throws:

LibvirtException

undefine

public void undefine()
              throws LibvirtException

Undefines this network but does not stop it if it is running

Throws:

LibvirtException