com.tailf.notif

Class NotificationCfg

Object

com.tailf.notif.NotificationCfg

public class NotificationCfg
extends Object

Constructor Summary

Constructors

Constructor and Description
NotificationCfg() Default constructor, all values has to be set using the setter methods.
NotificationCfg(int heartbeatInterval, int healthCheckInterval) Creates a NotificationCfg instance with only the heartbeatInterval and healthCheckInterval.
NotificationCfg(int heartbeatInterval, int healthCheckInterval, String streamName, ConfValue startTime, ConfValue stopTime, String xpathFilter, int usid, Maapi.Verbosity verbosity) Convenience constructor setting all values.
NotificationCfg(Maapi.Verbosity verbosity) Creates a NotificationCfg instance with only the verbosity.

Method Summary

Modifier and Type	Method and Description
int	getHealthCheckInterval() Get configured Healtcheck interval used by NotificationType.NOTIF_HEALTH_CHECK notifications.
int	getHeartbeatInterval() Get configured Heartbeat interval used by NotificationType.NOTIF_HEARTBEAT notifications.
ConfValue	getStartTime() Get configured startTime used by NotificationType.NOTIF_STREAM_EVENT notifications to define a replay start time.
ConfValue	getStopTime() Get configured stopTime used by NotificationType.NOTIF_STREAM_EVENT notifications to define a replay stop time.
String	getStreamName() Get configured stream name used by NotificationType.NOTIF_STREAM_EVENT notifications.
int	getUsid() Get configured User session id used by NotificationType.NOTIF_STREAM_EVENT notifications.
Maapi.Verbosity	getVerbosity() Get the configured verbosity used by NotficationType#NOTIF_PROGRESS and NotificationType.NOTIF_COMMIT_PROGRESS notifications.
String	getXPathFilter() Get configured XPathFilter used by NotificationType.NOTIF_STREAM_EVENT notifications.
void	setHealthCheckInterval(int healthCheckInterval) Required if we wish to generate NotificationType#CONFD_NOTIF_HEALTH_CHECK events.
void	setHeartbeatInterval(int heartbeatInterval) Required if we wish to generate NotificationType#CONFD_NOTIF_HEARTBEAT events.
void	setStartTime(ConfValue startTime) Optional for NotificationType#CONFD_NOTIF_STREAM_EVENT.
void	setStopTime(ConfValue stopTime) Optional for NotificationType#CONFD_NOTIF_STREAM_EVENT.
void	setStreamName(String streamName) Required for NotificationType#CONFD_NOTIF_STREAM_EVENT.
void	setUsid(int usid) Optional for NotificationType#CONFD_NOTIF_STREAM_EVENT.
void	setVerbosity(Maapi.Verbosity verbosity) Optional for NotificationType#CONFD_NOTIF_PROGRESS and NotificationType#CONFD_NOTIF_COMMIT_PROGRESS.
void	setXPathFilter(String xpathFilter) Optional for NotificationType#CONFD_NOTIF_STREAM_EVENT.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationCfg

public NotificationCfg()

Default constructor, all values has to be set using the setter methods.

NotificationCfg

public NotificationCfg(int heartbeatInterval,
                       int healthCheckInterval)

Creates a NotificationCfg instance with only the heartbeatInterval and healthCheckInterval. This constructor exist for the internal use of the Notif(java.net.Socket, java.util.EnumSet, int, int) constructor

Parameters:

heartbeatInterval -

healthCheckInterval -

NotificationCfg

public NotificationCfg(Maapi.Verbosity verbosity)

Creates a NotificationCfg instance with only the verbosity.

Parameters:

verbosity - default Maapi.Verbosity.NORMAL

NotificationCfg

public NotificationCfg(int heartbeatInterval,
                       int healthCheckInterval,
                       String streamName,
                       ConfValue startTime,
                       ConfValue stopTime,
                       String xpathFilter,
                       int usid,
                       Maapi.Verbosity verbosity)

Convenience constructor setting all values. Unused values should be set to their defaults.

Parameters:

heartbeatInterval - default 0

healthCheckInterval - default 0

streamName - default null

startTime - default ConfNoExists

stopTime - default ConfNoExists

xpathFilter - default null

usid - default 0

verbosity - default Maapi.Verbosity.NORMAL

Method Detail

setHeartbeatInterval

public void setHeartbeatInterval(int heartbeatInterval)

Required if we wish to generate NotificationType#CONFD_NOTIF_HEARTBEAT events. The time is milli seconds.

Parameters:

heartbeatInterval -

setHealthCheckInterval

public void setHealthCheckInterval(int healthCheckInterval)

Required if we wish to generate NotificationType#CONFD_NOTIF_HEALTH_CHECK events. The time is milli seconds.

Parameters:

healthCheckInterval -

setStreamName

public void setStreamName(String streamName)

Required for NotificationType#CONFD_NOTIF_STREAM_EVENT. The stream name of the Notification Stream (required).

Parameters:

streamName -

setStartTime

public void setStartTime(ConfValue startTime)

Optional for NotificationType#CONFD_NOTIF_STREAM_EVENT. Set to request a replay. If no value is indicated by ConfNoExists which is the default. Allowed values are of type ConfNoExists or ConfDatetime.

Parameters:

startTime -

setStopTime

public void setStopTime(ConfValue stopTime)

Optional for NotificationType#CONFD_NOTIF_STREAM_EVENT. If startTime is set stopTime can also be set to indicated the end of a replay. If no value is indicated by ConfNoExists which is the default. Allowed values are of type ConfNoExists or ConfDatetime.

Parameters:

stopTime -

setXPathFilter

public void setXPathFilter(String xpathFilter)

Optional for NotificationType#CONFD_NOTIF_STREAM_EVENT. XPath filter for the stream. NULL for no filter.

Parameters:

xpathFilter -

setUsid

public void setUsid(int usid)

Optional for NotificationType#CONFD_NOTIF_STREAM_EVENT. User session id for AAA restriction. Set to 0 for no AAA.

Parameters:

usid -

setVerbosity

public void setVerbosity(Maapi.Verbosity verbosity)

Optional for NotificationType#CONFD_NOTIF_PROGRESS and NotificationType#CONFD_NOTIF_COMMIT_PROGRESS. Sets the output verbosity. Defaults to Maapi.Verbosity.NORMAL.

Parameters:

verbosity -

getHeartbeatInterval

public int getHeartbeatInterval()

Get configured Heartbeat interval used by NotificationType.NOTIF_HEARTBEAT notifications. Time is in milliseconds.

Returns:

heartbeatInterval

getHealthCheckInterval

public int getHealthCheckInterval()

Get configured Healtcheck interval used by NotificationType.NOTIF_HEALTH_CHECK notifications. Time is in milliseconds.

Returns:

healthCheckInterval

getStreamName

public String getStreamName()

Get configured stream name used by NotificationType.NOTIF_STREAM_EVENT notifications.

Returns:

streamName

getStartTime

public ConfValue getStartTime()

Get configured startTime used by NotificationType.NOTIF_STREAM_EVENT notifications to define a replay start time. The value is either ConfDatetime or ConfNoExists.

Returns:

startTime

getStopTime

public ConfValue getStopTime()

Get configured stopTime used by NotificationType.NOTIF_STREAM_EVENT notifications to define a replay stop time. The value is either ConfDatetime or ConfNoExists.

Returns:

stopTime

getXPathFilter

public String getXPathFilter()

Get configured XPathFilter used by NotificationType.NOTIF_STREAM_EVENT notifications.

Returns:

XPathFilter

getUsid

public int getUsid()

Get configured User session id used by NotificationType.NOTIF_STREAM_EVENT notifications.

Returns:

usid

getVerbosity

public Maapi.Verbosity getVerbosity()

Get the configured verbosity used by NotficationType#NOTIF_PROGRESS and NotificationType.NOTIF_COMMIT_PROGRESS notifications.

Returns:

verbosity