KVMRedirectionSAP.java

/**
 * This file was auto-generated by mofcomp -j version 1.0.0 on Wed Jan 12
 * 09:21:06 CET 2011.
 */

package org.opennaas.extensions.router.model;

import java.io.*;
import java.lang.Exception;

/**
 * This Class contains accessor and mutator methods for all properties defined in the CIM class KVMRedirectionSAP as well as methods comparable to the
 * invokeMethods defined for this class. This Class implements the KVMRedirectionSAPBean Interface. The CIM class KVMRedirectionSAP is described as
 * follows:
 * 
 * A class derived from Service Access Point, that describes an access point to start the KVM redirection. One access point represents access to a
 * single KVM redirection stream.
 */
public class KVMRedirectionSAP extends ServiceAccessPoint implements
		Serializable {

	/**
	 * This constructor creates a KVMRedirectionSAPBeanImpl Class which implements the KVMRedirectionSAPBean Interface, and encapsulates the CIM class
	 * KVMRedirectionSAP in a Java Bean. The CIM class KVMRedirectionSAP is described as follows:
	 * 
	 * A class derived from Service Access Point, that describes an access point to start the KVM redirection. One access point represents access to a
	 * single KVM redirection stream.
	 */
	public KVMRedirectionSAP() {
	};

	/**
	 * The following constants are defined for use with the ValueMap/Values qualified property KVMProtocol.
	 */

	public enum KVMProtocol {
		UNKNOWN,
		OTHER,
		RAW,
		RDP,
		VNC_RFB,
		DMTF_RESERVED,
		VENDOR_SPECIFIED
	}

	private KVMProtocol	kVMProtocol;

	/**
	 * This method returns the KVMRedirectionSAP.kVMProtocol property value. This property is described as follows:
	 * 
	 * An enumeration specifying the type of the KVM stream supported on this SAP. In some cases this may be a raw video steam, with the characters
	 * having no special meaning. However, in other cases it may support a protocol where some messages have a predefined structure. 0 "Unknown" shall
	 * indicate the protocol is unknown. 1 "Other" shall indicate the protocol is specified in OtherKVMProtocol. 2 "Raw" shall indicate the protocol
	 * is a raw and uncompressed data stream. 3 "RDP" shall indicate the protocol is the Remote Desktop Protocol. 4 "VNC" shall indicate the protocol
	 * is the VNC Protocol.
	 * 
	 * @return int current kVMProtocol property value
	 * @exception Exception
	 */
	public KVMProtocol getKVMProtocol() {

		return this.kVMProtocol;
	} // getKVMProtocol

	/**
	 * This method sets the KVMRedirectionSAP.kVMProtocol property value. This property is described as follows:
	 * 
	 * An enumeration specifying the type of the KVM stream supported on this SAP. In some cases this may be a raw video steam, with the characters
	 * having no special meaning. However, in other cases it may support a protocol where some messages have a predefined structure. 0 "Unknown" shall
	 * indicate the protocol is unknown. 1 "Other" shall indicate the protocol is specified in OtherKVMProtocol. 2 "Raw" shall indicate the protocol
	 * is a raw and uncompressed data stream. 3 "RDP" shall indicate the protocol is the Remote Desktop Protocol. 4 "VNC" shall indicate the protocol
	 * is the VNC Protocol.
	 * 
	 * @param int new kVMProtocol property value
	 * @exception Exception
	 */
	public void setKVMProtocol(KVMProtocol kVMProtocol) {

		this.kVMProtocol = kVMProtocol;
	} // setKVMProtocol

	/**
	 * The following constants are defined for use with the ValueMap/Values qualified property otherKVMProtocol.
	 */
	private String	otherKVMProtocol;

	/**
	 * This method returns the KVMRedirectionSAP.otherKVMProtocol property value. This property is described as follows:
	 * 
	 * A string describing the KVMProtocol when the value of the KVMProtocol property is set to 1 = "Other".
	 * 
	 * @return String current otherKVMProtocol property value
	 * @exception Exception
	 */
	public String getOtherKVMProtocol() {

		return this.otherKVMProtocol;
	} // getOtherKVMProtocol

	/**
	 * This method sets the KVMRedirectionSAP.otherKVMProtocol property value. This property is described as follows:
	 * 
	 * A string describing the KVMProtocol when the value of the KVMProtocol property is set to 1 = "Other".
	 * 
	 * @param String
	 *            new otherKVMProtocol property value
	 * @exception Exception
	 */
	public void setOtherKVMProtocol(String otherKVMProtocol) {

		this.otherKVMProtocol = otherKVMProtocol;
	} // setOtherKVMProtocol

} // Class KVMRedirectionSAP