RancidConfiguration (OpenNMS 19.1.0 API)

java.lang.Object
- org.opennms.netmgt.config.rancid.adapter.RancidConfiguration

All Implemented Interfaces:

Serializable
```
public class RancidConfiguration
extends Object
implements Serializable
```
Top-level element for the rancid-configuration.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RancidConfiguration()

Constructors
Constructor and Description
`RancidConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addMapping(int index, Mapping vMapping)`
`void`	`addMapping(Mapping vMapping)`
`void`	`deleteDelay()`
`void`	`deleteRetries()`
`void`	`deleteUseCategories()`
`Enumeration<Mapping>`	`enumerateMapping()` Method enumerateMapping.
`boolean`	`equals(Object obj)` Overrides the Object.equals method.
`String`	`getDefaultType()` Returns the value of field 'defaultType'.
`Long`	`getDelay()` Returns the value of field 'delay'.
`Mapping[]`	`getMapping()` Method getMapping.Returns the contents of the collection in an Array.
`Mapping`	`getMapping(int index)` Method getMapping.
`List<Mapping>`	`getMappingCollection()` Method getMappingCollection.Returns a reference to 'mappingList'.
`int`	`getMappingCount()` Method getMappingCount.
`Policies`	`getPolicies()` Returns the value of field 'policies'.
`Integer`	`getRetries()` Returns the value of field 'retries'.
`Boolean`	`getUseCategories()` Returns the value of field 'useCategories'.
`boolean`	`hasDelay()` Method hasDelay.
`int`	`hashCode()` Method hashCode.
`boolean`	`hasRetries()` Method hasRetries.
`boolean`	`hasUseCategories()` Method hasUseCategories.
`Boolean`	`isUseCategories()` Returns the value of field 'useCategories'.
`Iterator<Mapping>`	`iterateMapping()` Method iterateMapping.
`void`	`removeAllMapping()`
`boolean`	`removeMapping(Mapping vMapping)` Method removeMapping.
`Mapping`	`removeMappingAt(int index)` Method removeMappingAt.
`void`	`setDefaultType(String defaultType)` Sets the value of field 'defaultType'.
`void`	`setDelay(Long delay)` Sets the value of field 'delay'.
`void`	`setMapping(int index, Mapping vMapping)`
`void`	`setMapping(List<Mapping> vMappingList)` Sets the value of 'mappingList' by copying the given Vector.
`void`	`setMapping(Mapping[] vMappingArray)`
`void`	`setMappingCollection(List<Mapping> mappingList)` Deprecated.
`void`	`setPolicies(Policies policies)` Sets the value of field 'policies'.
`void`	`setRetries(Integer retries)` Sets the value of field 'retries'.
`void`	`setUseCategories(Boolean useCategories)` Sets the value of field 'useCategories'.

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

- Constructor Detail
  - RancidConfiguration
```
public RancidConfiguration()
```
- Method Detail
  - addMapping
```
public void addMapping(Mapping vMapping)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    vMapping -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addMapping
```
public void addMapping(int index,
                       Mapping vMapping)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vMapping -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - deleteDelay
```
public void deleteDelay()
```
  - deleteRetries
```
public void deleteRetries()
```
  - deleteUseCategories
```
public void deleteUseCategories()
```
  - enumerateMapping
```
public Enumeration<Mapping> enumerateMapping()
```
    Method enumerateMapping.
    
    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.
  - getDefaultType
```
public String getDefaultType()
```
    Returns the value of field 'defaultType'. The field 'defaultType' has the following description: The Default Rancid type, it is used when no device type for provisioned node is found.
    
    Returns:
    
    the value of field 'DefaultType'.
  - getDelay
```
public Long getDelay()
```
    Returns the value of field 'delay'. The field 'delay' has the following description: The time in sec to wait before trying to set the download flag to up in router.db. If schedule is there then it is verified if you are able to write to router.db in rancid. Otherwise you wait until schedule let you write on rancid.
    
    Returns:
    
    the value of field 'Delay'.
  - getMapping
```
public Mapping getMapping(int index)
                   throws IndexOutOfBoundsException
```
    Method getMapping.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the Mapping at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getMapping
```
public Mapping[] getMapping()
```
    Method getMapping.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
  - getMappingCollection
```
public List<Mapping> getMappingCollection()
```
    Method getMappingCollection.Returns a reference to 'mappingList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getMappingCount
```
public int getMappingCount()
```
    Method getMappingCount.
    
    Returns:
    
    the size of this collection
  - getPolicies
```
public Policies getPolicies()
```
    Returns the value of field 'policies'. The field 'policies' has the following description: Configuration of Policy functionality
    
    Returns:
    
    the value of field 'Policies'.
  - getRetries
```
public Integer getRetries()
```
    Returns the value of field 'retries'. The field 'retries' has the following description: The maximum number of retry before sending a failure.
    
    Returns:
    
    the value of field 'Retries'.
  - getUseCategories
```
public Boolean getUseCategories()
```
    Returns the value of field 'useCategories'. The field 'useCategories' has the following description: If you want to use opennms categories to match rancid device type.
    
    Returns:
    
    the value of field 'UseCategories'.
  - hasDelay
```
public boolean hasDelay()
```
    Method hasDelay.
    
    Returns:
    
    true if at least one Delay has been added
  - hasRetries
```
public boolean hasRetries()
```
    Method hasRetries.
    
    Returns:
    
    true if at least one Retries has been added
  - hasUseCategories
```
public boolean hasUseCategories()
```
    Method hasUseCategories.
    
    Returns:
    
    true if at least one UseCategories has been added
  - hashCode
```
public int hashCode()
```
    Method hashCode.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for the object.
  - isUseCategories
```
public Boolean isUseCategories()
```
    Returns the value of field 'useCategories'. The field 'useCategories' has the following description: If you want to use opennms categories to match rancid device type.
    
    Returns:
    
    the value of field 'UseCategories'.
  - iterateMapping
```
public Iterator<Mapping> iterateMapping()
```
    Method iterateMapping.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - removeAllMapping
```
public void removeAllMapping()
```
  - removeMapping
```
public boolean removeMapping(Mapping vMapping)
```
    Method removeMapping.
    
    Parameters:
    
    vMapping -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeMappingAt
```
public Mapping removeMappingAt(int index)
```
    Method removeMappingAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setDefaultType
```
public void setDefaultType(String defaultType)
```
    Sets the value of field 'defaultType'. The field 'defaultType' has the following description: The Default Rancid type, it is used when no device type for provisioned node is found.
    
    Parameters:
    
    defaultType - the value of field 'defaultType'.
  - setDelay
```
public void setDelay(Long delay)
```
    Sets the value of field 'delay'. The field 'delay' has the following description: The time in sec to wait before trying to set the download flag to up in router.db. If schedule is there then it is verified if you are able to write to router.db in rancid. Otherwise you wait until schedule let you write on rancid.
    
    Parameters:
    
    delay - the value of field 'delay'.
  - setMapping
```
public void setMapping(int index,
                       Mapping vMapping)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vMapping -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setMapping
```
public void setMapping(Mapping[] vMappingArray)
```
    Parameters:
    
    vMappingArray -
  - setMapping
```
public void setMapping(List<Mapping> vMappingList)
```
    Sets the value of 'mappingList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vMappingList - the Vector to copy.
  - setMappingCollection
```
public void setMappingCollection(List<Mapping> mappingList)
```
    Deprecated.
    
    Sets the value of 'mappingList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    mappingList - the Vector to set.
  - setPolicies
```
public void setPolicies(Policies policies)
```
    Sets the value of field 'policies'. The field 'policies' has the following description: Configuration of Policy functionality
    
    Parameters:
    
    policies - the value of field 'policies'.
  - setRetries
```
public void setRetries(Integer retries)
```
    Sets the value of field 'retries'. The field 'retries' has the following description: The maximum number of retry before sending a failure.
    
    Parameters:
    
    retries - the value of field 'retries'.
  - setUseCategories
```
public void setUseCategories(Boolean useCategories)
```
    Sets the value of field 'useCategories'. The field 'useCategories' has the following description: If you want to use opennms categories to match rancid device type.
    
    Parameters:
    
    useCategories - the value of field 'useCategories'.

Class RancidConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RancidConfiguration

Method Detail

addMapping

addMapping

deleteDelay

deleteRetries

deleteUseCategories

enumerateMapping

equals

getDefaultType

getDelay

getMapping

getMapping

getMappingCollection

getMappingCount

getPolicies

getRetries

getUseCategories

hasDelay

hasRetries

hasUseCategories

hashCode

isUseCategories

iterateMapping

removeAllMapping

removeMapping

removeMappingAt

setDefaultType

setDelay

setMapping

setMapping

setMapping

setMappingCollection

setPolicies

setRetries

setUseCategories