Package org.ikasan.spec.systemevent

Interface SystemEventService<EVENT>

  • public interface SystemEventService<EVENT>
    SystemFlowEvent service interface
    Author:
    Ikasan Development Team

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void housekeep()
      Cleanup all expired system events
      org.ikasan.spec.search.PagedSearchResult<EVENT> listSystemEvents​(int pageNo, int pageSize, java.lang.String orderBy, boolean orderAscending, java.lang.String subject, java.lang.String action, java.util.Date timestampFrom, java.util.Date timestampTo, java.lang.String actor)
      Performs a paged search for SystemFlowEvents restricting by criteria fields as supplied
      java.util.List<EVENT> listSystemEvents​(java.util.List<java.lang.String> subjects, java.lang.String actor, java.util.Date timestampFrom, java.util.Date timestampTo)
      This method returns a list of SystemEvents based on subjects and actor within a certain date range.
      void logSystemEvent​(java.lang.String subject, java.lang.String action, java.lang.String actor)
      Logs some system level happening
      void logSystemEvent​(java.lang.String moduleName, java.lang.String subject, java.lang.String action, java.lang.String actor)
      Logs some system level happening

    • Method Detail

      • logSystemEvent

        void logSystemEvent​(java.lang.String moduleName,
                    java.lang.String subject,
                    java.lang.String action,
                    java.lang.String actor)
        Logs some system level happening
        Parameters:
        subject - - the module name where the event is taking place
        subject - - system level entity that has been affected
        action - - what has happened
        actor - - who/what was driving the happening

      • logSystemEvent

        void logSystemEvent​(java.lang.String subject,
                    java.lang.String action,
                    java.lang.String actor)
        Logs some system level happening
        Parameters:
        subject - - system level entity that has been affected
        action - - what has happened
        actor - - who/what was driving the happening

      • listSystemEvents

        org.ikasan.spec.search.PagedSearchResult<EVENT> listSystemEvents​(int pageNo,
                                                                 int pageSize,
                                                                 java.lang.String orderBy,
                                                                 boolean orderAscending,
                                                                 java.lang.String subject,
                                                                 java.lang.String action,
                                                                 java.util.Date timestampFrom,
                                                                 java.util.Date timestampTo,
                                                                 java.lang.String actor)
        Performs a paged search for SystemFlowEvents restricting by criteria fields as supplied
        Parameters:
        pageNo - - page control field - page no of results to return
        pageSize - - page control field - size of page
        orderBy - - page control - field to order by
        orderAscending - - page control field - true/false results in ascending order with respect to orderBy field
        subject - - criteria field - filter for exact match on subject
        action - - criteria field - filter for exact match on action
        timestampFrom - - criteria field - filter for events with timestamp greater than this value
        timestampTo - - criteria field - filter for events with timestamp less than this value
        actor - - criteria field - filter for exact match on actor
        Returns:
        PagedSearchResult - page friendly search result subset

      • listSystemEvents

        java.util.List<EVENT> listSystemEvents​(java.util.List<java.lang.String> subjects,
                                       java.lang.String actor,
                                       java.util.Date timestampFrom,
                                       java.util.Date timestampTo)
        This method returns a list of SystemEvents based on subjects and actor within a certain date range.
        Parameters:
        subjects -
        actor -
        timestampFrom -
        timestampTo -
        Returns:

      • housekeep

        void housekeep()
        Cleanup all expired system events