PollStatus (OpenNMS 2021.1.1 API)

java.lang.Object
- org.opennms.netmgt.poller.PollStatus

All Implemented Interfaces:

Serializable
```
@Embeddable
public class PollStatus
extends Object
implements Serializable
```
Represents the status of a node, interface or services

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROPERTY_RESPONSE_TIME`
`static int`	`SERVICE_AVAILABLE` The constant that defines a service as being in a normal state.
`static int`	`SERVICE_UNAVAILABLE` The constant that defines a service that is not working normally and should be scheduled using the downtime models.
`static int`	`SERVICE_UNKNOWN` The constant the defines a status is unknown.
`static int`	`SERVICE_UNRESPONSIVE` The constant that defines a service that is up but is most likely suffering due to excessive load or latency issues and because of that has not responded within the configured timeout period.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static PollStatus`	`available()` available
`static PollStatus`	`available(Double responseTime)` available
`static PollStatus`	`decode(String statusName)` decode
`static PollStatus`	`decode(String statusName, Double responseTime)` decode
`static PollStatus`	`decode(String statusName, String reason)` decode
`static PollStatus`	`decode(String statusName, String reason, Double responseTime)` decode
`static PollStatus`	`down()` Deprecated. We should specify a reason on every PollStatus object.
`static PollStatus`	`down(String reason)` down
`boolean`	`equals(Object o)`
`static PollStatus`	`get(int status, Double responseTime)` get
`static PollStatus`	`get(int status, String reason)` get
`static PollStatus`	`get(int status, String reason, Double responseTime)` get
`Map<String,Number>`	`getProperties()` getProperties
`Number`	`getProperty(String key)` getProperty
`String`	`getReason()` getReason
`Double`	`getResponseTime()` getResponseTime
`int`	`getStatusCode()` getStatusCode
`String`	`getStatusName()` getStatusName
`Date`	`getTimestamp()` getTimestamp
`int`	`hashCode()` hashCode
`boolean`	`isAvailable()` isAvailable
`boolean`	`isDown()` isDown
`boolean`	`isUnavailable()` isUnavailable
`boolean`	`isUnknown()` isUnknown
`boolean`	`isUnresponsive()` isUnresponsive
`boolean`	`isUp()` isUp
`void`	`setProperties(Map<String,Number> p)` setProperties
`void`	`setProperty(String key, Number value)` setProperty
`void`	`setReason(String reason)` setReason
`void`	`setResponseTime(Double responseTime)` setResponseTime
`void`	`setTimestamp(Date timestamp)` setTimestamp
`String`	`toString()` toString
`static PollStatus`	`unavailable()` Deprecated. We should specify a reason on every PollStatus object.
`static PollStatus`	`unavailable(String reason)` unavailable
`static PollStatus`	`unknown()` Deprecated. We should specify a reason on every PollStatus object.
`static PollStatus`	`unknown(String reason)` unknown
`static PollStatus`	`unresponsive()` Deprecated. We should specify a reason on every PollStatus object.
`static PollStatus`	`unresponsive(String reason)` unresponsive
`static PollStatus`	`up()` up
`static PollStatus`	`up(Double responseTime)` up

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

- Field Detail
  - PROPERTY_RESPONSE_TIME
```
public static final String PROPERTY_RESPONSE_TIME
```
    See Also:
    
    Constant Field Values
  - SERVICE_UNRESPONSIVE
```
public static final int SERVICE_UNRESPONSIVE
```
    The constant that defines a service that is up but is most likely suffering due to excessive load or latency issues and because of that has not responded within the configured timeout period.
    
    See Also:
    
    Constant Field Values
  - SERVICE_UNAVAILABLE
```
public static final int SERVICE_UNAVAILABLE
```
    The constant that defines a service that is not working normally and should be scheduled using the downtime models.
    
    See Also:
    
    Constant Field Values
  - SERVICE_AVAILABLE
```
public static final int SERVICE_AVAILABLE
```
    The constant that defines a service as being in a normal state. If this is returned by the poll() method then the framework will re-schedule the service for its next poll using the standard uptime interval
    
    See Also:
    
    Constant Field Values
  - SERVICE_UNKNOWN
```
public static final int SERVICE_UNKNOWN
```
    The constant the defines a status is unknown. Used mostly internally
    
    See Also:
    
    Constant Field Values
- Method Detail
  - decode
```
public static PollStatus decode(String statusName)
```
    decode
    
    Parameters:
    
    statusName - a String object.
    
    Returns:
    
    a PollStatus object.
  - decode
```
public static PollStatus decode(String statusName,
                                String reason)
```
    decode
    
    Parameters:
    
    statusName - a String object.
    
    reason - a String object.
    
    Returns:
    
    a PollStatus object.
  - decode
```
public static PollStatus decode(String statusName,
                                Double responseTime)
```
    decode
    
    Parameters:
    
    statusName - a String object.
    
    responseTime - a Double object.
    
    Returns:
    
    a PollStatus object.
  - decode
```
public static PollStatus decode(String statusName,
                                String reason,
                                Double responseTime)
```
    decode
    
    Parameters:
    
    statusName - a String object.
    
    reason - a String object.
    
    responseTime - a Double object.
    
    Returns:
    
    a PollStatus object.
  - get
```
public static PollStatus get(int status,
                             String reason)
```
    get
    
    Parameters:
    
    status - a int.
    
    reason - a String object.
    
    Returns:
    
    a PollStatus object.
  - get
```
public static PollStatus get(int status,
                             Double responseTime)
```
    get
    
    Parameters:
    
    status - a int.
    
    responseTime - a Double object.
    
    Returns:
    
    a PollStatus object.
  - get
```
public static PollStatus get(int status,
                             String reason,
                             Double responseTime)
```
    get
    
    Parameters:
    
    status - a int.
    
    reason - a String object.
    
    responseTime - a Double object.
    
    Returns:
    
    a PollStatus object.
  - up
```
public static PollStatus up()
```
    up
    
    Returns:
    
    a PollStatus object.
  - up
```
public static PollStatus up(Double responseTime)
```
    up
    
    Parameters:
    
    responseTime - a Double object.
    
    Returns:
    
    a PollStatus object.
  - available
```
public static PollStatus available()
```
    available
    
    Returns:
    
    a PollStatus object.
  - available
```
public static PollStatus available(Double responseTime)
```
    available
    
    Parameters:
    
    responseTime - a Double object.
    
    Returns:
    
    a PollStatus object.
  - unknown
```
public static PollStatus unknown()
```
    Deprecated. We should specify a reason on every PollStatus object.
    
    Returns:
    
    a PollStatus object.
  - unknown
```
public static PollStatus unknown(String reason)
```
    unknown
    
    Parameters:
    
    reason - a String object.
    
    Returns:
    
    a PollStatus object.
  - unresponsive
```
public static PollStatus unresponsive()
```
    Deprecated. We should specify a reason on every PollStatus object.
    
    Returns:
    
    a PollStatus object.
  - unresponsive
```
public static PollStatus unresponsive(String reason)
```
    unresponsive
    
    Parameters:
    
    reason - a String object.
    
    Returns:
    
    a PollStatus object.
  - down
```
public static PollStatus down()
```
    Deprecated. We should specify a reason on every PollStatus object.
    
    Returns:
    
    a PollStatus object.
  - unavailable
```
public static PollStatus unavailable()
```
    Deprecated. We should specify a reason on every PollStatus object.
    
    Returns:
    
    a PollStatus object.
  - down
```
public static PollStatus down(String reason)
```
    down
    
    Parameters:
    
    reason - a String object.
    
    Returns:
    
    a PollStatus object.
  - unavailable
```
public static PollStatus unavailable(String reason)
```
    unavailable
    
    Parameters:
    
    reason - a String object.
    
    Returns:
    
    a PollStatus object.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    hashCode
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a int.
  - isUp
```
public boolean isUp()
```
    isUp
    
    Returns:
    
    a boolean.
  - isAvailable
```
public boolean isAvailable()
```
    isAvailable
    
    Returns:
    
    a boolean.
  - isUnresponsive
```
public boolean isUnresponsive()
```
    isUnresponsive
    
    Returns:
    
    a boolean.
  - isUnavailable
```
public boolean isUnavailable()
```
    isUnavailable
    
    Returns:
    
    a boolean.
  - isDown
```
public boolean isDown()
```
    isDown
    
    Returns:
    
    a boolean.
  - isUnknown
```
public boolean isUnknown()
```
    isUnknown
    
    Returns:
    
    a boolean.
  - toString
```
public String toString()
```
    toString
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String object.
  - getTimestamp
```
public Date getTimestamp()
```
    getTimestamp
    
    Returns:
    
    a Date object.
  - setTimestamp
```
public void setTimestamp(Date timestamp)
```
    setTimestamp
    
    Parameters:
    
    timestamp - a Date object.
  - getReason
```
public String getReason()
```
    getReason
    
    Returns:
    
    a String object.
  - setReason
```
public void setReason(String reason)
```
    setReason
    
    Parameters:
    
    reason - a String object.
  - getResponseTime
```
public Double getResponseTime()
```
    getResponseTime
    
    Returns:
    
    a Double object.
  - setResponseTime
```
public void setResponseTime(Double responseTime)
```
    setResponseTime
    
    Parameters:
    
    responseTime - a Double object.
  - getProperties
```
public Map<String,Number> getProperties()
```
    getProperties
    
    Returns:
    
    a Map object.
  - setProperties
```
public void setProperties(Map<String,Number> p)
```
    setProperties
    
    Parameters:
    
    p - a Map object.
  - getProperty
```
public Number getProperty(String key)
```
    getProperty
    
    Parameters:
    
    key - a String object.
    
    Returns:
    
    a Number object.
  - setProperty
```
public void setProperty(String key,
                        Number value)
```
    setProperty
    
    Parameters:
    
    key - a String object.
    
    value - a Number object.
  - getStatusCode
```
public int getStatusCode()
```
    getStatusCode
    
    Returns:
    
    a int.
  - getStatusName
```
public String getStatusName()
```
    getStatusName
    
    Returns:
    
    a String object.

Class PollStatus

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_RESPONSE_TIME

SERVICE_UNRESPONSIVE

SERVICE_UNAVAILABLE

SERVICE_AVAILABLE

SERVICE_UNKNOWN

Method Detail

decode

decode

decode

decode

get

get

get

up

up

available

available

unknown

unknown

unresponsive

unresponsive

down

unavailable

down

unavailable

equals

hashCode

isUp

isAvailable

isUnresponsive

isUnavailable

isDown

isUnknown

toString

getTimestamp

setTimestamp

getReason

setReason

getResponseTime

setResponseTime

getProperties

setProperties

getProperty

setProperty

getStatusCode

getStatusName