com.sssw.cm.event.util
Class EboEventHelper

java.lang.Object
 |
 +--com.sssw.cm.event.util.EboEventHelper

All Implemented Interfaces:

EbiConstants

public class EboEventHelper

extends Object

implements EbiConstants

Contains helper methods related to event monitoring.

Fields inherited from interface com.sssw.cm.event.api.EbiConstants

EVENT_ID_ACCESS_CHECKED, EVENT_ID_ADMIN_ACCESS_CHECKED, EVENT_ID_CATEGORY_ADDED, EVENT_ID_CATEGORY_CONTENTS_LISTED, EVENT_ID_CATEGORY_COPIED, EVENT_ID_CATEGORY_MOVED, EVENT_ID_CATEGORY_REMOVED, EVENT_ID_CATEGORY_RETRIEVED, EVENT_ID_CATEGORY_UPDATED, EVENT_ID_CM_BASE, EVENT_ID_CM_LAST, EVENT_ID_DATA_EXPORTED, EVENT_ID_DATA_IMPORTED, EVENT_ID_DOC_ADDED, EVENT_ID_DOC_ADDED_TO_CATEGORY, EVENT_ID_DOC_CHECKED_IN, EVENT_ID_DOC_CHECKED_OUT, EVENT_ID_DOC_COPIED, EVENT_ID_DOC_FIELD_ADDED, EVENT_ID_DOC_FIELD_ADDED_TO_TYPE, EVENT_ID_DOC_FIELD_REMOVED, EVENT_ID_DOC_FIELD_REMOVED_FROM_TYPE, EVENT_ID_DOC_FIELD_RETRIEVED, EVENT_ID_DOC_FIELD_UPDATED, EVENT_ID_DOC_FIELDS_LISTED, EVENT_ID_DOC_LAYOUT_STYLE_ADDED, EVENT_ID_DOC_LAYOUT_STYLE_REMOVED, EVENT_ID_DOC_LAYOUT_STYLE_RETRIEVED, EVENT_ID_DOC_LAYOUT_STYLE_UPDATED, EVENT_ID_DOC_LAYOUT_STYLES_LISTED, EVENT_ID_DOC_LINK_ADDED, EVENT_ID_DOC_LINK_REMOVED, EVENT_ID_DOC_LINK_RETRIEVED, EVENT_ID_DOC_LINK_UPDATED, EVENT_ID_DOC_LINKS_LISTED, EVENT_ID_DOC_MOVED, EVENT_ID_DOC_PUBLISHED, EVENT_ID_DOC_QUERY_EXECUTED, EVENT_ID_DOC_REMOVED, EVENT_ID_DOC_REMOVED_FROM_CATEGORY, EVENT_ID_DOC_RETRIEVED, EVENT_ID_DOC_ROLLED_BACK, EVENT_ID_DOC_SRCH_QUERY_EXECUTED, EVENT_ID_DOC_TYPE_ADDED, EVENT_ID_DOC_TYPE_FIELDS_LISTED, EVENT_ID_DOC_TYPE_REMOVED, EVENT_ID_DOC_TYPE_RETRIEVED, EVENT_ID_DOC_TYPE_UPDATED, EVENT_ID_DOC_TYPES_LISTED, EVENT_ID_DOC_UNCHECKED_OUT, EVENT_ID_DOC_UNLOCKED, EVENT_ID_DOC_UNPUBLISHED, EVENT_ID_DOC_UPDATED, EVENT_ID_FOLDER_ADDED, EVENT_ID_FOLDER_CONTENTS_LISTED, EVENT_ID_FOLDER_COPIED, EVENT_ID_FOLDER_MOVED, EVENT_ID_FOLDER_REMOVED, EVENT_ID_FOLDER_RETRIEVED, EVENT_ID_FOLDER_UPDATED, EVENT_ID_LDD_ADDED, EVENT_ID_LDD_REMOVED, EVENT_ID_LDD_RETRIEVED, EVENT_ID_LDD_UPDATED, EVENT_ID_LDDS_LISTED, EVENT_ID_LOOKUP_BY_ABSOLUTE, EVENT_ID_LOOKUP_BY_RELATIVE, EVENT_ID_REPOSITORIES_LISTED, EVENT_ID_REPOSITORY_ADDED, EVENT_ID_REPOSITORY_REMOVED, EVENT_ID_REPOSITORY_RETRIEVED, EVENT_ID_REPOSITORY_UPDATED, EVENT_ID_SECURITY_REMOVED, EVENT_ID_SECURITY_RETRIEVED, EVENT_ID_SECURITY_SET

Constructor Summary

EboEventHelper()

Method Summary

static void	adjustEventIDSet(BitSet eventIDSet, int stateChangeID, boolean on) Given a BitSet for event IDs, turns on or off the bits dedicated to CM events of the specified state change type.
static void	adjustEventIDSet(BitSet eventIDSet, String elType, boolean on) Given a BitSet for event IDs, turns on or off the bits dedicated to events exposed for CM elements of the specified type.
static BitSet	getEventIDSet(int stateChangeID) Returns a BitSet with bits turned on for all events that map to a given state change ID.
static BitSet	getEventIDSet(String elType) Returns a BitSet with bits turned on for all the CM events exposed for the given element type.
static BitSet	getFullEventIDSet() Returns a BitSet with bits turned on for all the CM events exposed on all the CM element types.

Methods inherited from class java.lang.Object

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

Constructor Detail

EboEventHelper

public EboEventHelper()

Method Detail

getEventIDSet

public static BitSet getEventIDSet(String elType)

Returns a BitSet with bits turned on for all the CM events exposed for the given element type.

Parameters:

elType - a CM element type

Returns:

a BitSet with bits turned on for all the CM events exposed for the given element type; null if the type is invalid or no events are defined for the element type

getFullEventIDSet

public static BitSet getFullEventIDSet()

Returns a BitSet with bits turned on for all the CM events exposed on all the CM element types.

Returns:

a BitSet with bits turned on for all the CM events exposed on all the CM element types

getEventIDSet

public static BitSet getEventIDSet(int stateChangeID)

Returns a BitSet with bits turned on for all events that map to a given state change ID.

Parameters:

stateChangeID - a state change ID

Returns:

a BitSet with bits turned on for all events that map to the given state change ID; null if the state change ID is invalid or no events are defined with such a state change ID

See Also:

EboStateChangeEvent

adjustEventIDSet

public static void adjustEventIDSet(BitSet eventIDSet,
                                    String elType,
                                    boolean on)

Given a BitSet for event IDs, turns on or off the bits dedicated to events exposed for CM elements of the specified type.

Parameters:

eventIDSet - the event ID set to adjust

elType - the element type

on - if true, the bits are turned on, otherwise they are turned off

adjustEventIDSet

public static void adjustEventIDSet(BitSet eventIDSet,
                                    int stateChangeID,
                                    boolean on)

Given a BitSet for event IDs, turns on or off the bits dedicated to CM events of the specified state change type.

Parameters:

eventIDSet - the event ID set to adjust

stateChangeID - the state change ID

on - if true, the bits are turned on, otherwise they are turned off

See Also:

EboStateChangeEvent