org.hawkular.alerts.api.json

Class GroupMemberInfo

java.lang.Object

org.hawkular.alerts.api.json.GroupMemberInfo

public class GroupMemberInfo
extends Object

A convenience class used in the REST API to POST a new group Member Trigger.

A group-level condition uses dataId tokens for the dataIds defined in the condition. The group members must then replace the tokens with actual dataIds. For example, we may define a group ThresholdCondition like ( $SystemLoad$ > 80 ). Each member must then replace $SystemLoad$ with the actual system load dataId for that member. See setDataIdMap(Map) for details on how to construct the map supplying the dataId substitutions.

Author:

jay shaughnessy, lucas ponce

Constructor Summary

Constructors

Constructor and Description
GroupMemberInfo()
GroupMemberInfo(String groupId, String memberId, String memberName, String memberDescription, Map<String,String> memberContext, Map<String,String> memberTags, Map<String,String> dataIdMap)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getDataIdMap()
String	getGroupId()
Map<String,String>	getMemberContext()
String	getMemberDescription()
String	getMemberId()
String	getMemberName()
Map<String,String>	getMemberTags()
void	setDataIdMap(Map<String,String> dataIdMap) The dataIdMap is a map of the dataId tokens in the group conditions to the actual dataIds to be used for the member being added.
void	setGroupId(String groupId) The group triggerId for which this will be a member trigger.
void	setMemberContext(Map<String,String> memberContext)
void	setMemberDescription(String memberDescription)
void	setMemberId(String memberId) The member triggerId.
void	setMemberName(String memberName) The member triggerName.
void	setMemberTags(Map<String,String> memberTags)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupMemberInfo

public GroupMemberInfo()

GroupMemberInfo

public GroupMemberInfo(String groupId,
                       String memberId,
                       String memberName,
                       String memberDescription,
                       Map<String,String> memberContext,
                       Map<String,String> memberTags,
                       Map<String,String> dataIdMap)

Method Detail

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

The group triggerId for which this will be a member trigger. Required.

getMemberId

public String getMemberId()

setMemberId

public void setMemberId(String memberId)

The member triggerId. If null will be generated.

getMemberName

public String getMemberName()

setMemberName

public void setMemberName(String memberName)

The member triggerName. If null defaults to group trigger's name

getMemberDescription

public String getMemberDescription()

setMemberDescription

public void setMemberDescription(String memberDescription)

Parameters:

memberDescription - If null defaults to group trigger's description

getMemberContext

public Map<String,String> getMemberContext()

setMemberContext

public void setMemberContext(Map<String,String> memberContext)

Parameters:

memberContext - Members inherit the group trigger context. If not null this adds additional, or overrides existing, context entries.

getMemberTags

public Map<String,String> getMemberTags()

setMemberTags

public void setMemberTags(Map<String,String> memberTags)

Parameters:

memberTags - Members inherit the group trigger tags. If not null this adds additional, or overrides existing, tags.

getDataIdMap

public Map<String,String> getDataIdMap()

setDataIdMap

public void setDataIdMap(Map<String,String> dataIdMap)

The dataIdMap is a map of the dataId tokens in the group conditions to the actual dataIds to be used for the member being added. For example, assume the group trigger has two conditions defined: ThresholdCondition( $SystemLoad$ > 80 ) and ThresholdCondition( $HeapUsed$ > 70 ). And now let's assume we are adding a new member, Member1. The map would look like this:

 {[key   = "$SystemLoad$",
   value = "Member1SystemLoad"],
  [key   = "$HeapUsed$",
   value = "Member1HeapUsed"]
 }
 

So, in the example the actual dataIds would be Member1SystemLoad and Member1HeapUsed. With this Map we can now add the new member trigger.

A NOTE ABOUT EXTERNAL CONDITIONS. ExternalCondition.expression will automatically have the same token replacement performed. So, all occurrences of the dataId token found in the expression, will be replaced with the mapping. This allows the expression of a group external condition to be automatically customized to the member.

Parameters:

dataIdMap - the dataId mappings to be used for the new member trigger.existing member triggers. Can be empty if the group has no current conditions.

toString

public String toString()

Overrides:

toString in class Object