org.opennms.netmgt.config.datacollection

Class SnmpCollection

java.lang.Object

org.opennms.netmgt.config.datacollection.SnmpCollection

All Implemented Interfaces:

Serializable

public class SnmpCollection
extends Object
implements Serializable

a grouping of SNMP related RRD parms, MIB object groups and sysoid based system definitions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SnmpCollection()

Method Summary

Methods

Modifier and Type	Method and Description
void	addIncludeCollection(IncludeCollection includeCollection)
void	addIncludeCollection(int index, IncludeCollection includeCollection)
void	addResourceType(int index, ResourceType resourceType)
void	addResourceType(ResourceType resourceType)
void	deleteMaxVarsPerPdu()
Enumeration<IncludeCollection>	enumerateIncludeCollection() Method enumerateIncludeCollection.
Enumeration<ResourceType>	enumerateResourceType() Method enumerateResourceType.
boolean	equals(Object obj) Overrides the Object.equals method.
Groups	getGroups() Returns the value of field 'groups'.
IncludeCollection[]	getIncludeCollection() Method getIncludeCollection.Returns the contents of the collection in an Array.
IncludeCollection	getIncludeCollection(int index) Method getIncludeCollection.
List<IncludeCollection>	getIncludeCollectionCollection() Method getIncludeCollectionCollection.Returns a reference to '_includeCollectionList'.
int	getIncludeCollectionCount() Method getIncludeCollectionCount.
Integer	getMaxVarsPerPdu() Returns the value of field 'maxVarsPerPdu'.
String	getName() Returns the value of field 'name'.
ResourceType[]	getResourceType() Method getResourceType.Returns the contents of the collection in an Array.
ResourceType	getResourceType(int index) Method getResourceType.
List<ResourceType>	getResourceTypeCollection() Method getResourceTypeCollection.Returns a reference to '_resourceTypeList'.
int	getResourceTypeCount() Method getResourceTypeCount.
Rrd	getRrd() Returns the value of field 'rrd'.
String	getSnmpStorageFlag() Returns the value of field 'snmpStorageFlag'.
Systems	getSystems() Returns the value of field 'systems'.
int	hashCode() Overrides the Object.hashCode method.
boolean	hasMaxVarsPerPdu() Method hasMaxVarsPerPdu.
boolean	isValid() Deprecated.
Iterator<IncludeCollection>	iterateIncludeCollection() Method iterateIncludeCollection.
Iterator<ResourceType>	iterateResourceType() Method iterateResourceType.
void	marshal(ContentHandler handler) Deprecated.
void	marshal(Writer out) Deprecated.
void	removeAllIncludeCollection()
void	removeAllResourceType()
boolean	removeIncludeCollection(IncludeCollection includeCollection) Method removeIncludeCollection.
IncludeCollection	removeIncludeCollectionAt(int index) Method removeIncludeCollectionAt.
boolean	removeResourceType(ResourceType resourceType) Method removeResourceType.
ResourceType	removeResourceTypeAt(int index) Method removeResourceTypeAt.
void	setGroups(Groups groups) Sets the value of field 'groups'.
void	setIncludeCollection(IncludeCollection[] includeCollections)
void	setIncludeCollection(int index, IncludeCollection includeCollection)
void	setIncludeCollection(List<IncludeCollection> includeCollections) Sets the value of '_includeCollectionList' by copying the given Vector.
void	setIncludeCollectionCollection(List<IncludeCollection> includeCollections) Deprecated.
void	setMaxVarsPerPdu(Integer maxVarsPerPdu) Sets the value of field 'maxVarsPerPdu'.
void	setName(String name) Sets the value of field 'name'.
void	setResourceType(int index, ResourceType resourceType)
void	setResourceType(List<ResourceType> resourceTypes) Sets the value of '_resourceTypeList' by copying the given Vector.
void	setResourceType(ResourceType[] resourceTypes)
void	setResourceTypeCollection(List<ResourceType> resourceTypes) Deprecated.
void	setRrd(Rrd rrd) Sets the value of field 'rrd'.
void	setSnmpStorageFlag(String snmpStorageFlag) Sets the value of field 'snmpStorageFlag'.
void	setSystems(Systems systems) Sets the value of field 'systems'.
static SnmpCollection	unmarshal(Reader reader) Deprecated.
void	validate() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpCollection

public SnmpCollection()

Method Detail

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: collector name

Returns:

the value of field 'Name'.

getMaxVarsPerPdu

public Integer getMaxVarsPerPdu()

Returns the value of field 'maxVarsPerPdu'. The field 'maxVarsPerPdu' has the following description: DEPRECATED

Returns:

the value of field 'MaxVarsPerPdu'.

getSnmpStorageFlag

public String getSnmpStorageFlag()

Returns the value of field 'snmpStorageFlag'. The field 'snmpStorageFlag' has the following description: indicates if collected SNMP data is to be stored for "all" interfaces or only for the "primary" interface.

Returns:

the value of field 'SnmpStorageFlag'.

getRrd

public Rrd getRrd()

Returns the value of field 'rrd'. The field 'rrd' has the following description: RRD parms

Returns:

the value of field 'Rrd'.

getIncludeCollection

public IncludeCollection[] getIncludeCollection()

Method getIncludeCollection.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getResourceType

public ResourceType[] getResourceType()

Method getResourceType.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getGroups

public Groups getGroups()

Returns the value of field 'groups'. The field 'groups' has the following description: MIB object groups

Returns:

the value of field 'Groups'.

getSystems

public Systems getSystems()

Returns the value of field 'systems'. The field 'systems' has the following description: sysOid-based sytems

Returns:

the value of field 'Systems'.

addIncludeCollection

public void addIncludeCollection(IncludeCollection includeCollection)
                          throws IndexOutOfBoundsException

Parameters:

includeCollection -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addIncludeCollection

public void addIncludeCollection(int index,
                        IncludeCollection includeCollection)
                          throws IndexOutOfBoundsException

Parameters:

index -

includeCollection -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addResourceType

public void addResourceType(ResourceType resourceType)
                     throws IndexOutOfBoundsException

Parameters:

resourceType -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addResourceType

public void addResourceType(int index,
                   ResourceType resourceType)
                     throws IndexOutOfBoundsException

Parameters:

index -

resourceType -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

deleteMaxVarsPerPdu

public void deleteMaxVarsPerPdu()

enumerateIncludeCollection

public Enumeration<IncludeCollection> enumerateIncludeCollection()

Method enumerateIncludeCollection.

Returns:

an Enumeration over all possible elements of this collection

enumerateResourceType

public Enumeration<ResourceType> enumerateResourceType()

Method enumerateResourceType.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getIncludeCollection

public IncludeCollection getIncludeCollection(int index)
                                       throws IndexOutOfBoundsException

Method getIncludeCollection.

Parameters:

index -

Returns:

the value of the IncludeCollection at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getIncludeCollectionCollection

public List<IncludeCollection> getIncludeCollectionCollection()

Method getIncludeCollectionCollection.Returns a reference to '_includeCollectionList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getIncludeCollectionCount

public int getIncludeCollectionCount()

Method getIncludeCollectionCount.

Returns:

the size of this collection

getResourceType

public ResourceType getResourceType(int index)
                             throws IndexOutOfBoundsException

Method getResourceType.

Parameters:

index -

Returns:

the value of the types.ResourceType at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getResourceTypeCollection

public List<ResourceType> getResourceTypeCollection()

Method getResourceTypeCollection.Returns a reference to '_resourceTypeList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getResourceTypeCount

public int getResourceTypeCount()

Method getResourceTypeCount.

Returns:

the size of this collection

hasMaxVarsPerPdu

public boolean hasMaxVarsPerPdu()

Method hasMaxVarsPerPdu.

Returns:

true if at least one MaxVarsPerPdu has been added

hashCode

public int hashCode()

Overrides the 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.

isValid

@Deprecated
public boolean isValid()

Deprecated.

Method isValid.

Returns:

true if this object is valid according to the schema

iterateIncludeCollection

public Iterator<IncludeCollection> iterateIncludeCollection()

Method iterateIncludeCollection.

Returns:

an Iterator over all possible elements in this collection

iterateResourceType

public Iterator<ResourceType> iterateResourceType()

Method iterateResourceType.

Returns:

an Iterator over all possible elements in this collection

marshal

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

Deprecated.

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

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

Deprecated.

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

removeAllIncludeCollection

public void removeAllIncludeCollection()

removeAllResourceType

public void removeAllResourceType()

removeIncludeCollection

public boolean removeIncludeCollection(IncludeCollection includeCollection)

Method removeIncludeCollection.

Parameters:

includeCollection -

Returns:

true if the object was removed from the collection.

removeIncludeCollectionAt

public IncludeCollection removeIncludeCollectionAt(int index)

Method removeIncludeCollectionAt.

Parameters:

index -

Returns:

the element removed from the collection

removeResourceType

public boolean removeResourceType(ResourceType resourceType)

Method removeResourceType.

Parameters:

resourceType -

Returns:

true if the object was removed from the collection.

removeResourceTypeAt

public ResourceType removeResourceTypeAt(int index)

Method removeResourceTypeAt.

Parameters:

index -

Returns:

the element removed from the collection

setGroups

public void setGroups(Groups groups)

Sets the value of field 'groups'. The field 'groups' has the following description: MIB object groups

Parameters:

groups - the value of field 'groups'.

setIncludeCollection

public void setIncludeCollection(int index,
                        IncludeCollection includeCollection)
                          throws IndexOutOfBoundsException

Parameters:

index -

includeCollection -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setIncludeCollection

public void setIncludeCollection(IncludeCollection[] includeCollections)

Parameters:

includeCollections -

setIncludeCollection

public void setIncludeCollection(List<IncludeCollection> includeCollections)

Sets the value of '_includeCollectionList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

includeCollections - the Vector to copy.

setIncludeCollectionCollection

public void setIncludeCollectionCollection(List<IncludeCollection> includeCollections)

Deprecated.

Sets the value of '_includeCollectionList' by setting it to the given Vector. No type checking is performed.

Parameters:

includeCollections - the Vector to set.

setMaxVarsPerPdu

public void setMaxVarsPerPdu(Integer maxVarsPerPdu)

Sets the value of field 'maxVarsPerPdu'. The field 'maxVarsPerPdu' has the following description: DEPRECATED

Parameters:

maxVarsPerPdu - the value of field 'maxVarsPerPdu'.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: collector name

Parameters:

name - the value of field 'name'.

setResourceType

public void setResourceType(int index,
                   ResourceType resourceType)
                     throws IndexOutOfBoundsException

Parameters:

index -

resourceType -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setResourceType

public void setResourceType(ResourceType[] resourceTypes)

Parameters:

resourceTypes -

setResourceType

public void setResourceType(List<ResourceType> resourceTypes)

Sets the value of '_resourceTypeList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

resourceTypes - the Vector to copy.

setResourceTypeCollection

public void setResourceTypeCollection(List<ResourceType> resourceTypes)

Deprecated.

Sets the value of '_resourceTypeList' by setting it to the given Vector. No type checking is performed.

Parameters:

resourceTypes - the Vector to set.

setRrd

public void setRrd(Rrd rrd)

Sets the value of field 'rrd'. The field 'rrd' has the following description: RRD parms

Parameters:

rrd - the value of field 'rrd'.

setSnmpStorageFlag

public void setSnmpStorageFlag(String snmpStorageFlag)

Sets the value of field 'snmpStorageFlag'. The field 'snmpStorageFlag' has the following description: indicates if collected SNMP data is to be stored for "all" interfaces or only for the "primary" interface.

Parameters:

snmpStorageFlag - the value of field 'snmpStorageFlag'.

setSystems

public void setSystems(Systems systems)

Sets the value of field 'systems'. The field 'systems' has the following description: sysOid-based sytems

Parameters:

systems - the value of field 'systems'.

unmarshal

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

Deprecated.

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled SnmpCollection

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

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

Deprecated.

Throws:

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