kaos.policy.history
Interface HistoryMonitorForwarder

All Known Subinterfaces:

GuardMgmtRequestsForwarder

public interface HistoryMonitorForwarder

This interface defines methods to access logged events of a given HistoryMonitor.

Method Summary

void	deleteAllLogs(java.lang.String historyMonitorID) Ask the specified HistoryMonitor to delete all the events logged so far.
void	deleteLogsforActionType(java.lang.String actionType, java.lang.String historyMonitorID) Ask the specified HistoryMonitor to delete all logged events that contain the given action type.
void	deleteLogsforActor(java.lang.String actorID, java.lang.String historyMonitorID) Ask the specified HistoryMonitor to delete all logged events that contain the given actor.
void	deleteSpecifiedLogs(java.lang.String actionType, java.lang.String actorID, java.lang.String startTime, java.lang.String endTime, java.lang.Boolean latest, java.lang.String historyMonitorID) This method internally calls 'getSpecifiedLogs' with its input parameters and then deletes the logs returned by that call.
java.util.Vector	getAllLogs(java.lang.String historyMonitorID) Ask the specified HistoryMonitor to get all the events logged so far.
java.util.Vector	getLogsforActionType(java.lang.String actionType, java.lang.String historyMonitorID) Ask the specified HistoryMonitor to get all events logged that contain the given action type.
java.util.Vector	getLogsforActor(java.lang.String actorID, java.lang.String historyMonitorID) Ask the specified HistoryMonitor to get all logged events that contain the given actor.
java.util.Vector	getSpecifiedLogs(java.lang.String actionType, java.lang.String actorID, java.lang.String startTime, java.lang.String endTime, java.lang.Boolean latest, java.lang.String historyMonitorID) Ask the specified HistoryMonitor for the logged events specified by the given parameters.
void	logEvent(ActionInstanceDescription event, java.lang.String historyMonitorID) Ask the specified HistoryMonitor to log an event.

Method Detail

logEvent

void logEvent(ActionInstanceDescription event,
              java.lang.String historyMonitorID)

Ask the specified HistoryMonitor to log an event.

Parameters:

event - The event to be logged.

historyMonitorID - A String identifying the specific HistoryMonitor to forward this request to.

getAllLogs

java.util.Vector getAllLogs(java.lang.String historyMonitorID)

Ask the specified HistoryMonitor to get all the events logged so far.

Parameters:

historyMonitorID - A String identifying the specific HistoryMonitor to forward this request to.

Returns:

A Vector containing aid objects logged so far.

deleteAllLogs

void deleteAllLogs(java.lang.String historyMonitorID)

Ask the specified HistoryMonitor to delete all the events logged so far.

Parameters:

historyMonitorID - A String identifying the specific HistoryMonitor to forward this request to.

getLogsforActionType

java.util.Vector getLogsforActionType(java.lang.String actionType,
                                      java.lang.String historyMonitorID)

Ask the specified HistoryMonitor to get all events logged that contain the given action type.

Parameters:

actionType - A String indicating the action type.

historyMonitorID - A String identifying the specific HistoryMonitor to forward this request to.

Returns:

A vector containing aid objects logged for that action.

deleteLogsforActionType

void deleteLogsforActionType(java.lang.String actionType,
                             java.lang.String historyMonitorID)

Ask the specified HistoryMonitor to delete all logged events that contain the given action type.

Parameters:

actionType - A String indicating the action type.

historyMonitorID - A String identifying the specific HistoryMonitor to forward this request to.

getLogsforActor

java.util.Vector getLogsforActor(java.lang.String actorID,
                                 java.lang.String historyMonitorID)

Ask the specified HistoryMonitor to get all logged events that contain the given actor.

Parameters:

actorID - A String indicating the actor id.

historyMonitorID - A String identifying the specific HistoryMonitor to forward this request to.

Returns:

A vector containing aid objects logged for that actor.

deleteLogsforActor

void deleteLogsforActor(java.lang.String actorID,
                        java.lang.String historyMonitorID)

Ask the specified HistoryMonitor to delete all logged events that contain the given actor.

Parameters:

actorID - A String indicating the actor id.

historyMonitorID - A String identifying the specific HistoryMonitor to forward this request to.

getSpecifiedLogs

java.util.Vector getSpecifiedLogs(java.lang.String actionType,
                                  java.lang.String actorID,
                                  java.lang.String startTime,
                                  java.lang.String endTime,
                                  java.lang.Boolean latest,
                                  java.lang.String historyMonitorID)

Ask the specified HistoryMonitor for the logged events specified by the given parameters. The input parameters are interpreted as follows:

Parameters:

actionType - A String indicating the action type of requested logs. If it is null, 'all action types' would be assumed.

actorID - A String indicating the actor of requested logs. If null, 'all actors' would be assumed.

startTime - A long, indicating the start of time period for which logs are requested. If null, 'the begining of logs' time would be assumed.

endTime - A long, indicating the end of time period for which logs are requested. If null, 'time of the latest log' would be assumed.

latest - A boolean, indicating if only latest logs are requested. If it is set: a) start and end time parameters are ignored. b) If actionType is null, and actorID is null, the latest log for each actor is returned. c) If actorID is null and actionType is not null the latest logs for each actor for the given actionType are returned. d) If actorID is not null, the latest log for that actor is returned. If actionType also is not null, the latest log for that actor and that action is returned. If this boolean is not set, log are retrieved based on preceding parameters.

historyMonitorID - A String identifying the specific HistoryMonitor to forward this request to.

deleteSpecifiedLogs

void deleteSpecifiedLogs(java.lang.String actionType,
                         java.lang.String actorID,
                         java.lang.String startTime,
                         java.lang.String endTime,
                         java.lang.Boolean latest,
                         java.lang.String historyMonitorID)

This method internally calls 'getSpecifiedLogs' with its input parameters and then deletes the logs returned by that call. For method documentation, see the heading for 'getSpecifiedLogs'.