OSPFProtocolEndpoint.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.Serializable;

import javax.xml.bind.annotation.XmlRootElement;

/**
 * This Class contains accessor and mutator methods for all properties defined in the CIM class OSPFProtocolEndpoint as well as methods comparable to
 * the invokeMethods defined for this class. This Class implements the OSPFProtocolEndpointBean Interface. The CIM class OSPFProtocolEndpoint is
 * described as follows:
 * 
 * This class represents the OSPF configuration of an interface running OSPF. The instance of this class should be connected to an IPProtocolEndpoint
 * instance via a BindsTo association. The IPProtocolEndpoint instance is the Antecedent and the OSPFProtocolEndpoint instance is the Dependent in the
 * BindsTo association.
 */
@XmlRootElement
public class OSPFProtocolEndpoint extends OSPFProtocolEndpointBase implements
		Serializable {

	/**
	 * 
	 */
	private static final long	serialVersionUID	= -7147359643347855489L;

	/**
	 * This constructor creates a OSPFProtocolEndpointBeanImpl Class which implements the OSPFProtocolEndpointBean Interface, and encapsulates the CIM
	 * class OSPFProtocolEndpoint in a Java Bean. The CIM class OSPFProtocolEndpoint is described as follows:
	 * 
	 * This class represents the OSPF configuration of an interface running OSPF. The instance of this class should be connected to an
	 * IPProtocolEndpoint instance via a BindsTo association. The IPProtocolEndpoint instance is the Antecedent and the OSPFProtocolEndpoint instance
	 * is the Dependent in the BindsTo association.
	 */
	public OSPFProtocolEndpoint() {
	};

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

	/**
	 * This method returns the OSPFProtocolEndpoint.priority property value. This property is described as follows:
	 * 
	 * When two routers attached to a network both attempt to become the Designated Router, the one with the highest (i.e. largest) Priority takes
	 * precedence, see C.3 in RFC 2328. Only routers with greater than zero priority are eligible to become Designated Router.
	 * 
	 * @return short current priority property value
	 * @exception Exception
	 */
	public short getPriority() {

		return this.priority;
	} // getPriority

	/**
	 * This method sets the OSPFProtocolEndpoint.priority property value. This property is described as follows:
	 * 
	 * When two routers attached to a network both attempt to become the Designated Router, the one with the highest (i.e. largest) Priority takes
	 * precedence, see C.3 in RFC 2328. Only routers with greater than zero priority are eligible to become Designated Router.
	 * 
	 * @param short new priority property value
	 * @exception Exception
	 */
	public void setPriority(short priority) {

		this.priority = priority;
	} // setPriority

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

	/**
	 * This method returns the OSPFProtocolEndpoint.pollInterval property value. This property is described as follows:
	 * 
	 * If a neighbouring router on an NBMA (NonBroadcast MultiAccess) link becomes inactive, it is still necessary to send Hello Packets to the dead
	 * neighbor. These packets will be sent at the reduced rate, which should be much larger than HelloInterval, see C.5 in RFC 2328.
	 * 
	 * @return int current pollInterval property value
	 * @exception Exception
	 */
	public int getPollInterval() {

		return this.pollInterval;
	} // getPollInterval

	/**
	 * This method sets the OSPFProtocolEndpoint.pollInterval property value. This property is described as follows:
	 * 
	 * If a neighbouring router on an NBMA (NonBroadcast MultiAccess) link becomes inactive, it is still necessary to send Hello Packets to the dead
	 * neighbor. These packets will be sent at the reduced rate, which should be much larger than HelloInterval, see C.5 in RFC 2328.
	 * 
	 * @param int new pollInterval property value
	 * @exception Exception
	 */
	public void setPollInterval(int pollInterval) {

		this.pollInterval = pollInterval;
	} // setPollInterval

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

	/**
	 * This method returns the OSPFProtocolEndpoint.cost property value. This property is described as follows:
	 * 
	 * The cost of the routes through this OSPF endpoint, see C.3 in RFC 2328.
	 * 
	 * @return int current cost property value
	 * @exception Exception
	 */
	public int getCost() {

		return this.cost;
	} // getCost

	/**
	 * This method sets the OSPFProtocolEndpoint.cost property value. This property is described as follows:
	 * 
	 * The cost of the routes through this OSPF endpoint, see C.3 in RFC 2328.
	 * 
	 * @param int new cost property value
	 * @exception Exception
	 */
	public void setCost(int cost) {

		this.cost = cost;
	} // setCost

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

	/**
	 * This method returns the OSPFProtocolEndpoint.ifDemand property value. This property is described as follows:
	 * 
	 * Indicates whether the interface connects to an on-demand circuit, see RFC 1793.
	 * 
	 * @return boolean current ifDemand property value
	 * @exception Exception
	 */
	public boolean isIfDemand() {

		return this.ifDemand;
	} // getIfDemand

	/**
	 * This method sets the OSPFProtocolEndpoint.ifDemand property value. This property is described as follows:
	 * 
	 * Indicates whether the interface connects to an on-demand circuit, see RFC 1793.
	 * 
	 * @param boolean new ifDemand property value
	 * @exception Exception
	 */
	public void setIfDemand(boolean ifDemand) {

		this.ifDemand = ifDemand;
	} // setIfDemand

} // Class OSPFProtocolEndpoint