org.opennms.netmgt.config.enlinkd

Class EnlinkdConfiguration

java.lang.Object

org.opennms.netmgt.config.enlinkd.EnlinkdConfiguration

All Implemented Interfaces:

Serializable

public class EnlinkdConfiguration
extends Object
implements Serializable

Top-level element for the enlinkd-configuration.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnlinkdConfiguration()

Method Summary

Modifier and Type	Method and Description
void	deleteInitial_sleep_time()
void	deleteMax_bft()
void	deleteRescan_interval()
void	deleteThreads()
void	deleteUseBridgeDiscovery()
void	deleteUseCdpDiscovery()
void	deleteUseIsisDiscovery()
void	deleteUseLldpDiscovery()
void	deleteUseOspfDiscovery()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
long	getInitial_sleep_time() Returns the value of field 'initial_sleep_time'.
int	getMax_bft() Returns the value of field 'max_bft'.
long	getRescan_interval() Returns the value of field 'rescan_interval'.
int	getThreads() Returns the value of field 'threads'.
boolean	getUseBridgeDiscovery() Returns the value of field 'useBridgeDiscovery'.
boolean	getUseCdpDiscovery() Returns the value of field 'useCdpDiscovery'.
boolean	getUseIsisDiscovery() Returns the value of field 'useIsisDiscovery'.
boolean	getUseLldpDiscovery() Returns the value of field 'useLldpDiscovery'.
boolean	getUseOspfDiscovery() Returns the value of field 'useOspfDiscovery'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasInitial_sleep_time() Method hasInitial_sleep_time.
boolean	hasMax_bft() Method hasMax_bft.
boolean	hasRescan_interval() Method hasRescan_interval.
boolean	hasThreads() Method hasThreads.
boolean	hasUseBridgeDiscovery() Method hasUseBridgeDiscovery.
boolean	hasUseCdpDiscovery() Method hasUseCdpDiscovery.
boolean	hasUseIsisDiscovery() Method hasUseIsisDiscovery.
boolean	hasUseLldpDiscovery() Method hasUseLldpDiscovery.
boolean	hasUseOspfDiscovery() Method hasUseOspfDiscovery.
boolean	isUseBridgeDiscovery() Returns the value of field 'useBridgeDiscovery'.
boolean	isUseCdpDiscovery() Returns the value of field 'useCdpDiscovery'.
boolean	isUseIsisDiscovery() Returns the value of field 'useIsisDiscovery'.
boolean	isUseLldpDiscovery() Returns the value of field 'useLldpDiscovery'.
boolean	isUseOspfDiscovery() Returns the value of field 'useOspfDiscovery'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setInitial_sleep_time(long initial_sleep_time) Sets the value of field 'initial_sleep_time'.
void	setMax_bft(int max_bft) Sets the value of field 'max_bft'.
void	setRescan_interval(long rescan_interval) Sets the value of field 'rescan_interval'.
void	setThreads(int threads) Sets the value of field 'threads'.
void	setUseBridgeDiscovery(boolean useBridgeDiscovery) Sets the value of field 'useBridgeDiscovery'.
void	setUseCdpDiscovery(boolean useCdpDiscovery) Sets the value of field 'useCdpDiscovery'.
void	setUseIsisDiscovery(boolean useIsisDiscovery) Sets the value of field 'useIsisDiscovery'.
void	setUseLldpDiscovery(boolean useLldpDiscovery) Sets the value of field 'useLldpDiscovery'.
void	setUseOspfDiscovery(boolean useOspfDiscovery) Sets the value of field 'useOspfDiscovery'.
static EnlinkdConfiguration	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnlinkdConfiguration

public EnlinkdConfiguration()

Method Detail

deleteInitial_sleep_time

public void deleteInitial_sleep_time()

deleteMax_bft

public void deleteMax_bft()

deleteRescan_interval

public void deleteRescan_interval()

deleteThreads

public void deleteThreads()

deleteUseBridgeDiscovery

public void deleteUseBridgeDiscovery()

deleteUseCdpDiscovery

public void deleteUseCdpDiscovery()

deleteUseIsisDiscovery

public void deleteUseIsisDiscovery()

deleteUseLldpDiscovery

public void deleteUseLldpDiscovery()

deleteUseOspfDiscovery

public void deleteUseOspfDiscovery()

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getInitial_sleep_time

public long getInitial_sleep_time()

Returns the value of field 'initial_sleep_time'. The field 'initial_sleep_time' has the following description: The initial sleep time in mill seconds before starting node Link Discovery.

Returns:

the value of field 'Initial_sleep_time'.

getMax_bft

public int getMax_bft()

Returns the value of field 'max_bft'. The field 'max_bft' has the following description: Max bridge forwarding table to hold in memory.

Returns:

the value of field 'Max_bft'.

getRescan_interval

public long getRescan_interval()

Returns the value of field 'rescan_interval'. The field 'rescan_interval' has the following description: Node Link Discovery Rescan Time interval in mill seconds.

Returns:

the value of field 'Rescan_interval'.

getThreads

public int getThreads()

Returns the value of field 'threads'. The field 'threads' has the following description: The max number of threads used for polling snmp devices and discovery links.

Returns:

the value of field 'Threads'.

getUseBridgeDiscovery

public boolean getUseBridgeDiscovery()

Returns the value of field 'useBridgeDiscovery'. The field 'useBridgeDiscovery' has the following description: Whether links discovery process should use Bridge mib data.

Returns:

the value of field 'UseBridgeDiscovery'.

getUseCdpDiscovery

public boolean getUseCdpDiscovery()

Returns the value of field 'useCdpDiscovery'. The field 'useCdpDiscovery' has the following description: Whether links discovery process should use cisco discovery protocol cache table.

Returns:

the value of field 'UseCdpDiscovery'.

getUseIsisDiscovery

public boolean getUseIsisDiscovery()

Returns the value of field 'useIsisDiscovery'. The field 'useIsisDiscovery' has the following description: Whether links discovery process should use isis mib data.

Returns:

the value of field 'UseIsisDiscovery'.

getUseLldpDiscovery

public boolean getUseLldpDiscovery()

Returns the value of field 'useLldpDiscovery'. The field 'useLldpDiscovery' has the following description: Whether links discovery process should use lldp mib data.

Returns:

the value of field 'UseLldpDiscovery'.

getUseOspfDiscovery

public boolean getUseOspfDiscovery()

Returns the value of field 'useOspfDiscovery'. The field 'useOspfDiscovery' has the following description: Whether links discovery process should use ospf mib data.

Returns:

the value of field 'UseOspfDiscovery'.

hasInitial_sleep_time

public boolean hasInitial_sleep_time()

Method hasInitial_sleep_time.

Returns:

true if at least one Initial_sleep_time has been adde

hasMax_bft

public boolean hasMax_bft()

Method hasMax_bft.

Returns:

true if at least one Max_bft has been added

hasRescan_interval

public boolean hasRescan_interval()

Method hasRescan_interval.

Returns:

true if at least one Rescan_interval has been added

hasThreads

public boolean hasThreads()

Method hasThreads.

Returns:

true if at least one Threads has been added

hasUseBridgeDiscovery

public boolean hasUseBridgeDiscovery()

Method hasUseBridgeDiscovery.

Returns:

true if at least one UseBridgeDiscovery has been adde

hasUseCdpDiscovery

public boolean hasUseCdpDiscovery()

Method hasUseCdpDiscovery.

Returns:

true if at least one UseCdpDiscovery has been added

hasUseIsisDiscovery

public boolean hasUseIsisDiscovery()

Method hasUseIsisDiscovery.

Returns:

true if at least one UseIsisDiscovery has been added

hasUseLldpDiscovery

public boolean hasUseLldpDiscovery()

Method hasUseLldpDiscovery.

Returns:

true if at least one UseLldpDiscovery has been added

hasUseOspfDiscovery

public boolean hasUseOspfDiscovery()

Method hasUseOspfDiscovery.

Returns:

true if at least one UseOspfDiscovery has been added

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isUseBridgeDiscovery

public boolean isUseBridgeDiscovery()

Returns the value of field 'useBridgeDiscovery'. The field 'useBridgeDiscovery' has the following description: Whether links discovery process should use Bridge mib data.

Returns:

the value of field 'UseBridgeDiscovery'.

isUseCdpDiscovery

public boolean isUseCdpDiscovery()

Returns the value of field 'useCdpDiscovery'. The field 'useCdpDiscovery' has the following description: Whether links discovery process should use cisco discovery protocol cache table.

Returns:

the value of field 'UseCdpDiscovery'.

isUseIsisDiscovery

public boolean isUseIsisDiscovery()

Returns the value of field 'useIsisDiscovery'. The field 'useIsisDiscovery' has the following description: Whether links discovery process should use isis mib data.

Returns:

the value of field 'UseIsisDiscovery'.

isUseLldpDiscovery

public boolean isUseLldpDiscovery()

Returns the value of field 'useLldpDiscovery'. The field 'useLldpDiscovery' has the following description: Whether links discovery process should use lldp mib data.

Returns:

the value of field 'UseLldpDiscovery'.

isUseOspfDiscovery

public boolean isUseOspfDiscovery()

Returns the value of field 'useOspfDiscovery'. The field 'useOspfDiscovery' has the following description: Whether links discovery process should use ospf mib data.

Returns:

the value of field 'UseOspfDiscovery'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setInitial_sleep_time

public void setInitial_sleep_time(long initial_sleep_time)

Sets the value of field 'initial_sleep_time'. The field 'initial_sleep_time' has the following description: The initial sleep time in mill seconds before starting node Link Discovery.

Parameters:

initial_sleep_time - the value of field 'initial_sleep_time'.

setMax_bft

public void setMax_bft(int max_bft)

Sets the value of field 'max_bft'. The field 'max_bft' has the following description: Max bridge forwarding table to hold in memory.

Parameters:

max_bft - the value of field 'max_bft'.

setRescan_interval

public void setRescan_interval(long rescan_interval)

Sets the value of field 'rescan_interval'. The field 'rescan_interval' has the following description: Node Link Discovery Rescan Time interval in mill seconds.

Parameters:

rescan_interval - the value of field 'rescan_interval'.

setThreads

public void setThreads(int threads)

Sets the value of field 'threads'. The field 'threads' has the following description: The max number of threads used for polling snmp devices and discovery links.

Parameters:

threads - the value of field 'threads'.

setUseBridgeDiscovery

public void setUseBridgeDiscovery(boolean useBridgeDiscovery)

Sets the value of field 'useBridgeDiscovery'. The field 'useBridgeDiscovery' has the following description: Whether links discovery process should use Bridge mib data.

Parameters:

useBridgeDiscovery - the value of field 'useBridgeDiscovery'.

setUseCdpDiscovery

public void setUseCdpDiscovery(boolean useCdpDiscovery)

Sets the value of field 'useCdpDiscovery'. The field 'useCdpDiscovery' has the following description: Whether links discovery process should use cisco discovery protocol cache table.

Parameters:

useCdpDiscovery - the value of field 'useCdpDiscovery'.

setUseIsisDiscovery

public void setUseIsisDiscovery(boolean useIsisDiscovery)

Sets the value of field 'useIsisDiscovery'. The field 'useIsisDiscovery' has the following description: Whether links discovery process should use isis mib data.

Parameters:

useIsisDiscovery - the value of field 'useIsisDiscovery'

setUseLldpDiscovery

public void setUseLldpDiscovery(boolean useLldpDiscovery)

Sets the value of field 'useLldpDiscovery'. The field 'useLldpDiscovery' has the following description: Whether links discovery process should use lldp mib data.

Parameters:

useLldpDiscovery - the value of field 'useLldpDiscovery'

setUseOspfDiscovery

public void setUseOspfDiscovery(boolean useOspfDiscovery)

Sets the value of field 'useOspfDiscovery'. The field 'useOspfDiscovery' has the following description: Whether links discovery process should use ospf mib data.

Parameters:

useOspfDiscovery - the value of field 'useOspfDiscovery'

unmarshal

public static EnlinkdConfiguration unmarshal(Reader reader)
                                      throws org.exolab.castor.xml.MarshalException,
                                             org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.enlinkd.EnlinkdConfiguration

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema