RTCConfiguration (OpenNMS 16.0.1 API)

java.lang.Object
- org.opennms.netmgt.config.rtc.RTCConfiguration

All Implemented Interfaces:

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RTCConfiguration()

Constructors
Constructor and Description
`RTCConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteErrorsBeforeUrlUnsubscribe()`
`void`	`deleteMaxEventsBeforeResend()`
`void`	`deleteSenders()`
`void`	`deleteUpdaters()`
`boolean`	`equals(Object obj)` Overrides the java.lang.Object.equals method.
`int`	`getErrorsBeforeUrlUnsubscribe()` Returns the value of field 'errorsBeforeUrlUnsubscribe'.
`String`	`getHighThresholdInterval()` Returns the value of field 'highThresholdInterval'.
`String`	`getLowThresholdInterval()` Returns the value of field 'lowThresholdInterval'.
`int`	`getMaxEventsBeforeResend()` Returns the value of field 'maxEventsBeforeResend'.
`String`	`getRollingWindow()` Returns the value of field 'rollingWindow'.
`int`	`getSenders()` Returns the value of field 'senders'.
`int`	`getUpdaters()` Returns the value of field 'updaters'.
`String`	`getUserRefreshInterval()` Returns the value of field 'userRefreshInterval'.
`boolean`	`hasErrorsBeforeUrlUnsubscribe()` Method hasErrorsBeforeUrlUnsubscribe.
`int`	`hashCode()` Overrides the java.lang.Object.hashCode method.
`boolean`	`hasMaxEventsBeforeResend()` Method hasMaxEventsBeforeResend.
`boolean`	`hasSenders()` Method hasSenders.
`boolean`	`hasUpdaters()` Method hasUpdaters.
`boolean`	`isValid()` Method isValid.
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`void`	`setErrorsBeforeUrlUnsubscribe(int errorsBeforeUrlUnsubscribe)` Sets the value of field 'errorsBeforeUrlUnsubscribe'.
`void`	`setHighThresholdInterval(String highThresholdInterval)` Sets the value of field 'highThresholdInterval'.
`void`	`setLowThresholdInterval(String lowThresholdInterval)` Sets the value of field 'lowThresholdInterval'.
`void`	`setMaxEventsBeforeResend(int maxEventsBeforeResend)` Sets the value of field 'maxEventsBeforeResend'.
`void`	`setRollingWindow(String rollingWindow)` Sets the value of field 'rollingWindow'.
`void`	`setSenders(int senders)` Sets the value of field 'senders'.
`void`	`setUpdaters(int updaters)` Sets the value of field 'updaters'.
`void`	`setUserRefreshInterval(String userRefreshInterval)` Sets the value of field 'userRefreshInterval'.
`static RTCConfiguration`	`unmarshal(Reader reader)` Method unmarshal.
`void`	`validate()`

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

- Constructor Detail
  - RTCConfiguration
```
public RTCConfiguration()
```
- Method Detail
  - deleteErrorsBeforeUrlUnsubscribe
```
public void deleteErrorsBeforeUrlUnsubscribe()
```
  - deleteMaxEventsBeforeResend
```
public void deleteMaxEventsBeforeResend()
```
  - deleteSenders
```
public void deleteSenders()
```
  - deleteUpdaters
```
public void deleteUpdaters()
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides the java.lang.Object.equals method.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    true if the objects are equal.
  - getErrorsBeforeUrlUnsubscribe
```
public int getErrorsBeforeUrlUnsubscribe()
```
    Returns the value of field 'errorsBeforeUrlUnsubscribe'. The field 'errorsBeforeUrlUnsubscribe' has the following description: Number of times a URL post is tried with errors before automatically unsubscribing the URL. A negative value means the URL is not unsubscribed until an 'unsubscribe' event is received.
    
    Returns:
    
    the value of field 'ErrorsBeforeUrlUnsubscribe'.
  - getHighThresholdInterval
```
public String getHighThresholdInterval()
```
    Returns the value of field 'highThresholdInterval'. The field 'highThresholdInterval' has the following description: High threshold timer interval.
    
    Returns:
    
    the value of field 'HighThresholdInterval'.
  - getLowThresholdInterval
```
public String getLowThresholdInterval()
```
    Returns the value of field 'lowThresholdInterval'. The field 'lowThresholdInterval' has the following description: Low threshold timer interval.
    
    Returns:
    
    the value of field 'LowThresholdInterval'.
  - getMaxEventsBeforeResend
```
public int getMaxEventsBeforeResend()
```
    Returns the value of field 'maxEventsBeforeResend'. The field 'maxEventsBeforeResend' has the following description: The number of received events that prompts an immediate send of RTC data to the UI. This causes data to be sent immediately instead of waiting for a timer to go off.
    
    Returns:
    
    the value of field 'MaxEventsBeforeResend'.
  - getRollingWindow
```
public String getRollingWindow()
```
    Returns the value of field 'rollingWindow'. The field 'rollingWindow' has the following description: The rolling window over which availability is calculated. It can be specified as a combination of hours/minutes/seconds. E.g.: 10h20m5s
    
    Returns:
    
    the value of field 'RollingWindow'.
  - getSenders
```
public int getSenders()
```
    Returns the value of field 'senders'. The field 'senders' has the following description: Maximum number of threads sending data to the UI.
    
    Returns:
    
    the value of field 'Senders'.
  - getUpdaters
```
public int getUpdaters()
```
    Returns the value of field 'updaters'. The field 'updaters' has the following description: Maximum number of threads reading the events and updating the RTC data.
    
    Returns:
    
    the value of field 'Updaters'.
  - getUserRefreshInterval
```
public String getUserRefreshInterval()
```
    Returns the value of field 'userRefreshInterval'. The field 'userRefreshInterval' has the following description: User threshold timer interval. Used to send RTC data to the UI when no events are coming in.
    
    Returns:
    
    the value of field 'UserRefreshInterval'.
  - hasErrorsBeforeUrlUnsubscribe
```
public boolean hasErrorsBeforeUrlUnsubscribe()
```
    Method hasErrorsBeforeUrlUnsubscribe.
    
    Returns:
    
    true if at least one ErrorsBeforeUrlUnsubscribe has been added
  - hasMaxEventsBeforeResend
```
public boolean hasMaxEventsBeforeResend()
```
    Method hasMaxEventsBeforeResend.
    
    Returns:
    
    true if at least one MaxEventsBeforeResend has been added
  - hasSenders
```
public boolean hasSenders()
```
    Method hasSenders.
    
    Returns:
    
    true if at least one Senders has been added
  - hasUpdaters
```
public boolean hasUpdaters()
```
    Method hasUpdaters.
    
    Returns:
    
    true if at least one Updaters has been added
  - hashCode
```
public int hashCode()
```
    Overrides the java.lang.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.
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    
    true if this object is valid according to the schema
  - 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
  - setErrorsBeforeUrlUnsubscribe
```
public void setErrorsBeforeUrlUnsubscribe(int errorsBeforeUrlUnsubscribe)
```
    Sets the value of field 'errorsBeforeUrlUnsubscribe'. The field 'errorsBeforeUrlUnsubscribe' has the following description: Number of times a URL post is tried with errors before automatically unsubscribing the URL. A negative value means the URL is not unsubscribed until an 'unsubscribe' event is received.
    
    Parameters:
    
    errorsBeforeUrlUnsubscribe - the value of field 'errorsBeforeUrlUnsubscribe'.
  - setHighThresholdInterval
```
public void setHighThresholdInterval(String highThresholdInterval)
```
    Sets the value of field 'highThresholdInterval'. The field 'highThresholdInterval' has the following description: High threshold timer interval.
    
    Parameters:
    
    highThresholdInterval - the value of field 'highThresholdInterval'.
  - setLowThresholdInterval
```
public void setLowThresholdInterval(String lowThresholdInterval)
```
    Sets the value of field 'lowThresholdInterval'. The field 'lowThresholdInterval' has the following description: Low threshold timer interval.
    
    Parameters:
    
    lowThresholdInterval - the value of field 'lowThresholdInterval'.
  - setMaxEventsBeforeResend
```
public void setMaxEventsBeforeResend(int maxEventsBeforeResend)
```
    Sets the value of field 'maxEventsBeforeResend'. The field 'maxEventsBeforeResend' has the following description: The number of received events that prompts an immediate send of RTC data to the UI. This causes data to be sent immediately instead of waiting for a timer to go off.
    
    Parameters:
    
    maxEventsBeforeResend - the value of field 'maxEventsBeforeResend'.
  - setRollingWindow
```
public void setRollingWindow(String rollingWindow)
```
    Sets the value of field 'rollingWindow'. The field 'rollingWindow' has the following description: The rolling window over which availability is calculated. It can be specified as a combination of hours/minutes/seconds. E.g.: 10h20m5s
    
    Parameters:
    
    rollingWindow - the value of field 'rollingWindow'.
  - setSenders
```
public void setSenders(int senders)
```
    Sets the value of field 'senders'. The field 'senders' has the following description: Maximum number of threads sending data to the UI.
    
    Parameters:
    
    senders - the value of field 'senders'.
  - setUpdaters
```
public void setUpdaters(int updaters)
```
    Sets the value of field 'updaters'. The field 'updaters' has the following description: Maximum number of threads reading the events and updating the RTC data.
    
    Parameters:
    
    updaters - the value of field 'updaters'.
  - setUserRefreshInterval
```
public void setUserRefreshInterval(String userRefreshInterval)
```
    Sets the value of field 'userRefreshInterval'. The field 'userRefreshInterval' has the following description: User threshold timer interval. Used to send RTC data to the UI when no events are coming in.
    
    Parameters:
    
    userRefreshInterval - the value of field 'userRefreshInterval'.
  - unmarshal
```
public static RTCConfiguration 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.rtc.RTCConfiguration
    
    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

Class RTCConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RTCConfiguration

Method Detail

deleteErrorsBeforeUrlUnsubscribe

deleteMaxEventsBeforeResend

deleteSenders

deleteUpdaters

equals

getErrorsBeforeUrlUnsubscribe

getHighThresholdInterval

getLowThresholdInterval

getMaxEventsBeforeResend

getRollingWindow

getSenders

getUpdaters

getUserRefreshInterval

hasErrorsBeforeUrlUnsubscribe

hasMaxEventsBeforeResend

hasSenders

hasUpdaters

hashCode

isValid

marshal

marshal

setErrorsBeforeUrlUnsubscribe

setHighThresholdInterval

setLowThresholdInterval

setMaxEventsBeforeResend

setRollingWindow

setSenders

setUpdaters

setUserRefreshInterval

unmarshal

validate