Package org.netxms.client.events

Class EventProcessingPolicyChain

java.lang.Object

org.netxms.client.events.EventProcessingPolicyChain

public class EventProcessingPolicyChain
extends Object

Event processing policy rule chain. Chain 0 is the main chain (entry point of event processing); it cannot be renamed, deleted, or given an access control list. Registry data (name, description, version, rights, counters) comes with the policy; rules are loaded separately per chain and are null until loaded.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventProcessingPolicyChain.DeletedRuleInfo	Rule deleted locally but not yet saved (its last known version is sent to the server for conflict detection)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACCESS_EDIT
static final int	ACCESS_READ

Constructor Summary

Constructors

Constructor	Description
EventProcessingPolicyChain(int id, UUID guid, String name, String description)	Create chain object for a newly created (empty) chain.
EventProcessingPolicyChain(NXCPMessage msg, long baseId)	Create chain object from registry entry in NXCP message.

Method Summary

Modifier and Type	Method	Description
void	addRule(EventProcessingPolicyRule rule)	Add rule at the end of the chain
void	clearDeletedRules()	Forget deleted rules (after successful save)
void	deleteRule(EventProcessingPolicyRule rule)	Delete rule; its GUID and version are remembered until the chain is saved so the server can detect concurrent changes.
List<AccessListElement>	getAccessList()
int	getCallerCount()
List<EventProcessingPolicyChain.DeletedRuleInfo>	getDeletedRules()
String	getDescription()
int	getEffectiveRights()
UUID	getGuid()
int	getId()
String	getName()
int	getRuleCount()
List<EventProcessingPolicyRule>	getRules()
int	getVersion()
void	insertRule(EventProcessingPolicyRule rule, int index)	Insert rule at given position
boolean	isEditable()
boolean	isLoaded()
boolean	isMain()
void	setAccessList(List<AccessListElement> accessList)
void	setDescription(String description)
void	setName(String name)
void	setRules(List<EventProcessingPolicyRule> rules, int version)	Replace rules and version with data loaded from server.
void	setVersion(int version)

Methods inherited from class java.lang.Object

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

Field Details

ACCESS_READ

public static final int ACCESS_READ

See Also:

• Constant Field Values

ACCESS_EDIT

public static final int ACCESS_EDIT

See Also:

• Constant Field Values

Constructor Details

EventProcessingPolicyChain

public EventProcessingPolicyChain(NXCPMessage msg,
 long baseId)

Create chain object from registry entry in NXCP message.

Parameters:

msg - NXCP message

baseId - base field ID of the registry entry

EventProcessingPolicyChain

public EventProcessingPolicyChain(int id,
 UUID guid,
 String name,
 String description)

Create chain object for a newly created (empty) chain.

Parameters:

id - chain ID assigned by server

guid - chain GUID assigned by server

name - chain name

description - chain description

Method Details

getId

public int getId()

Returns:

chain ID (0 for the main chain)

isMain

public boolean isMain()

Returns:

true if this is the main chain

getGuid

public UUID getGuid()

Returns:

chain GUID

getName

public String getName()

Returns:

chain name

setName

public void setName(String name)

Parameters:

name - chain name

getDescription

public String getDescription()

Returns:

chain description

setDescription

public void setDescription(String description)

Parameters:

description - chain description

getVersion

public int getVersion()

Returns:

chain version (optimistic concurrency base for saving this chain's rules)

setVersion

public void setVersion(int version)

Parameters:

version - chain version

getEffectiveRights

public int getEffectiveRights()

Returns:

effective rights of current user on this chain (bitmask of ACCESS_READ, ACCESS_EDIT)

isEditable

public boolean isEditable()

Returns:

true if current user can edit rules of this chain

getRuleCount

public int getRuleCount()

Returns:

number of rules in this chain as reported by server (available before rules are loaded)

getCallerCount

public int getCallerCount()

Returns:

number of rules (in any chain) calling this chain as reported by server

getAccessList

public List<AccessListElement> getAccessList()

Returns:

chain access control list (available only to users with the global EPP right)

setAccessList

public void setAccessList(List<AccessListElement> accessList)

Parameters:

accessList - chain access control list

isLoaded

public boolean isLoaded()

Returns:

true if rules of this chain were loaded

getRules

public List<EventProcessingPolicyRule> getRules()

Returns:

rules in evaluation order, or null if not loaded

setRules

public void setRules(List<EventProcessingPolicyRule> rules,
 int version)

Replace rules and version with data loaded from server. Pending deletions are discarded.

Parameters:

rules - rules in evaluation order

version - chain version

addRule

public void addRule(EventProcessingPolicyRule rule)

Add rule at the end of the chain

Parameters:

rule - rule to add

insertRule

public void insertRule(EventProcessingPolicyRule rule,
 int index)

Insert rule at given position

Parameters:

rule - rule to insert

index - position (0-based)

deleteRule

public void deleteRule(EventProcessingPolicyRule rule)

Delete rule; its GUID and version are remembered until the chain is saved so the server can detect concurrent changes.

Parameters:

rule - rule to delete

getDeletedRules

public List<EventProcessingPolicyChain.DeletedRuleInfo> getDeletedRules()

Returns:

rules deleted since last save

clearDeletedRules

public void clearDeletedRules()

Forget deleted rules (after successful save)