Package com.carfey.ops.event.dispatch

Class RESTfulEventHook

java.lang.Object

com.carfey.ops.event.dispatch.RESTfulEventHook

All Implemented Interfaces:

EventHook

public class RESTfulEventHook
extends java.lang.Object
implements EventHook

A dispatcher that sends notifications to a REST endpoint

Since:

5.20

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BASIC_AUTH_CONFIG_KEY
static java.util.Set<Category>	DEFAULT_CATEGORIES
static java.util.Set<Level>	DEFAULT_LEVELS
static java.lang.String	URL_CONFIG_KEY

Constructor Summary

Constructors

Constructor	Description
RESTfulEventHook(java.lang.String url, java.util.Set<Level> levels, java.util.Set<Category> categories)
RESTfulEventHook(java.lang.String url, java.util.Set<Level> levels, java.util.Set<Category> categories, java.lang.String authorization)

Method Summary

Modifier and Type	Method	Description
void	dispatch(Event event)	This method is invoked for each event, regardless of level or category.
boolean	equals(java.lang.Object obj)
java.util.Set<Category>	getCategories()
java.util.Set<Level>	getLevels()
int	hashCode()
protected void	post(Event event)	Override to change the actual call to the RESTful endpoint.
protected boolean	shouldPostEvent(Event event)	Override to get custom behaviour on whether to post to the endpoint for a given event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.carfey.ops.event.dispatch.EventHook

name

Field Detail

URL_CONFIG_KEY

public static final java.lang.String URL_CONFIG_KEY

See Also:

Constant Field Values

BASIC_AUTH_CONFIG_KEY

public static final java.lang.String BASIC_AUTH_CONFIG_KEY

See Also:

Constant Field Values

DEFAULT_LEVELS

public static final java.util.Set<Level> DEFAULT_LEVELS

DEFAULT_CATEGORIES

public static final java.util.Set<Category> DEFAULT_CATEGORIES

Constructor Detail

RESTfulEventHook

public RESTfulEventHook(java.lang.String url,
                        java.util.Set<Level> levels,
                        java.util.Set<Category> categories)

RESTfulEventHook

public RESTfulEventHook(java.lang.String url,
                        java.util.Set<Level> levels,
                        java.util.Set<Category> categories,
                        java.lang.String authorization)

Method Detail

dispatch

public void dispatch(Event event)
              throws java.lang.Exception

Description copied from interface: EventHook

This method is invoked for each event, regardless of level or category. Implementors must handle filtering which events require processing depending on the Level and Category.

Specified by:

dispatch in interface EventHook

Throws:

java.lang.Exception

post

protected void post(Event event)
             throws java.lang.Exception

Override to change the actual call to the RESTful endpoint.

Throws:

java.lang.Exception

shouldPostEvent

protected boolean shouldPostEvent(Event event)

Override to get custom behaviour on whether to post to the endpoint for a given event.

Returns:

true if this event should be posted to the endpoint

getLevels

public java.util.Set<Level> getLevels()

getCategories

public java.util.Set<Category> getCategories()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object