1 files changed, 406 insertions, 0 deletions
diff --git a/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/cmdln/CommandLineArgs.java b/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/cmdln/CommandLineArgs.java
new file mode 100644
index 00000000..13b8c0e2
--- /dev/null
+++ b/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/cmdln/CommandLineArgs.java
@@ -0,0 +1,406 @@
+package org.openslx.runvirt.plugin.qemu.cmdln;
+
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.HelpFormatter;
+import org.apache.commons.cli.Options;
+import org.apache.commons.cli.ParseException;
+
+/**
+ * Command line argument parser for the run-virt QEMU plugin (command line tool).
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
+public class CommandLineArgs
+{
+	/**
+	 * Parser for parsing command line arguments.
+	 */
+	private CommandLineParser cmdLnParser = null;
+
+	/**
+	 * Stores specified command line options.
+	 */
+	private Options cmdLnOptions = null;
+
+	/**
+	 * Stores the parsed command line arguments.
+	 */
+	private CommandLine cmdLn = null;
+
+	/**
+	 * Creates a new command line argument parser for the run-virt QEMU plugin.
+	 * 
+	 * @implNote Please call {@link CommandLineArgs#parseCmdLnArgs(String[])} manually after
+	 *           obtaining the command line argument parser from this method.
+	 */
+	public CommandLineArgs()
+	{
+		this.createCmdLnParser();
+		this.createCmdLnOptions();
+	}
+
+	/**
+	 * Creates a new command line argument parser for the run-virt QEMU plugin and parses the command
+	 * line arguments.
+	 * 
+	 * @param args command line arguments submitted to the application.
+	 * 
+	 * @throws CommandLineArgsException parsing of command line arguments failed.
+	 */
+	public CommandLineArgs( String[] args ) throws CommandLineArgsException
+	{
+		this();
+		this.parseCmdLnArgs( args );
+	}
+
+	/**
+	 * Creates a new parser and empty command line options for parsing command line arguments.
+	 */
+	private void createCmdLnParser()
+	{
+		this.cmdLnParser = new DefaultParser();
+		this.cmdLnOptions = new Options();
+	}
+
+	/**
+	 * Creates command line options specified by {@link CmdLnOption}.
+	 */
+	private void createCmdLnOptions()
+	{
+		for ( CmdLnOption option : CmdLnOption.values() ) {
+			this.cmdLnOptions.addOption( option.getShortOption(), option.getLongOption(), option.hasArgument(),
+					option.getDescription() );
+		}
+	}
+
+	/**
+	 * Prints command line help for the current application.
+	 * 
+	 * @param appName name of the current application.
+	 * @param header header for the command line help.
+	 * @param footer footer for the command line help.
+	 */
+	public void printHelp( String appName, String header, String footer )
+	{
+		HelpFormatter formatter = new HelpFormatter();
+		formatter.setLeftPadding( 2 );
+		formatter.printHelp( appName, header, this.cmdLnOptions, footer, true );
+	}
+
+	/**
+	 * Parses command line arguments from a given argument {@link String}.
+	 * 
+	 * @param args command line arguments submitted to the application.
+	 * 
+	 * @throws CommandLineArgsException parsing of command line arguments failed.
+	 */
+	public void parseCmdLnArgs( String[] args ) throws CommandLineArgsException
+	{
+		try {
+			this.cmdLn = this.cmdLnParser.parse( this.cmdLnOptions, args );
+		} catch ( ParseException e ) {
+			throw new CommandLineArgsException( e.getLocalizedMessage() );
+		}
+	}
+
+	/**
+	 * Returns the parsed argument of the specified command line option.
+	 * 
+	 * @param cmdLnOption command line option for that the parsed argument should be returned.
+	 * @return parsed argument of the command line option.
+	 */
+	public String getArgument( CmdLnOption cmdLnOption )
+	{
+		return this.cmdLn.getOptionValue( cmdLnOption.getShortOption() );
+	}
+
+	/**
+	 * Returns the presence of the command line option {@link CmdLnOption#HELP}.
+	 * 
+	 * @return presence of the command line option {@link CmdLnOption#HELP}.
+	 */
+	public boolean isHelpAquired()
+	{
+		return this.cmdLn.hasOption( CmdLnOption.HELP.getShortOption() );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_CFGINP}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_CFGINP}.
+	 */
+	public String getVmCfgInpFileName()
+	{
+		return this.getArgument( CmdLnOption.VM_CFGINP );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_CFGOUT}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_CFGOUT}.
+	 */
+	public String getVmCfgOutFileName()
+	{
+		return this.getArgument( CmdLnOption.VM_CFGOUT );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_NAME}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_NAME}.
+	 */
+	public String getVmName()
+	{
+		return this.getArgument( CmdLnOption.VM_NAME );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_UUID}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_UUID}.
+	 */
+	public String getVmUuid()
+	{
+		return this.getArgument( CmdLnOption.VM_UUID );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_DSPLNAME}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_DSPLNAME}.
+	 */
+	public String getVmDisplayName()
+	{
+		return this.getArgument( CmdLnOption.VM_DSPLNAME );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_OS}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_OS}.
+	 */
+	public String getVmOperatingSystem()
+	{
+		return this.getArgument( CmdLnOption.VM_OS );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_NCPUS}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_NCPUS}.
+	 */
+	public int getVmNumCpus()
+	{
+		final String numCpus = this.getArgument( CmdLnOption.VM_NCPUS );
+		return Integer.parseInt( numCpus );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_MEM}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_MEM}.
+	 */
+	public String getVmMemory()
+	{
+		return this.getArgument( CmdLnOption.VM_MEM );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_HDD0}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_HDD0}.
+	 */
+	public String getVmDiskFileNameHDD0()
+	{
+		return this.getArgument( CmdLnOption.VM_HDD0 );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_FLOPPY0}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_FLOPPY0}.
+	 */
+	public String getVmDiskFileNameFloppy0()
+	{
+		return this.getArgument( CmdLnOption.VM_FLOPPY0 );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_FLOPPY1}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_FLOPPY1}.
+	 */
+	public String getVmDiskFileNameFloppy1()
+	{
+		return this.getArgument( CmdLnOption.VM_FLOPPY1 );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_CDROM0}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_CDROM0}.
+	 */
+	public String getVmDiskFileNameCdrom0()
+	{
+		return this.getArgument( CmdLnOption.VM_CDROM0 );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_CDROM1}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_CDROM1}.
+	 */
+	public String getVmDiskFileNameCdrom1()
+	{
+		return this.getArgument( CmdLnOption.VM_CDROM1 );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_PARALLEL0}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_SERIAL0}.
+	 */
+	public String getVmDeviceParallel0()
+	{
+		return this.getArgument( CmdLnOption.VM_PARALLEL0 );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_SERIAL0}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_SERIAL0}.
+	 */
+	public String getVmDeviceSerial0()
+	{
+		return this.getArgument( CmdLnOption.VM_SERIAL0 );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_MAC0}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_MAC0}.
+	 */
+	public String getVmMacAddress0()
+	{
+		return this.getArgument( CmdLnOption.VM_MAC0 );
+	}
+
+	/**
+	 * Returns the argument of the command line option {@link CmdLnOption#VM_AUDIO0}.
+	 * 
+	 * @return argument of the command line option {@link CmdLnOption#VM_AUDIO0}.
+	 */
+	public String getVmModelSoundCard0()
+	{
+		return this.getArgument( CmdLnOption.VM_AUDIO0 );
+	}
+
+	/**
+	 * Command line options for the run-virt QEMU plugin (command line tool).
+	 * 
+	 * @author Manuel Bentele
+	 * @version 1.0
+	 */
+	public enum CmdLnOption
+	{
+		// @formatter:off
+		HELP        ( 'h', "help",        false, "" ),
+		VM_CFGINP   ( 'i', "vmcfginp",    true,  "File name of an existing and filtered Libvirt domain XML configuration file" ),
+		VM_CFGOUT   ( 'o', "vmcfgout",    true,  "File name to output a finalized Libvirt domain XML configuration file" ),
+		VM_NAME     ( 'n', "vmname",      true,  "Name for the virtual machine" ),
+		VM_UUID     ( 'u', "vmuuid",      true,  "UUID for the virtual machine" ),
+		VM_DSPLNAME ( 'd', "vmdsplname",  true,  "Display name for the virtual machine" ),
+		VM_OS       ( 's', "vmos",        true,  "Operating system running in the virtual machine" ),
+		VM_NCPUS    ( 'c', "vmncpus",     true,  "Number of virtual CPUs for the virtual machine" ),
+		VM_MEM      ( 'm', "vmmem",       true,  "Amount of memory for the virtual machine" ),
+		VM_HDD0     ( 'r', "vmhdd0",      true,  "Disk image for the first HDD device" ),
+		VM_FLOPPY0  ( 'f', "vmfloppy0",   true,  "Disk image for the first floppy drive" ),
+		VM_FLOPPY1  ( 'g', "vmfloppy1",   true,  "Disk image for the second floppy drive" ),
+		VM_CDROM0   ( 'k', "vmcdrom0",    true,  "Disk image for the first CDROM drive" ),
+		VM_CDROM1   ( 'l', "vmcdrom1",    true,  "Disk image for the second CDROM drive" ),
+		VM_PARALLEL0( 'p', "vmparallel0", true,  "Device for the first parallel port interface" ),
+		VM_SERIAL0  ( 'q', "vmserial0",   true,  "Device for the first serial port interface" ),
+		VM_MAC0     ( 'a', "vmmac0",      true,  "MAC address for the first network interface" ),
+		VM_AUDIO0   ( 'x', "vmaudio0",    true,  "Hardware model for the first sound card" );
+		// @formatter:on
+
+		/**
+		 * Stores the {@link Character} of the short command line option.
+		 */
+		private final char shortOption;
+
+		/**
+		 * Stores the {@link String} of the long command line option.
+		 */
+		private final String longOption;
+
+		/**
+		 * Stores the presence of an argument for the command line option.
+		 */
+		private final boolean hasArgument;
+
+		/**
+		 * Stores the textual description of the command line option.
+		 */
+		private final String description;
+
+		/**
+		 * Creates a new command line option for the run-virt QEMU plugin (command line tool).
+		 * 
+		 * @param shortOption {@link Character} for the short command line option.
+		 * @param longOption {@link String} for the long command line option.
+		 * @param hasArgument presence of an argument for the command line option.
+		 * @param description textual description of the command line option.
+		 */
+		CmdLnOption( char shortOption, String longOption, boolean hasArgument, String description )
+		{
+			this.shortOption = shortOption;
+			this.longOption = longOption;
+			this.hasArgument = hasArgument;
+			this.description = description;
+		}
+
+		/**
+		 * Returns the {@link Character} of the short command line option.
+		 * 
+		 * @return {@link Character} of the short command line option.
+		 */
+		public String getShortOption()
+		{
+			return Character.toString( this.shortOption );
+		}
+
+		/**
+		 * Returns the {@link String} of the long command line option.
+		 * 
+		 * @return {@link String} of the long command line option.
+		 */
+		public String getLongOption()
+		{
+			return this.longOption;
+		}
+
+		/**
+		 * Returns the presence of an argument for the command line option.
+		 * 
+		 * @return presence of an argument for the command line option.
+		 */
+		public boolean hasArgument()
+		{
+			return this.hasArgument;
+		}
+
+		/**
+		 * Returns the textual description of the command line option.
+		 * 
+		 * @return textual description of the command line option.
+		 */
+		public String getDescription()
+		{
+			return this.description;
+		}
+	}
+}