com.neeve.service

Class Alerter

java.lang.Object

com.neeve.service.Alerter

public final class Alerter
extends Object

The Eagle service alerter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Alerter.Callout
static class	Alerter.Severity

Constructor Summary

Constructors

Constructor and Description
Alerter(Boolean loggingEnabled, String loggingLocation, IdentityInformationProvider identityInfoProvider, IAlertTracer tracer) Constructor

Method Summary

Modifier and Type	Method and Description
void	alert(String headline, String str, Throwable e, Alerter.Severity severity, String classifier) Log an alert
void	alert(String str, Throwable e, Alerter.Severity severity) Log an alert
void	alert(String str, Throwable e, Alerter.Severity severity, String classifier)
void	close() Close an alerter
Alerter	enableLogging(boolean val) Enable/disable logging
String	getLogName() Get the name of the underlying log
boolean	isLoggingEnabled() Get if logging is enabled
void	open(Alerter.Callout callout) Open an alerter
void	scheduleLogCompactionOnNextWrite() Schedule a compaction on the underlying on the next write
void	setLogCompactionThreshold(int val) Set the compaction threshold on the underlying log

Methods inherited from class java.lang.Object

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

Constructor Detail

Alerter

@Inject
public Alerter(Boolean loggingEnabled,
                       String loggingLocation,
                       IdentityInformationProvider identityInfoProvider,
                       IAlertTracer tracer)

Constructor

Method Detail

getLogName

public final String getLogName()

Get the name of the underlying log

open

public final void open(Alerter.Callout callout)
                throws Exception

Open an alerter

Parameters:

callout - A callout to be invoked whenever an alert is received. This value can be null.

Throws:

Exception

enableLogging

public final Alerter enableLogging(boolean val)

Enable/disable logging

Parameters:

val - Specifies whether to switch logging on of off.

This method enables/disables logging (journalling) of alert messages. The method can be called at any time during the life of an alerter.

isLoggingEnabled

public final boolean isLoggingEnabled()

Get if logging is enabled

setLogCompactionThreshold

public final void setLogCompactionThreshold(int val)
                                     throws Exception

Set the compaction threshold on the underlying log

Parameters:

val - The compaction threshold to set in gigabytes. A value of 0 will switch off compaction

Throws:

Exception

scheduleLogCompactionOnNextWrite

public final void scheduleLogCompactionOnNextWrite()
                                            throws Exception

Schedule a compaction on the underlying on the next write

Throws:

Exception

alert

public final void alert(String headline,
                        String str,
                        Throwable e,
                        Alerter.Severity severity,
                        String classifier)

Log an alert

alert

public final void alert(String str,
                        Throwable e,
                        Alerter.Severity severity,
                        String classifier)

alert

public final void alert(String str,
                        Throwable e,
                        Alerter.Severity severity)

Log an alert

close

public final void close()

Close an alerter