org.opennms.netmgt.config.capsd
Class IpManagement

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

All Implemented Interfaces:

Serializable

public class IpManagement
extends Object
implements Serializable

IP Management. Overrides default IP management policy for the specified set of IP addresses

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

IpManagement()

Method Summary

void	addIncludeUrl(int index, String vIncludeUrl)
void	addIncludeUrl(String vIncludeUrl)
void	addRange(int index, Range vRange)
void	addRange(Range vRange)
void	addSpecific(int index, String vSpecific)
void	addSpecific(String vSpecific)
Enumeration<String>	enumerateIncludeUrl() Method enumerateIncludeUrl.
Enumeration<Range>	enumerateRange() Method enumerateRange.
Enumeration<String>	enumerateSpecific() Method enumerateSpecific.
String[]	getIncludeUrl() Method getIncludeUrl.Returns the contents of the collection in an Array.
String	getIncludeUrl(int index) Method getIncludeUrl.
List<String>	getIncludeUrlCollection() Method getIncludeUrlCollection.Returns a reference to '_includeUrlList'.
int	getIncludeUrlCount() Method getIncludeUrlCount.
String	getPolicy() Returns the value of field 'policy'.
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[]	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.
boolean	isValid() Method isValid.
Iterator<String>	iterateIncludeUrl() Method iterateIncludeUrl.
Iterator<Range>	iterateRange() Method iterateRange.
Iterator<String>	iterateSpecific() Method iterateSpecific.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllIncludeUrl()
void	removeAllRange()
void	removeAllSpecific()
boolean	removeIncludeUrl(String vIncludeUrl) Method removeIncludeUrl.
String	removeIncludeUrlAt(int index) Method removeIncludeUrlAt.
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	setIncludeUrl(int index, String vIncludeUrl)
void	setIncludeUrl(List<String> vIncludeUrlList) Sets the value of '_includeUrlList' by copying the given Vector.
void	setIncludeUrl(String[] vIncludeUrlArray)
void	setIncludeUrlCollection(List<String> includeUrlList) Deprecated.
void	setPolicy(String policy) Sets the value of field 'policy'.
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	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.
static IpManagement	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

IpManagement

public IpManagement()

Method Detail

addIncludeUrl

public void addIncludeUrl(String vIncludeUrl)
                   throws IndexOutOfBoundsException

Parameters:

vIncludeUrl -

Throws:

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

addIncludeUrl

public void addIncludeUrl(int index,
                          String vIncludeUrl)
                   throws IndexOutOfBoundsException

Parameters:

index -

vIncludeUrl -

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

enumerateIncludeUrl

public Enumeration<String> enumerateIncludeUrl()

Method enumerateIncludeUrl.

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

getIncludeUrl

public String getIncludeUrl(int index)
                     throws IndexOutOfBoundsException

Method getIncludeUrl.

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

getIncludeUrl

public String[] getIncludeUrl()

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

getIncludeUrlCollection

public List<String> getIncludeUrlCollection()

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

Returns:

a reference to the Vector backing this class

getIncludeUrlCount

public int getIncludeUrlCount()

Method getIncludeUrlCount.

Returns:

the size of this collection

getPolicy

public String getPolicy()

Returns the value of field 'policy'. The field 'policy' has the following description: Management policy

Returns:

the value of field 'Policy'.

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

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

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateIncludeUrl

public Iterator<String> iterateIncludeUrl()

Method iterateIncludeUrl.

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

removeAllIncludeUrl

public void removeAllIncludeUrl()

removeAllRange

public void removeAllRange()

removeAllSpecific

public void removeAllSpecific()

removeIncludeUrl

public boolean removeIncludeUrl(String vIncludeUrl)

Method removeIncludeUrl.

Parameters:

vIncludeUrl -

Returns:

true if the object was removed from the collection.

removeIncludeUrlAt

public String removeIncludeUrlAt(int index)

Method removeIncludeUrlAt.

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

setIncludeUrl

public void setIncludeUrl(int index,
                          String vIncludeUrl)
                   throws IndexOutOfBoundsException

Parameters:

index -

vIncludeUrl -

Throws:

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

setIncludeUrl

public void setIncludeUrl(String[] vIncludeUrlArray)

Parameters:

vIncludeUrlArray -

setIncludeUrl

public void setIncludeUrl(List<String> vIncludeUrlList)

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

Parameters:

vIncludeUrlList - the Vector to copy.

setIncludeUrlCollection

public void setIncludeUrlCollection(List<String> includeUrlList)

Deprecated.

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

Parameters:

includeUrlList - the Vector to set.

setPolicy

public void setPolicy(String policy)

Sets the value of field 'policy'. The field 'policy' has the following description: Management policy

Parameters:

policy - the value of field 'policy'.

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.

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.

unmarshal

public static IpManagement 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.IpManagement

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