summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/openslx/libvirt/domain/Domain.java
blob: 2925ef1d8f39534aa2635fab3e8c3249e92292db (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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
package org.openslx.libvirt.domain;

import java.io.File;
import java.io.InputStream;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Collectors;

import org.openslx.libvirt.domain.device.Device;
import org.openslx.libvirt.domain.device.Controller;
import org.openslx.libvirt.domain.device.ControllerFloppy;
import org.openslx.libvirt.domain.device.ControllerIde;
import org.openslx.libvirt.domain.device.ControllerPci;
import org.openslx.libvirt.domain.device.ControllerSata;
import org.openslx.libvirt.domain.device.ControllerScsi;
import org.openslx.libvirt.domain.device.ControllerUsb;
import org.openslx.libvirt.domain.device.Disk;
import org.openslx.libvirt.domain.device.DiskCdrom;
import org.openslx.libvirt.domain.device.DiskFloppy;
import org.openslx.libvirt.domain.device.DiskStorage;
import org.openslx.libvirt.domain.device.FileSystem;
import org.openslx.libvirt.domain.device.Graphics;
import org.openslx.libvirt.domain.device.GraphicsSpice;
import org.openslx.libvirt.domain.device.GraphicsVnc;
import org.openslx.libvirt.domain.device.Hostdev;
import org.openslx.libvirt.domain.device.HostdevPci;
import org.openslx.libvirt.domain.device.HostdevUsb;
import org.openslx.libvirt.domain.device.Interface;
import org.openslx.libvirt.domain.device.InterfaceBridge;
import org.openslx.libvirt.domain.device.InterfaceNetwork;
import org.openslx.libvirt.domain.device.Parallel;
import org.openslx.libvirt.domain.device.Serial;
import org.openslx.libvirt.domain.device.Shmem;
import org.openslx.libvirt.domain.device.Sound;
import org.openslx.libvirt.domain.device.Video;
import org.openslx.libvirt.xml.LibvirtXmlDocument;
import org.openslx.libvirt.xml.LibvirtXmlDocumentException;
import org.openslx.libvirt.xml.LibvirtXmlNode;
import org.openslx.libvirt.xml.LibvirtXmlResources;
import org.openslx.libvirt.xml.LibvirtXmlSerializationException;
import org.openslx.libvirt.xml.LibvirtXmlValidationException;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;

/**
 * Implementation of the Libvirt domain XML document.
 * 
 * The Libvirt domain XML document is used to describe virtual machines and their configurations.
 * 
 * @author Manuel Bentele
 * @version 1.0
 */
public class Domain extends LibvirtXmlDocument
{
	/**
	 * Creates Libvirt domain XML document from {@link String} providing Libvirt domain XML content.
	 * 
	 * @param xml {@link String} with Libvirt domain XML content.
	 * 
	 * @throws LibvirtXmlDocumentException creation of XML context failed.
	 * @throws LibvirtXmlSerializationException serialization of the domain XML content failed.
	 * @throws LibvirtXmlValidationException XML content is not a valid domain XML document.
	 */
	public Domain( String xml )
			throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException
	{
		super( xml, LibvirtXmlResources.getLibvirtRng( "domain.rng" ) );
	}

	/**
	 * Creates Libvirt domain XML document from {@link File} containing Libvirt domain XML content.
	 * 
	 * @param xml existing {@link File} containing Libvirt domain XML content.
	 * 
	 * @throws LibvirtXmlDocumentException creation of XML context failed.
	 * @throws LibvirtXmlSerializationException serialization of the domain XML content failed.
	 * @throws LibvirtXmlValidationException XML content is not a valid domain XML document.
	 */
	public Domain( File xml )
			throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException
	{
		super( xml, LibvirtXmlResources.getLibvirtRng( "domain.rng" ) );
	}

	/**
	 * Creates Libvirt domain XML document from {@link InputStream} providing Libvirt domain XML
	 * content.
	 * 
	 * @param xml {@link InputStream} providing Libvirt domain XML content.
	 * 
	 * @throws LibvirtXmlDocumentException creation of XML context failed.
	 * @throws LibvirtXmlSerializationException serialization of the domain XML content failed.
	 * @throws LibvirtXmlValidationException XML content is not a valid domain XML document.
	 */
	public Domain( InputStream xml )
			throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException
	{
		super( xml, LibvirtXmlResources.getLibvirtRng( "domain.rng" ) );
	}

	/**
	 * Creates Libvirt domain XML document from {@link InputSource} providing Libvirt domain XML
	 * content.
	 * 
	 * @param xml {@link InputSource} providing Libvirt domain XML content.
	 * 
	 * @throws LibvirtXmlDocumentException creation of XML context failed.
	 * @throws LibvirtXmlSerializationException serialization of the domain XML content failed.
	 * @throws LibvirtXmlValidationException XML content is not a valid domain XML document.
	 */
	public Domain( InputSource xml )
			throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException
	{
		super( xml, LibvirtXmlResources.getLibvirtRng( "domain.rng" ) );
	}

	/**
	 * Types of hypervisors specifiable for a virtual machine in the Libvirt domain XML document.
	 * 
	 * @author Manuel Bentele
	 * @version 1.0
	 */
	public enum Type
	{
		// @formatter:off
		QEMU  ( "qemu" ),
		KQEMU ( "kqemu" ),
		KVM   ( "kvm" ),
		XEN   ( "xen" ),
		LXC   ( "lxc" ),
		UML   ( "uml" ),
		OPENVZ( "openvz" ),
		TEST  ( "test" ),
		VMWARE( "vmware" ),
		HYPERV( "hyperv" ),
		VBOX  ( "vbox" ),
		PHYP  ( "phyp" ),
		VZ    ( "vz" ),
		BHYVE ( "bhyve" );
		// @formatter:on

		/**
		 * Name of the hypervisor in a Libvirt domain XML document.
		 */
		private String type;

		/**
		 * Creates a hypervisor type.
		 * 
		 * @param type valid name of the hypervisor in a Libvirt domain XML document.
		 */
		Type( String type )
		{
			this.type = type;
		}

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

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

			return null;
		}
	}

	/**
	 * Returns hypervisor type defined in the Libvirt domain XML document.
	 * 
	 * @return hypervisor type.
	 */
	public Type getType()
	{
		String typeValue = this.getRootXmlNode().getXmlElementAttributeValue( null, "type" );
		return Type.fromString( typeValue );
	}

	/**
	 * Sets hypervisor type in Libvirt domain XML document.
	 * 
	 * @param type hypervisor type for Libvirt domain XML document.
	 */
	public void setType( Type type )
	{
		this.getRootXmlNode().setXmlElementAttributeValue( null, "type", type.toString() );
	}

	/**
	 * Returns virtual machine name defined in the Libvirt domain XML document.
	 * 
	 * @return name of the virtual machine.
	 */
	public String getName()
	{
		return this.getRootXmlNode().getXmlElementValue( "name" );
	}

	/**
	 * Sets virtual machine name in the Libvirt domain XML document.
	 * 
	 * @param name virtual machine name for Libvirt domain XML document.
	 */
	public void setName( String name )
	{
		this.getRootXmlNode().setXmlElementValue( "name", name );
	}

	/**
	 * Returns virtual machine title defined in the Libvirt domain XML document.
	 * 
	 * @return title of the virtual machine.
	 */
	public String getTitle()
	{
		return this.getRootXmlNode().getXmlElementValue( "title" );
	}

	/**
	 * Sets virtual machine title in the Libvirt domain XML document.
	 * 
	 * @param title virtual machine title for Libvirt domain XML document.
	 */
	public void setTitle( String title )
	{
		this.getRootXmlNode().setXmlElementValue( "title", title );
	}

	/**
	 * Returns virtual machine description defined in the Libvirt domain XML document.
	 * 
	 * @return description of virtual machine.
	 */
	public String getDescription()
	{
		return this.getRootXmlNode().getXmlElementValue( "description" );
	}

	/**
	 * Sets virtual machine description in the Libvirt domain XML document.
	 * 
	 * @param description virtual machine description for Libvirt domain XML document.
	 */
	public void setDescription( String description )
	{
		this.getRootXmlNode().setXmlElementValue( "description", description );
	}

	/**
	 * Returns the libosinfo operating system identifier.
	 * 
	 * @return libosinfo operating system identifier.
	 */
	public String getLibOsInfoOsId()
	{
		return this.getRootXmlNode()
				.getXmlElementAttributeValue( "metadata/*[local-name()='libosinfo']/*[local-name()='os']", "id" );
	}

	/**
	 * Returns the state of the Hyper-V vendor identifier feature.
	 * 
	 * @return state of the Hyper-V vendor identifier feature.
	 */
	public boolean isFeatureHypervVendorIdStateOn()
	{
		return this.getRootXmlNode().getXmlElementAttributeValueAsBool( "features/hyperv/vendor_id", "state" );
	}

	/**
	 * Sets the state of the Hyper-V vendor identifier feature.
	 * 
	 * @param on state for the Hyper-V vendor identifier feature.
	 */
	public void setFeatureHypervVendorIdState( boolean on )
	{
		this.getRootXmlNode().setXmlElementAttributeValueOnOff( "features/hyperv/vendor_id", "state", on );
	}

	/**
	 * Returns the value of the Hyper-V vendor identifier feature.
	 * 
	 * @return value of the Hyper-V vendor identifier feature.
	 */
	public String getFeatureHypervVendorIdValue()
	{
		return this.getRootXmlNode().getXmlElementAttributeValue( "features/hyperv/vendor_id", "value" );
	}

	/**
	 * Sets the value of the Hyper-V vendor identifier feature.
	 * 
	 * @param value value for the Hyper-V vendor identifier feature.
	 */
	public void setFeatureHypervVendorIdValue( String value )
	{
		this.getRootXmlNode().setXmlElementAttributeValue( "features/hyperv/vendor_id", "value", value );
	}

	/**
	 * Returns the state of the KVM hidden feature.
	 * 
	 * @return state of the KVM hidden feature.
	 */
	public boolean isFeatureKvmHiddenStateOn()
	{
		return this.getRootXmlNode().getXmlElementAttributeValueAsBool( "features/kvm/hidden", "state" );
	}

	/**
	 * Sets the state of the KVM hidden feature.
	 * 
	 * @param on state for the KVM hidden feature.
	 */
	public void setFeatureKvmHiddenState( boolean on )
	{
		this.getRootXmlNode().setXmlElementAttributeValueOnOff( "features/kvm/hidden", "state", on );
	}

	/**
	 * Returns virtual machine UUID defined in the Libvirt domain XML document.
	 * 
	 * @return UUID of virtual machine.
	 */
	public String getUuid()
	{
		return this.getRootXmlNode().getXmlElementValue( "uuid" );
	}

	/**
	 * Sets virtual machine UUID in the Libvirt domain XML document.
	 * 
	 * @param uuid virtual machine UUID for Libvirt domain XML document.
	 */
	public void setUuid( String uuid )
	{
		this.getRootXmlNode().setXmlElementValue( "uuid", uuid );
	}

	/**
	 * Removes virtual machine UUID in the Libvirt domain XML document.
	 */
	public void removeUuid()
	{
		this.getRootXmlNode().removeXmlElement( "uuid" );
	}

	/**
	 * Returns virtual machine memory defined in the Libvirt domain XML document.
	 * 
	 * @return memory of virtual machine.
	 */
	public BigInteger getMemory()
	{
		String memValue = this.getRootXmlNode().getXmlElementValue( "memory" );
		String memUnit = this.getRootXmlNode().getXmlElementAttributeValue( "memory", "unit" );
		return DomainUtils.decodeMemory( memValue, memUnit );
	}

	/**
	 * Sets virtual machine memory in the Libvirt domain XML document.
	 * 
	 * @param memory virtual machine memory in the Libvirt domain XML document.
	 */
	public void setMemory( BigInteger memory )
	{
		this.getRootXmlNode().setXmlElementAttributeValue( "memory", "unit", "KiB" );
		this.getRootXmlNode().setXmlElementValue( "memory", DomainUtils.encodeMemory( memory, "KiB" ) );
	}

	/**
	 * Returns current virtual machine memory defined in the Libvirt domain XML document.
	 * 
	 * @return current memory of virtual machine.
	 */
	public BigInteger getCurrentMemory()
	{
		String memValue = this.getRootXmlNode().getXmlElementValue( "currentMemory" );
		String memUnit = this.getRootXmlNode().getXmlElementAttributeValue( "currentMemory", "unit" );
		return DomainUtils.decodeMemory( memValue, memUnit );
	}

	/**
	 * Set current virtual machine memory in the Libvirt domain XML document.
	 * 
	 * @param currentMemory current virtual machine memory in the Libvirt domain XML document.
	 */
	public void setCurrentMemory( BigInteger currentMemory )
	{
		this.getRootXmlNode().setXmlElementAttributeValue( "currentMemory", "unit", "KiB" );
		this.getRootXmlNode().setXmlElementValue( "currentMemory", DomainUtils.encodeMemory( currentMemory, "KiB" ) );
	}

	/**
	 * Returns number of virtual machine CPUs defined in the Libvirt domain XML document.
	 * 
	 * @return number of CPUs of the virtual machine.
	 */
	public int getVCpu()
	{
		String number = this.getRootXmlNode().getXmlElementValue( "vcpu" );
		return Integer.parseUnsignedInt( number );
	}

	/**
	 * Set number of virtual machine CPUs in the Libvirt domain XML document.
	 * 
	 * @param number virtual machine CPUs.
	 */
	public void setVCpu( int number )
	{
		this.getRootXmlNode().setXmlElementValue( "vcpu", Integer.toString( number ) );
	}

	/**
	 * Returns OS type defined in the Libvirt domain XML document.
	 * 
	 * @return OS type of the virtual machine.
	 */
	public OsType getOsType()
	{
		final String osType = this.getRootXmlNode().getXmlElementValue( "os/type" );
		return OsType.fromString( osType );
	}

	/**
	 * Set OS type in the Libvirt domain XML document.
	 * 
	 * @param type OS type for the virtual machine.
	 */
	public void setOsType( OsType type )
	{
		this.getRootXmlNode().setXmlElementValue( "os/type", type.toString() );
	}

	/**
	 * Returns OS architecture defined in the Libvirt domain XML document.
	 * 
	 * @return OS architecture of the virtual machine.
	 */
	public String getOsArch()
	{
		return this.getRootXmlNode().getXmlElementAttributeValue( "os/type", "arch" );
	}

	/**
	 * Set OS architecture in the Libvirt domain XML document.
	 * 
	 * @param arch OS architecture for the virtual machine.
	 */
	public void setOsArch( String arch )
	{
		this.getRootXmlNode().setXmlElementAttributeValue( "os/type", "arch", arch );
	}

	/**
	 * Returns OS machine defined in the Libvirt domain XML document.
	 * 
	 * @return OS machine of the virtual machine.
	 */
	public String getOsMachine()
	{
		return this.getRootXmlNode().getXmlElementAttributeValue( "os/type", "machine" );
	}

	/**
	 * Set OS machine in the Libvirt domain XML document.
	 * 
	 * @param machine OS machine for the virtual machine.
	 */
	public void setOsMachine( String machine )
	{
		this.getRootXmlNode().setXmlElementAttributeValue( "os/type", "machine", machine );
	}

	/**
	 * Operating system types specifiable for a virtual machine in the Libvirt domain XML document.
	 * 
	 * @author Manuel Bentele
	 * @version 1.0
	 */
	public enum OsType
	{
		// @formatter:off
		XEN  ( "xen" ),
		LINUX( "linux" ),
		HVM  ( "hvm" ),
		EXE  ( "exe" ),
		UML  ( "uml" );
		// @formatter:on

		/**
		 * Name of the OS type in a Libvirt domain XML document.
		 */
		private final String osType;

		/**
		 * Creates an OS type.
		 * 
		 * @param osType valid name of the OS type in the Libvirt domain XML document.
		 */
		OsType( String osType )
		{
			this.osType = osType;
		}

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

		/**
		 * Creates an OS type from its name with error check.
		 * 
		 * @param osType name of the OS type in the Libvirt domain XML document.
		 * @return valid OS type.
		 */
		public static OsType fromString( String osType )
		{
			for ( OsType t : OsType.values() ) {
				if ( t.osType.equalsIgnoreCase( osType ) ) {
					return t;
				}
			}

			return null;
		}
	}

	/**
	 * Returns virtual machine CPU model defined in the Libvirt domain XML document.
	 * 
	 * @return CPU model of virtual machine.
	 */
	public String getCpuModel()
	{
		return this.getRootXmlNode().getXmlElementValue( "cpu/model" );
	}

	/**
	 * Sets virtual machine CPU model in the Libvirt domain XML document.
	 * 
	 * @param model virtual machine CPU model.
	 */
	public void setCpuModel( String model )
	{
		this.getRootXmlNode().setXmlElementValue( "cpu/model", model );
	}

	/**
	 * CPU modes specifiable for a virtual machine in the Libvirt domain XML document.
	 * 
	 * @author Manuel Bentele
	 * @version 1.0
	 */
	public enum CpuMode
	{
		// @formatter:off
		CUSTOM          ( "custom" ),
		HOST_MODEL      ( "host-model" ),
		HOST_PASSTHROUGH( "host-passthrough" );
		// @formatter:on

		/**
		 * Name of the CPU mode in a Libvirt domain XML document.
		 */
		private String cpuMode;

		/**
		 * Creates a CPU mode.
		 * 
		 * @param mode valid name of the CPU mode in the Libvirt domain XML document.
		 */
		CpuMode( String mode )
		{
			this.cpuMode = mode;
		}

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

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

			return null;
		}
	}

	/**
	 * Returns virtual machine CPU mode defined in the Libvirt domain XML document.
	 * 
	 * @return CPU mode of the virtual machine.
	 */
	public CpuMode getCpuMode()
	{
		String cpuMode = this.getRootXmlNode().getXmlElementAttributeValue( "cpu", "mode" );
		return CpuMode.fromString( cpuMode );
	}

	/**
	 * Sets virtual machine CPU mode in the Libvirt domain XML document.
	 * 
	 * @param mode virtual machine CPU mode.
	 */
	public void setCpuMode( CpuMode mode )
	{
		this.getRootXmlNode().setXmlElementAttributeValue( "cpu", "mode", mode.toString() );
	}

	/**
	 * CPU checks specifiable for a virtual machine in the Libvirt domain XML document.
	 * 
	 * @author Manuel Bentele
	 * @version 1.0
	 */
	public enum CpuCheck
	{
		// @formatter:off
		NONE   ( "none" ),
		PARTIAL( "partial" ),
		FULL   ( "full" );
		// @formatter:on

		/**
		 * Name of the CPU check in the Libvirt domain XML document.
		 */
		private String cpuCheck;

		/**
		 * Creates a CPU check.
		 * 
		 * @param check valid name of the CPU check in the Libvirt domain XML document.
		 */
		CpuCheck( String check )
		{
			this.cpuCheck = check;
		}

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

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

			return null;
		}
	}

	/**
	 * Returns virtual machine CPU check defined in the Libvirt domain XML document.
	 * 
	 * @return CPU check of the virtual machine.
	 */
	public CpuCheck getCpuCheck()
	{
		String cpuCheck = this.getRootXmlNode().getXmlElementAttributeValue( "cpu", "check" );
		return CpuCheck.fromString( cpuCheck );
	}

	/**
	 * Sets virtual machine CPU check in the Libvirt domain XML document.
	 * 
	 * @param check virtual machine CPU check.
	 */
	public void setCpuCheck( CpuCheck check )
	{
		this.getRootXmlNode().setXmlElementAttributeValue( "cpu", "check", check.toString() );
	}

	/**
	 * Returns the file name of the emulator binary defined in the Libvirt domain XML document.
	 * 
	 * @return file name of the emulator binary.
	 */
	public String getDevicesEmulator()
	{
		return this.getRootXmlNode().getXmlElementValue( "devices/emulator" );
	}

	/**
	 * Sets the file name of the emulator binary in the Libvirt domain XML document.
	 * 
	 * @param emulator file name of the emulator binary.
	 */
	public void setDevicesEmulator( String emulator )
	{
		this.getRootXmlNode().setXmlElementValue( "devices/emulator", emulator );
	}

	/**
	 * Returns virtual machine devices defined in the Libvirt domain XML document.
	 * 
	 * @return devices of the virtual machine.
	 */
	public ArrayList<Device> getDevices()
	{
		ArrayList<Device> devices = new ArrayList<Device>();
		Node devicesNode = this.getRootXmlNode().getXmlElement( "devices" );

		if ( devicesNode != null ) {

			NodeList devicesElements = devicesNode.getChildNodes();

			for ( int i = 0; i < devicesElements.getLength(); i++ ) {
				final Node childNode = devicesElements.item( i );
				if ( childNode.getNodeType() == Node.ELEMENT_NODE ) {
					LibvirtXmlNode deviceNode = new LibvirtXmlNode( this.getRootXmlNode().getXmlDocument(), childNode );
					Device device = Device.newInstance( deviceNode );

					if ( device != null ) {
						devices.add( device );
					}
				}
			}
		}

		return devices;
	}

	/**
	 * Filter list of virtual machine devices of type {@link Device} and cast filtered instances to
	 * more specific device type <code>R</code>.
	 * 
	 * @param <R> specific device type for filtering and casting.
	 * @param cls specific device type's class.
	 * @param devices list of virtual machines devices.
	 * @return filtered list of virtual machines devices of type <code>R</code>.
	 */
	private static <R> ArrayList<R> filterDevices( Class<R> cls, ArrayList<Device> devices )
	{
		Predicate<Device> byFilter = device -> cls.isInstance( device );
		Function<Device, R> castFunction = device -> cls.cast( device );

		return devices.stream().filter( byFilter ).map( castFunction )
				.collect( Collectors.toCollection( ArrayList::new ) );
	}

	/**
	 * Returns list of virtual machine controller devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine controller devices.
	 */
	public ArrayList<Controller> getControllerDevices()
	{
		return Domain.filterDevices( Controller.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine floppy controller devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine floppy controller devices.
	 */
	public ArrayList<ControllerFloppy> getFloppyControllerDevices()
	{
		return Domain.filterDevices( ControllerFloppy.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine IDE controller devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine IDE controller devices.
	 */
	public ArrayList<ControllerIde> getIdeControllerDevices()
	{
		return Domain.filterDevices( ControllerIde.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine floppy controller devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine floppy controller devices.
	 */
	public ArrayList<ControllerPci> getPciControllerDevices()
	{
		return Domain.filterDevices( ControllerPci.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine SATA controller devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine SATA controller devices.
	 */
	public ArrayList<ControllerSata> getSataControllerDevices()
	{
		return Domain.filterDevices( ControllerSata.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine SCSI controller devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine SCSI controller devices.
	 */
	public ArrayList<ControllerScsi> getScsiControllerDevices()
	{
		return Domain.filterDevices( ControllerScsi.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine USB controller devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine USB controller devices.
	 */
	public ArrayList<ControllerUsb> getUsbControllerDevices()
	{
		return Domain.filterDevices( ControllerUsb.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine disk devices specified in the Libvirt domain XML document.
	 * 
	 * @return list of virtual machine disk devices.
	 */
	public ArrayList<Disk> getDiskDevices()
	{
		return Domain.filterDevices( Disk.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine disk CDROM devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine disk CDROM devices.
	 */
	public ArrayList<DiskCdrom> getDiskCdromDevices()
	{
		return Domain.filterDevices( DiskCdrom.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine disk floppy devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine disk floppy devices.
	 */
	public ArrayList<DiskFloppy> getDiskFloppyDevices()
	{
		return Domain.filterDevices( DiskFloppy.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine disk storage devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine disk storage devices.
	 */
	public ArrayList<DiskStorage> getDiskStorageDevices()
	{
		return Domain.filterDevices( DiskStorage.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine file system devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine file system devices.
	 */
	public ArrayList<FileSystem> getFileSystemDevices()
	{
		return Domain.filterDevices( FileSystem.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine hostdev devices specified in the Libvirt domain XML document.
	 * 
	 * @return list of virtual machine hostdev devices.
	 */
	public ArrayList<Hostdev> getHostdevDevices()
	{
		return Domain.filterDevices( Hostdev.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine PCI hostdev devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine PCI hostdev devices.
	 */
	public ArrayList<HostdevPci> getHostdevPciDevices()
	{
		return Domain.filterDevices( HostdevPci.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine USB hostdev devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine USB hostdev devices.
	 */
	public ArrayList<HostdevUsb> getHostdevUsbDevices()
	{
		return Domain.filterDevices( HostdevUsb.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine network interface devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine network interface devices.
	 */
	public ArrayList<Interface> getInterfaceDevices()
	{
		return Domain.filterDevices( Interface.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine graphic devices specified in the Libvirt domain XML document.
	 * 
	 * @return list of virtual machine graphic devices.
	 */
	public ArrayList<Graphics> getGraphicDevices()
	{
		return Domain.filterDevices( Graphics.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine parallel port devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine parallel port devices.
	 */
	public ArrayList<Parallel> getParallelDevices()
	{
		return Domain.filterDevices( Parallel.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine serial port devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine serial port devices.
	 */
	public ArrayList<Serial> getSerialDevices()
	{
		return Domain.filterDevices( Serial.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine shared memory devices specified in the Libvirt domain XML
	 * document.
	 * 
	 * @return list of virtual machine shared memory devices.
	 */
	public ArrayList<Shmem> getShmemDevices()
	{
		return Domain.filterDevices( Shmem.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine sound devices specified in the Libvirt domain XML document.
	 * 
	 * @return list of virtual machine sound devices.
	 */
	public ArrayList<Sound> getSoundDevices()
	{
		return Domain.filterDevices( Sound.class, this.getDevices() );
	}

	/**
	 * Returns list of virtual machine video devices specified in the Libvirt domain XML document.
	 * 
	 * @return list of virtual machine video devices.
	 */
	public ArrayList<Video> getVideoDevices()
	{
		return Domain.filterDevices( Video.class, this.getDevices() );
	}

	/**
	 * Adds a virtual machine device to the Libvirt domain XML document.
	 *
	 * @param device virtual machine device that is added to the Libvirt domain XML document.
	 * @return reference to the added device for configuration purposes if creation was successful.
	 */
	public Device addDevice( Device device )
	{
		Device addedDevice = null;

		if ( device != null ) {
			Node devicesNode = this.getRootXmlNode().getXmlElement( "devices" );

			if ( devicesNode != null ) {
				LibvirtXmlNode parentDevicesNode = null;
				parentDevicesNode = new LibvirtXmlNode( this.getRootXmlNode().getXmlDocument(), devicesNode );
				addedDevice = Device.createInstance( device, parentDevicesNode );
			}
		}

		return addedDevice;
	}

	/**
	 * Adds a virtual machine controller device to the Libvirt domain XML document.
	 *
	 * @return reference to the added controller device if creation was successful.
	 */
	public Controller addControllerDevice()
	{
		return Controller.class.cast( this.addDevice( new Controller() ) );
	}

	/**
	 * Adds a virtual machine floppy controller device to the Libvirt domain XML document.
	 *
	 * @return reference to the added floppy controller device if creation was successful.
	 */
	public ControllerFloppy addControllerFloppyDevice()
	{
		return ControllerFloppy.class.cast( this.addDevice( new ControllerFloppy() ) );
	}

	/**
	 * Adds a virtual machine IDE controller device to the Libvirt domain XML document.
	 *
	 * @return reference to the added IDE controller device if creation was successful.
	 */
	public ControllerIde addControllerIdeDevice()
	{
		return ControllerIde.class.cast( this.addDevice( new ControllerIde() ) );
	}

	/**
	 * Adds a virtual machine PCI controller device to the Libvirt domain XML document.
	 *
	 * @return reference to the added PCI controller device if creation was successful.
	 */
	public ControllerPci addControllerPciDevice()
	{
		return ControllerPci.class.cast( this.addDevice( new ControllerPci() ) );
	}

	/**
	 * Adds a virtual machine SATA controller device to the Libvirt domain XML document.
	 *
	 * @return reference to the added SATA controller device if creation was successful.
	 */
	public ControllerSata addControllerSataDevice()
	{
		return ControllerSata.class.cast( this.addDevice( new ControllerSata() ) );
	}

	/**
	 * Adds a virtual machine SCSI controller device to the Libvirt domain XML document.
	 *
	 * @return reference to the added SCSI controller device if creation was successful.
	 */
	public ControllerScsi addControllerScsiDevice()
	{
		return ControllerScsi.class.cast( this.addDevice( new ControllerScsi() ) );
	}

	/**
	 * Adds a virtual machine USB controller device to the Libvirt domain XML document.
	 *
	 * @return reference to the added USB controller device if creation was successful.
	 */
	public ControllerUsb addControllerUsbDevice()
	{
		return ControllerUsb.class.cast( this.addDevice( new ControllerUsb() ) );
	}

	/**
	 * Adds a virtual machine disk device to the Libvirt domain XML document.
	 *
	 * @return reference to the added disk device if creation was successful.
	 */
	public Disk addDiskDevice()
	{
		return Disk.class.cast( this.addDevice( new Disk() ) );
	}

	/**
	 * Adds a virtual machine CDROM disk device to the Libvirt domain XML document.
	 *
	 * @return reference to the added CDROM disk device if creation was successful.
	 */
	public DiskCdrom addDiskCdromDevice()
	{
		return DiskCdrom.class.cast( this.addDevice( new DiskCdrom() ) );
	}

	/**
	 * Adds a virtual machine floppy disk device to the Libvirt domain XML document.
	 *
	 * @return reference to the added floppy disk device if creation was successful.
	 */
	public DiskFloppy addDiskFloppyDevice()
	{
		return DiskFloppy.class.cast( this.addDevice( new DiskFloppy() ) );
	}

	/**
	 * Adds a virtual machine storage disk device to the Libvirt domain XML document.
	 *
	 * @return reference to the added storage disk device if creation was successful.
	 */
	public DiskStorage addDiskStorageDevice()
	{
		return DiskStorage.class.cast( this.addDevice( new DiskStorage() ) );
	}

	/**
	 * Adds a virtual machine file system device to the Libvirt domain XML document.
	 *
	 * @return reference to the added file system device if creation was successful.
	 */
	public FileSystem addFileSystemDevice()
	{
		return FileSystem.class.cast( this.addDevice( new FileSystem() ) );
	}

	/**
	 * Adds a virtual machine hostdev device to the Libvirt domain XML document.
	 *
	 * @return reference to the added hostdev device if creation was successful.
	 */
	public Hostdev addHostdevDevice()
	{
		return Hostdev.class.cast( this.addDevice( new Hostdev() ) );
	}

	/**
	 * Adds a virtual machine PCI hostdev device to the Libvirt domain XML document.
	 *
	 * @return reference to the added PCI hostdev device if creation was successful.
	 */
	public HostdevPci addHostdevPciDevice()
	{
		return HostdevPci.class.cast( this.addDevice( new HostdevPci() ) );
	}

	/**
	 * Adds a virtual machine USB hostdev device to the Libvirt domain XML document.
	 *
	 * @return reference to the added USB hostdev device if creation was successful.
	 */
	public HostdevUsb addHostdevUsbDevice()
	{
		return HostdevUsb.class.cast( this.addDevice( new HostdevUsb() ) );
	}

	/**
	 * Adds a virtual machine network device to the Libvirt domain XML document.
	 *
	 * @return reference to the added network device if creation was successful.
	 */
	public Interface addInterfaceDevice()
	{
		return Interface.class.cast( this.addDevice( new Interface() ) );
	}

	/**
	 * Adds a virtual machine network bridge interface device to the Libvirt domain XML document.
	 *
	 * @return reference to the added network interface device if creation was successful.
	 */
	public InterfaceBridge addInterfaceBridgeDevice()
	{
		return InterfaceBridge.class.cast( this.addDevice( new InterfaceBridge() ) );
	}

	/**
	 * Adds a virtual machine network interface device to the Libvirt domain XML document.
	 *
	 * @return reference to the added network interface device if creation was successful.
	 */
	public InterfaceNetwork addInterfaceNetworkDevice()
	{
		return InterfaceNetwork.class.cast( this.addDevice( new InterfaceNetwork() ) );
	}

	/**
	 * Adds a virtual machine graphics device to the Libvirt domain XML document.
	 *
	 * @return reference to the added graphics device if creation was successful.
	 */
	public Graphics addGraphicsDevice()
	{
		return Graphics.class.cast( this.addDevice( new Graphics() ) );
	}

	/**
	 * Adds a virtual machine SPICE graphics device to the Libvirt domain XML document.
	 *
	 * @return reference to the added SPICE graphics device if creation was successful.
	 */
	public GraphicsSpice addGraphicsSpiceDevice()
	{
		return GraphicsSpice.class.cast( this.addDevice( new GraphicsSpice() ) );
	}

	/**
	 * Adds a virtual machine VNC graphics device to the Libvirt domain XML document.
	 *
	 * @return reference to the added VNC graphics device if creation was successful.
	 */
	public GraphicsVnc addGraphicsVncDevice()
	{
		return GraphicsVnc.class.cast( this.addDevice( new GraphicsVnc() ) );
	}

	/**
	 * Adds a virtual machine parallel port device to the Libvirt domain XML document.
	 *
	 * @return reference to the added parallel port device if creation was successful.
	 */
	public Parallel addParallelDevice()
	{
		return Parallel.class.cast( this.addDevice( new Parallel() ) );
	}

	/**
	 * Adds a virtual machine serial port device to the Libvirt domain XML document.
	 *
	 * @return reference to the added serial port device if creation was successful.
	 */
	public Serial addSerialDevice()
	{
		return Serial.class.cast( this.addDevice( new Serial() ) );
	}

	/**
	 * Adds a virtual machine shared memory device to the Libvirt domain XML document.
	 *
	 * @return reference to the added shared memory device if creation was successful.
	 */
	public Shmem addShmemDevice()
	{
		return Shmem.class.cast( this.addDevice( new Shmem() ) );
	}

	/**
	 * Adds a virtual machine sound device to the Libvirt domain XML document.
	 *
	 * @return reference to the added sound device if creation was successful.
	 */
	public Sound addSoundDevice()
	{
		return Sound.class.cast( this.addDevice( new Sound() ) );
	}

	/**
	 * Adds a virtual machine video device to the Libvirt domain XML document.
	 *
	 * @return reference to the added video device if creation was successful.
	 */
	public Video addVideoDevice()
	{
		return Video.class.cast( this.addDevice( new Video() ) );
	}

	/**
	 * Removes boot oder entries in the Libvirt domain XML document.
	 */
	public void removeBootOrder()
	{
		// remove boot order entries of all disk devices
		for ( Disk diskDevice : this.getDiskDevices() ) {
			diskDevice.removeBootOrder();
		}

		// remove boot order entries of all network interface devices
		for ( Interface interfaceDevice : this.getInterfaceDevices() ) {
			interfaceDevice.removeBootOrder();
		}

		// remove boot order entries of all hostdev devices
		for ( Hostdev hostdevDevice : this.getHostdevDevices() ) {
			hostdevDevice.removeBootOrder();
		}

		// remove boot oder entries under the 'os' element
		this.getRootXmlNode().removeXmlElement( "os/boot" );
	}

	/**
	 * Removes underlying source for all disk devices in the Libvirt domain XML document.
	 * 
	 * @implNote Calling this method will result in an invalid Libvirt domain XML document.
	 */
	public void removeDiskDevicesStorage()
	{
		for ( Disk diskDevice : this.getDiskDevices() ) {
			diskDevice.removeStorage();
		}
	}

	/**
	 * Removes network source for all interface devices in the Libvirt domain XML document.
	 */
	public void removeInterfaceDevicesSource()
	{
		for ( Interface interfaceDevice : this.getInterfaceDevices() ) {
			// set empty source to preserve the XML attribute (to prevent XML validation errors)
			interfaceDevice.setSource( "" );
		}
	}
}