public class

NotificationContext

extends Object
java.lang.Object
   ↳ org.apache.helix.NotificationContext

Class Overview

Metadata associated with a notification event and the current state of the cluster

Summary

Nested Classes
enum NotificationContext.MapKey keys used for object map  
enum NotificationContext.Type Valid types of notifications  
Public Constructors
NotificationContext(HelixManager manager)
Instantiate with a HelixManager
Public Methods
void add(String key, Object value)
Add notification metadata
Object get(String key)
Get a notification attribute
String getEventName()
Get the name associated with the event
HelixManager getManager()
Get the HelixManager associated with this notification
Map<String, Object> getMap()
Get a map describing the update (keyed on NotificationContext.MapKey)
String getPathChanged()
Get the path changed status
NotificationContext.Type getType()
Get the type of the notification
void setEventName(String eventName)
Set the name associated with the event
void setManager(HelixManager manager)
Set the HelixManager associated with this notification
void setMap(Map<String, Object> map)
Set the notification map
void setPathChanged(String pathChanged)
Set the path changed status
void setType(NotificationContext.Type type)
Set the notification type
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public NotificationContext (HelixManager manager)

Instantiate with a HelixManager

Parameters
manager HelixManager object

Public Methods

public void add (String key, Object value)

Add notification metadata

Parameters
key String value of a NotificationContext.MapKey

public Object get (String key)

Get a notification attribute

Parameters
key String from a NotificationContext.MapKey

public String getEventName ()

Get the name associated with the event

Returns
  • event name

public HelixManager getManager ()

Get the HelixManager associated with this notification

Returns

public Map<String, Object> getMap ()

Get a map describing the update (keyed on NotificationContext.MapKey)

Returns
  • the object map describing the update

public String getPathChanged ()

Get the path changed status

Returns
  • String corresponding to the path change

public NotificationContext.Type getType ()

Get the type of the notification

Returns
  • the notification type

public void setEventName (String eventName)

Set the name associated with the event

Parameters
eventName the event name

public void setManager (HelixManager manager)

Set the HelixManager associated with this notification

Parameters
manager HelixManager object

public void setMap (Map<String, Object> map)

Set the notification map

public void setPathChanged (String pathChanged)

Set the path changed status

public void setType (NotificationContext.Type type)

Set the notification type