org.opennms.netmgt.config.capsd
Class ProtocolConfiguration

java.lang.Object
  org.opennms.netmgt.config.capsd.ProtocolConfiguration

All Implemented Interfaces:

Serializable

public class ProtocolConfiguration
extends Object
implements Serializable

IP address/range-specific protocol configuration.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ProtocolConfiguration()

Method Summary

void	addProperty(int index, Property vProperty)
void	addProperty(Property vProperty)
void	addRange(int index, Range vRange)
void	addRange(Range vRange)
void	addSpecific(int index, String vSpecific)
void	addSpecific(String vSpecific)
Enumeration<Property>	enumerateProperty() Method enumerateProperty.
Enumeration<Range>	enumerateRange() Method enumerateRange.
Enumeration<String>	enumerateSpecific() Method enumerateSpecific.
Property[]	getProperty() Method getProperty.Returns the contents of the collection in an Array.
Property	getProperty(int index) Method getProperty.
List<Property>	getPropertyCollection() Method getPropertyCollection.Returns a reference to '_propertyList'.
int	getPropertyCount() Method getPropertyCount.
Range[]	getRange() Method getRange.Returns the contents of the collection in an Array.
Range	getRange(int index) Method getRange.
List<Range>	getRangeCollection() Method getRangeCollection.Returns a reference to '_rangeList'.
int	getRangeCount() Method getRangeCount.
String	getScan() Returns the value of field 'scan'.
String[]	getSpecific() Method getSpecific.Returns the contents of the collection in an Array.
String	getSpecific(int index) Method getSpecific.
List<String>	getSpecificCollection() Method getSpecificCollection.Returns a reference to '_specificList'.
int	getSpecificCount() Method getSpecificCount.
String	getUserDefined() Returns the value of field 'userDefined'.
boolean	isValid() Method isValid.
Iterator<Property>	iterateProperty() Method iterateProperty.
Iterator<Range>	iterateRange() Method iterateRange.
Iterator<String>	iterateSpecific() Method iterateSpecific.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllProperty()
void	removeAllRange()
void	removeAllSpecific()
boolean	removeProperty(Property vProperty) Method removeProperty.
Property	removePropertyAt(int index) Method removePropertyAt.
boolean	removeRange(Range vRange) Method removeRange.
Range	removeRangeAt(int index) Method removeRangeAt.
boolean	removeSpecific(String vSpecific) Method removeSpecific.
String	removeSpecificAt(int index) Method removeSpecificAt.
void	setProperty(int index, Property vProperty)
void	setProperty(List<Property> vPropertyList) Sets the value of '_propertyList' by copying the given Vector.
void	setProperty(Property[] vPropertyArray)
void	setPropertyCollection(List<Property> propertyList) Deprecated.
void	setRange(int index, Range vRange)
void	setRange(List<Range> vRangeList) Sets the value of '_rangeList' by copying the given Vector.
void	setRange(Range[] vRangeArray)
void	setRangeCollection(List<Range> rangeList) Deprecated.
void	setScan(String scan) Sets the value of field 'scan'.
void	setSpecific(int index, String vSpecific)
void	setSpecific(List<String> vSpecificList) Sets the value of '_specificList' by copying the given Vector.
void	setSpecific(String[] vSpecificArray)
void	setSpecificCollection(List<String> specificList) Deprecated.
void	setUserDefined(String userDefined) Sets the value of field 'userDefined'.
static ProtocolConfiguration	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolConfiguration

public ProtocolConfiguration()

Method Detail

addProperty

public void addProperty(Property vProperty)
                 throws IndexOutOfBoundsException

Parameters:

vProperty -

Throws:

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

addProperty

public void addProperty(int index,
                        Property vProperty)
                 throws IndexOutOfBoundsException

Parameters:

index -

vProperty -

Throws:

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

addRange

public void addRange(Range vRange)
              throws IndexOutOfBoundsException

Parameters:

vRange -

Throws:

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

addRange

public void addRange(int index,
                     Range vRange)
              throws IndexOutOfBoundsException

Parameters:

index -

vRange -

Throws:

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

addSpecific

public void addSpecific(String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

vSpecific -

Throws:

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

addSpecific

public void addSpecific(int index,
                        String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

index -

vSpecific -

Throws:

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

enumerateProperty

public Enumeration<Property> enumerateProperty()

Method enumerateProperty.

Returns:

an Enumeration over all possible elements of this collection

enumerateRange

public Enumeration<Range> enumerateRange()

Method enumerateRange.

Returns:

an Enumeration over all possible elements of this collection

enumerateSpecific

public Enumeration<String> enumerateSpecific()

Method enumerateSpecific.

Returns:

an Enumeration over all possible elements of this collection

getProperty

public Property getProperty(int index)
                     throws IndexOutOfBoundsException

Method getProperty.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.capsd.Property at the given index

Throws:

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

getProperty

public Property[] getProperty()

Method getProperty.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

getPropertyCollection

public List<Property> getPropertyCollection()

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

Returns:

a reference to the Vector backing this class

getPropertyCount

public int getPropertyCount()

Method getPropertyCount.

Returns:

the size of this collection

getRange

public Range getRange(int index)
               throws IndexOutOfBoundsException

Method getRange.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.common.Range at the given index

Throws:

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

getRange

public Range[] getRange()

Method getRange.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

getRangeCollection

public List<Range> getRangeCollection()

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

Returns:

a reference to the Vector backing this class

getRangeCount

public int getRangeCount()

Method getRangeCount.

Returns:

the size of this collection

getScan

public String getScan()

Returns the value of field 'scan'. The field 'scan' has the following description: Controls whether this protocol is scanned by Capsd. Value of 'enable' causes the protocol to be added as supported without performing the protocol scan.

Returns:

the value of field 'Scan'.

getSpecific

public String getSpecific(int index)
                   throws IndexOutOfBoundsException

Method getSpecific.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

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

getSpecific

public String[] getSpecific()

Method getSpecific.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

getSpecificCollection

public List<String> getSpecificCollection()

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

Returns:

a reference to the Vector backing this class

getSpecificCount

public int getSpecificCount()

Method getSpecificCount.

Returns:

the size of this collection

getUserDefined

public String getUserDefined()

Returns the value of field 'userDefined'. The field 'userDefined' has the following description: Specifies if the protocol was added by the user via the UI.

Returns:

the value of field 'UserDefined'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateProperty

public Iterator<Property> iterateProperty()

Method iterateProperty.

Returns:

an Iterator over all possible elements in this collection

iterateRange

public Iterator<Range> iterateRange()

Method iterateRange.

Returns:

an Iterator over all possible elements in this collection

iterateSpecific

public Iterator<String> iterateSpecific()

Method iterateSpecific.

Returns:

an Iterator over all possible elements in this collection

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

removeAllProperty

public void removeAllProperty()

removeAllRange

public void removeAllRange()

removeAllSpecific

public void removeAllSpecific()

removeProperty

public boolean removeProperty(Property vProperty)

Method removeProperty.

Parameters:

vProperty -

Returns:

true if the object was removed from the collection.

removePropertyAt

public Property removePropertyAt(int index)

Method removePropertyAt.

Parameters:

index -

Returns:

the element removed from the collection

removeRange

public boolean removeRange(Range vRange)

Method removeRange.

Parameters:

vRange -

Returns:

true if the object was removed from the collection.

removeRangeAt

public Range removeRangeAt(int index)

Method removeRangeAt.

Parameters:

index -

Returns:

the element removed from the collection

removeSpecific

public boolean removeSpecific(String vSpecific)

Method removeSpecific.

Parameters:

vSpecific -

Returns:

true if the object was removed from the collection.

removeSpecificAt

public String removeSpecificAt(int index)

Method removeSpecificAt.

Parameters:

index -

Returns:

the element removed from the collection

setProperty

public void setProperty(int index,
                        Property vProperty)
                 throws IndexOutOfBoundsException

Parameters:

index -

vProperty -

Throws:

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

setProperty

public void setProperty(Property[] vPropertyArray)

Parameters:

vPropertyArray -

setProperty

public void setProperty(List<Property> vPropertyList)

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

Parameters:

vPropertyList - the Vector to copy.

setPropertyCollection

public void setPropertyCollection(List<Property> propertyList)

Deprecated.

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

Parameters:

propertyList - the Vector to set.

setRange

public void setRange(int index,
                     Range vRange)
              throws IndexOutOfBoundsException

Parameters:

index -

vRange -

Throws:

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

setRange

public void setRange(Range[] vRangeArray)

Parameters:

vRangeArray -

setRange

public void setRange(List<Range> vRangeList)

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

Parameters:

vRangeList - the Vector to copy.

setRangeCollection

public void setRangeCollection(List<Range> rangeList)

Deprecated.

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

Parameters:

rangeList - the Vector to set.

setScan

public void setScan(String scan)

Sets the value of field 'scan'. The field 'scan' has the following description: Controls whether this protocol is scanned by Capsd. Value of 'enable' causes the protocol to be added as supported without performing the protocol scan.

Parameters:

scan - the value of field 'scan'.

setSpecific

public void setSpecific(int index,
                        String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

index -

vSpecific -

Throws:

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

setSpecific

public void setSpecific(String[] vSpecificArray)

Parameters:

vSpecificArray -

setSpecific

public void setSpecific(List<String> vSpecificList)

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

Parameters:

vSpecificList - the Vector to copy.

setSpecificCollection

public void setSpecificCollection(List<String> specificList)

Deprecated.

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

Parameters:

specificList - the Vector to set.

setUserDefined

public void setUserDefined(String userDefined)

Sets the value of field 'userDefined'. The field 'userDefined' has the following description: Specifies if the protocol was added by the user via the UI.

Parameters:

userDefined - the value of field 'userDefined'.

unmarshal

public static ProtocolConfiguration 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.capsd.ProtocolConfiguration

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