summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/openslx/libvirt/domain/device/ControllerUsb.java
blob: 179802780bd58d2ec2d791bea43d7680a48e5a5e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
package org.openslx.libvirt.domain.device;

import org.openslx.libvirt.xml.LibvirtXmlNode;

/**
 * A USB controller device node in a Libvirt domain XML document.
 * 
 * @author Manuel Bentele
 * @version 1.0
 */
public class ControllerUsb extends Controller
{
	/**
	 * Creates an empty USB controller device.
	 */
	public ControllerUsb()
	{
		super();
	}

	/**
	 * Creates an USB controller device representing an existing Libvirt XML USB controller device
	 * element.
	 * 
	 * @param xmlNode existing Libvirt XML USB controller device element.
	 */
	public ControllerUsb( LibvirtXmlNode xmlNode )
	{
		super( xmlNode );
	}

	/**
	 * Returns hardware model of the PCI controller.
	 * 
	 * @return hardware model of the PCI controller.
	 */
	public Model getModel()
	{
		String model = this.getXmlElementAttributeValue( "model" );
		return Model.fromString( model );
	}

	/**
	 * Sets hardware model for the PCI controller.
	 * 
	 * @param model hardware model for the PCI controller.
	 */
	public void setModel( Model model )
	{
		this.setXmlElementAttributeValue( "model", model.toString() );
	}

	/**
	 * Creates a non-existent USB controller device as Libvirt XML device element.
	 * 
	 * @param xmlNode Libvirt XML node of the Libvirt XML device that is created.
	 * @return created USB controller device instance.
	 */
	public static ControllerUsb createInstance( LibvirtXmlNode xmlNode )
	{
		return ControllerUsb.newInstance( xmlNode );
	}

	/**
	 * Creates an USB controller device representing an existing Libvirt XML USB controller device
	 * element.
	 * 
	 * @param xmlNode existing Libvirt XML USB controller device element.
	 * @return USB controller device instance.
	 */
	public static ControllerUsb newInstance( LibvirtXmlNode xmlNode )
	{
		return new ControllerUsb( xmlNode );
	}

	/**
	 * Model of PCI controller device.
	 * 
	 * @author Manuel Bentele
	 * @version 1.0
	 */
	public enum Model
	{
		// @formatter:off
		NONE          ( "none" ),
		PIIX3_UHCI    ( "piix3-uhci" ),
		PIIX4_UHCI    ( "piix4-uhci" ),
		EHCI          ( "ehci" ),
		ICH9_EHCI1    ( "ich9-ehci1" ),
		ICH9_UHCI1    ( "ich9-uhci1" ),
		ICH9_UHCI2    ( "ich9-uhci2" ),
		ICH9_UHCI3    ( "ich9-uhci3" ),
		VT82C686B_UHCI( "vt82c686b-uhci" ),
		PCI_OHCI      ( "pci-ohci" ),
		NEC_XHCI      ( "nec-xhci" ),
		QUSB1         ( "qusb1" ),
		QUSB2         ( "qusb2" ),
		QEMU_XHCI     ( "qemu-xhci" );
		// @formatter:on

		/**
		 * Name of the USB controller device model.
		 */
		private String model = null;

		/**
		 * Creates USB controller device model.
		 * 
		 * @param type valid name of the USB controller device model in a Libvirt domain XML document.
		 */
		Model( String model )
		{
			this.model = model;
		}

		@Override
		public String toString()
		{
			return this.model;
		}

		/**
		 * Creates USB controller device model from its name with error check.
		 * 
		 * @param model name of the USB controller device model in a Libvirt domain XML document.
		 * @return valid USB controller device model.
		 */
		public static Model fromString( String model )
		{
			for ( Model t : Model.values() ) {
				if ( t.model.equalsIgnoreCase( model ) ) {
					return t;
				}
			}

			return null;
		}
	}
}