Definition (OpenNMS 18.0.3 API)

java.lang.Object
- org.opennms.netmgt.config.ami.Definition

All Implemented Interfaces:

Serializable
```
public class Definition
extends Object
implements Serializable
```
Provides a mechanism for associating one or more specific IP addresses and/or IP address ranges with a set of AMI parms which will be used in place of the default values during AMI operations.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Definition()`
`Definition(int port, boolean useSsl, int timeout, int retry, String username, String password, List<Range> ranges, List<String> specifics, List<String> ipMatches)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addIpMatch(int index, String vIpMatch)`
`void`	`addIpMatch(String vIpMatch)`
`void`	`addRange(int index, Range vRange)`
`void`	`addRange(Range vRange)`
`void`	`addSpecific(int index, String vSpecific)`
`void`	`addSpecific(String vSpecific)`
`Enumeration<String>`	`enumerateIpMatch()` Method enumerateIpMatch.
`Enumeration<Range>`	`enumerateRange()` Method enumerateRange.
`Enumeration<String>`	`enumerateSpecific()` Method enumerateSpecific.
`boolean`	`equals(Object obj)` Overrides the Object.equals method.
`String[]`	`getIpMatch()` Method getIpMatch.Returns the contents of the collection in an Array.
`String`	`getIpMatch(int index)` Method getIpMatch.
`List<String>`	`getIpMatchCollection()` Method getIpMatchCollection.Returns a reference to '_ipMatchList'.
`Integer`	`getIpMatchCount()` Method getIpMatchCount.
`String`	`getPassword()` Returns the value of field 'password'.
`Integer`	`getPort()` Returns the value of field 'port'.
`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'.
`Integer`	`getRangeCount()` Method getRangeCount.
`Integer`	`getRetry()` Returns the value of field 'retry'.
`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'.
`Integer`	`getSpecificCount()` Method getSpecificCount.
`Integer`	`getTimeout()` Returns the value of field 'timeout'.
`String`	`getUsername()` Returns the value of field 'username'.
`boolean`	`getUseSsl()` Returns the value of field 'useSsl'.
`int`	`hashCode()` Overrides the Object.hashCode method.
`boolean`	`hasPort()` Method hasPort.
`boolean`	`hasRetry()` Method hasRetry.
`boolean`	`hasTimeout()` Method hasTimeout.
`boolean`	`hasUseSsl()` Method hasUseSsl.
`boolean`	`isUseSsl()` Returns the value of field 'useSsl'.
`Iterator<String>`	`iterateIpMatch()` Method iterateIpMatch.
`Iterator<Range>`	`iterateRange()` Method iterateRange.
`Iterator<String>`	`iterateSpecific()` Method iterateSpecific.
`void`	`removeAllIpMatch()`
`void`	`removeAllRange()`
`void`	`removeAllSpecific()`
`boolean`	`removeIpMatch(String vIpMatch)` Method removeIpMatch.
`String`	`removeIpMatchAt(int index)` Method removeIpMatchAt.
`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`	`setIpMatch(int index, String vIpMatch)`
`void`	`setIpMatch(List<String> vIpMatchList)` Sets the value of '_ipMatchList' by copying the given Vector.
`void`	`setIpMatch(String[] vIpMatchArray)`
`void`	`setPassword(String password)` Sets the value of field 'password'.
`void`	`setPort(int port)` Sets the value of field 'port'.
`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`	`setRetry(int retry)` Sets the value of field 'retry'.
`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`	`setTimeout(int timeout)` Sets the value of field 'timeout'.
`void`	`setUsername(String username)` Sets the value of field 'username'.
`void`	`setUseSsl(boolean useSsl)` Sets the value of field 'useSsl'.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Definition
```
public Definition()
```
  - Definition
```
public Definition(int port,
                  boolean useSsl,
                  int timeout,
                  int retry,
                  String username,
                  String password,
                  List<Range> ranges,
                  List<String> specifics,
                  List<String> ipMatches)
```
- Method Detail
  - addIpMatch
```
public void addIpMatch(String vIpMatch)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    vIpMatch -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addIpMatch
```
public void addIpMatch(int index,
                       String vIpMatch)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vIpMatch -
    
    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
  - enumerateIpMatch
```
public Enumeration<String> enumerateIpMatch()
```
    Method enumerateIpMatch.
    
    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
  - 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.
  - getIpMatch
```
public String getIpMatch(int index)
                  throws IndexOutOfBoundsException
```
    Method getIpMatch.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the String at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getIpMatch
```
public String[] getIpMatch()
```
    Method getIpMatch.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
  - getIpMatchCollection
```
public List<String> getIpMatchCollection()
```
    Method getIpMatchCollection.Returns a reference to '_ipMatchList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getIpMatchCount
```
public Integer getIpMatchCount()
```
    Method getIpMatchCount.
    
    Returns:
    
    the size of this collection
  - getPassword
```
public String getPassword()
```
    Returns the value of field 'password'.
    
    Returns:
    
    the value of field 'Password'.
  - getPort
```
public Integer getPort()
```
    Returns the value of field 'port'.
    
    Returns:
    
    the value of field 'Port'.
  - getRange
```
public Range getRange(int index)
               throws IndexOutOfBoundsException
```
    Method getRange.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the 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 Integer getRangeCount()
```
    Method getRangeCount.
    
    Returns:
    
    the size of this collection
  - getRetry
```
public Integer getRetry()
```
    Returns the value of field 'retry'.
    
    Returns:
    
    the value of field 'Retry'.
  - getSpecific
```
public String getSpecific(int index)
                   throws IndexOutOfBoundsException
```
    Method getSpecific.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the 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 Integer getSpecificCount()
```
    Method getSpecificCount.
    
    Returns:
    
    the size of this collection
  - getTimeout
```
public Integer getTimeout()
```
    Returns the value of field 'timeout'.
    
    Returns:
    
    the value of field 'Timeout'.
  - getUseSsl
```
public boolean getUseSsl()
```
    Returns the value of field 'useSsl'.
    
    Returns:
    
    the value of field 'UseSsl'.
  - getUsername
```
public String getUsername()
```
    Returns the value of field 'username'.
    
    Returns:
    
    the value of field 'Username'.
  - hasPort
```
public boolean hasPort()
```
    Method hasPort.
    
    Returns:
    
    true if at least one Port has been added
  - hasRetry
```
public boolean hasRetry()
```
    Method hasRetry.
    
    Returns:
    
    true if at least one Retry has been added
  - hasTimeout
```
public boolean hasTimeout()
```
    Method hasTimeout.
    
    Returns:
    
    true if at least one Timeout has been added
  - hasUseSsl
```
public boolean hasUseSsl()
```
    Method hasUseSsl.
    
    Returns:
    
    true if at least one UseSsl 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.
  - isUseSsl
```
public boolean isUseSsl()
```
    Returns the value of field 'useSsl'.
    
    Returns:
    
    the value of field 'UseSsl'.
  - iterateIpMatch
```
public Iterator<String> iterateIpMatch()
```
    Method iterateIpMatch.
    
    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
  - removeAllIpMatch
```
public void removeAllIpMatch()
```
  - removeAllRange
```
public void removeAllRange()
```
  - removeAllSpecific
```
public void removeAllSpecific()
```
  - removeIpMatch
```
public boolean removeIpMatch(String vIpMatch)
```
    Method removeIpMatch.
    
    Parameters:
    
    vIpMatch -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeIpMatchAt
```
public String removeIpMatchAt(int index)
```
    Method removeIpMatchAt.
    
    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
  - setIpMatch
```
public void setIpMatch(int index,
                       String vIpMatch)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vIpMatch -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setIpMatch
```
public void setIpMatch(String[] vIpMatchArray)
```
    Parameters:
    
    vIpMatchArray -
  - setIpMatch
```
public void setIpMatch(List<String> vIpMatchList)
```
    Sets the value of '_ipMatchList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vIpMatchList - the Vector to copy.
  - setPassword
```
public void setPassword(String password)
```
    Sets the value of field 'password'.
    
    Parameters:
    
    password - the value of field 'password'.
  - setPort
```
public void setPort(int port)
```
    Sets the value of field 'port'.
    
    Parameters:
    
    port - the value of field 'port'.
  - 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.
  - setRetry
```
public void setRetry(int retry)
```
    Sets the value of field 'retry'.
    
    Parameters:
    
    retry - the value of field 'retry'.
  - 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.
  - setTimeout
```
public void setTimeout(int timeout)
```
    Sets the value of field 'timeout'.
    
    Parameters:
    
    timeout - the value of field 'timeout'.
  - setUseSsl
```
public void setUseSsl(boolean useSsl)
```
    Sets the value of field 'useSsl'.
    
    Parameters:
    
    useSsl - the value of field 'useSsl'.
  - setUsername
```
public void setUsername(String username)
```
    Sets the value of field 'username'.
    
    Parameters:
    
    username - the value of field 'username'.

Class Definition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Definition

Definition

Method Detail

addIpMatch

addIpMatch

addRange

addRange

addSpecific

addSpecific

enumerateIpMatch

enumerateRange

enumerateSpecific

equals

getIpMatch

getIpMatch

getIpMatchCollection

getIpMatchCount

getPassword

getPort

getRange

getRange

getRangeCollection

getRangeCount

getRetry

getSpecific

getSpecific

getSpecificCollection

getSpecificCount

getTimeout

getUseSsl

getUsername

hasPort

hasRetry

hasTimeout

hasUseSsl

hashCode

isUseSsl

iterateIpMatch

iterateRange

iterateSpecific

removeAllIpMatch

removeAllRange

removeAllSpecific

removeIpMatch

removeIpMatchAt

removeRange

removeRangeAt

removeSpecific

removeSpecificAt

setIpMatch

setIpMatch

setIpMatch

setPassword

setPort

setRange

setRange

setRange

setRetry

setSpecific

setSpecific

setSpecific

setTimeout

setUseSsl

setUsername