WmiConfig (OpenNMS 19.1.0 API)

java.lang.Object
- org.opennms.netmgt.config.wmi.agent.WmiConfig

All Implemented Interfaces:

Serializable
```
public class WmiConfig
extends Object
implements Serializable
```
This is the top-level element for wmi-config.xml

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

WmiConfig()

Constructors
Constructor and Description
`WmiConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDefinition(Definition vDefinition)`
`void`	`addDefinition(int index, Definition vDefinition)`
`void`	`deleteRetry()`
`void`	`deleteTimeout()`
`Enumeration<Definition>`	`enumerateDefinition()` Method enumerateDefinition.
`boolean`	`equals(Object obj)` Overrides the Object.equals method.
`Definition[]`	`getDefinition()` Method getDefinition.Returns the contents of the collection in an Array.
`Definition`	`getDefinition(int index)` Method getDefinition.
`List<Definition>`	`getDefinitionCollection()` Method getDefinitionCollection.Returns a reference to 'definitionList'.
`int`	`getDefinitionCount()` Method getDefinitionCount.
`String`	`getDomain()` Returns the value of field 'domain'.
`String`	`getPassword()` Returns the value of field 'password'.
`Integer`	`getRetry()` Returns the value of field 'retry'.
`Integer`	`getTimeout()` Returns the value of field 'timeout'.
`String`	`getUsername()` Returns the value of field 'username'.
`int`	`hashCode()` Method hashCode.
`boolean`	`hasRetry()` Method hasRetry.
`boolean`	`hasTimeout()` Method hasTimeout.
`Iterator<Definition>`	`iterateDefinition()` Method iterateDefinition.
`void`	`removeAllDefinition()`
`boolean`	`removeDefinition(Definition vDefinition)` Method removeDefinition.
`Definition`	`removeDefinitionAt(int index)` Method removeDefinitionAt.
`void`	`setDefinition(Definition[] vDefinitionArray)`
`void`	`setDefinition(int index, Definition vDefinition)`
`void`	`setDefinition(List<Definition> vDefinitionList)` Sets the value of 'definitionList' by copying the given Vector.
`void`	`setDefinitionCollection(List<Definition> definitionList)` Deprecated.
`void`	`setDomain(String domain)` Sets the value of field 'domain'.
`void`	`setPassword(String password)` Sets the value of field 'password'.
`void`	`setRetry(Integer retry)` Sets the value of field 'retry'.
`void`	`setTimeout(Integer timeout)` Sets the value of field 'timeout'.
`void`	`setUsername(String username)` Sets the value of field 'username'.

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

- Constructor Detail
  - WmiConfig
```
public WmiConfig()
```
- Method Detail
  - addDefinition
```
public void addDefinition(Definition vDefinition)
                   throws IndexOutOfBoundsException
```
    Parameters:
    
    vDefinition -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addDefinition
```
public void addDefinition(int index,
                          Definition vDefinition)
                   throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vDefinition -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - deleteRetry
```
public void deleteRetry()
```
  - deleteTimeout
```
public void deleteTimeout()
```
  - enumerateDefinition
```
public Enumeration<Definition> enumerateDefinition()
```
    Method enumerateDefinition.
    
    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.
  - getDefinition
```
public Definition getDefinition(int index)
                         throws IndexOutOfBoundsException
```
    Method getDefinition.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the Definition at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getDefinition
```
public Definition[] getDefinition()
```
    Method getDefinition.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
  - getDefinitionCollection
```
public List<Definition> getDefinitionCollection()
```
    Method getDefinitionCollection.Returns a reference to 'definitionList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getDefinitionCount
```
public int getDefinitionCount()
```
    Method getDefinitionCount.
    
    Returns:
    
    the size of this collection
  - getDomain
```
public String getDomain()
```
    Returns the value of field 'domain'. The field 'domain' has the following description: Default Windows Domain.
    
    Returns:
    
    the value of field 'Domain'.
  - getPassword
```
public String getPassword()
```
    Returns the value of field 'password'. The field 'password' has the following description: Default user password.
    
    Returns:
    
    the value of field 'Password'.
  - getRetry
```
public Integer getRetry()
```
    Returns the value of field 'retry'. The field 'retry' has the following description: Default number of retries.
    
    Returns:
    
    the value of field 'Retry'.
  - getTimeout
```
public Integer getTimeout()
```
    Returns the value of field 'timeout'. The field 'timeout' has the following description: Default timeout (in milliseconds).
    
    Returns:
    
    the value of field 'Timeout'.
  - getUsername
```
public String getUsername()
```
    Returns the value of field 'username'. The field 'username' has the following description: Default username.
    
    Returns:
    
    the value of field 'Username'.
  - 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
  - hashCode
```
public int hashCode()
```
    Method hashCode.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for the object.
  - iterateDefinition
```
public Iterator<Definition> iterateDefinition()
```
    Method iterateDefinition.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - removeAllDefinition
```
public void removeAllDefinition()
```
  - removeDefinition
```
public boolean removeDefinition(Definition vDefinition)
```
    Method removeDefinition.
    
    Parameters:
    
    vDefinition -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeDefinitionAt
```
public Definition removeDefinitionAt(int index)
```
    Method removeDefinitionAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setDefinition
```
public void setDefinition(int index,
                          Definition vDefinition)
                   throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vDefinition -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setDefinition
```
public void setDefinition(Definition[] vDefinitionArray)
```
    Parameters:
    
    vDefinitionArray -
  - setDefinition
```
public void setDefinition(List<Definition> vDefinitionList)
```
    Sets the value of 'definitionList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vDefinitionList - the Vector to copy.
  - setDefinitionCollection
```
public void setDefinitionCollection(List<Definition> definitionList)
```
    Deprecated.
    
    Sets the value of 'definitionList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    definitionList - the Vector to set.
  - setDomain
```
public void setDomain(String domain)
```
    Sets the value of field 'domain'. The field 'domain' has the following description: Default Windows Domain.
    
    Parameters:
    
    domain - the value of field 'domain'.
  - setPassword
```
public void setPassword(String password)
```
    Sets the value of field 'password'. The field 'password' has the following description: Default user password.
    
    Parameters:
    
    password - the value of field 'password'.
  - setRetry
```
public void setRetry(Integer retry)
```
    Sets the value of field 'retry'. The field 'retry' has the following description: Default number of retries.
    
    Parameters:
    
    retry - the value of field 'retry'.
  - setTimeout
```
public void setTimeout(Integer timeout)
```
    Sets the value of field 'timeout'. The field 'timeout' has the following description: Default timeout (in milliseconds).
    
    Parameters:
    
    timeout - the value of field 'timeout'.
  - setUsername
```
public void setUsername(String username)
```
    Sets the value of field 'username'. The field 'username' has the following description: Default username.
    
    Parameters:
    
    username - the value of field 'username'.

Class WmiConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WmiConfig

Method Detail

addDefinition

addDefinition

deleteRetry

deleteTimeout

enumerateDefinition

equals

getDefinition

getDefinition

getDefinitionCollection

getDefinitionCount

getDomain

getPassword

getRetry

getTimeout

getUsername

hasRetry

hasTimeout

hashCode

iterateDefinition

removeAllDefinition

removeDefinition

removeDefinitionAt

setDefinition

setDefinition

setDefinition

setDefinitionCollection

setDomain

setPassword

setRetry

setTimeout

setUsername