Package org.ikasan.spec.wiretap

Interface WiretapDao<IDENTIFIER>

  • public interface WiretapDao<IDENTIFIER>
    Interface for all wiretap event data access.
    Author:
    Ikasan Development Team

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void deleteAllExpired()
      Deletes all WiretapFlowEvents that have surpassed their expiryDate
      WiretapEvent findById​(IDENTIFIER id)
      Find wiretap entry by identifier
      org.ikasan.spec.search.PagedSearchResult<WiretapEvent> findWiretapEvents​(int pageNo, int pageSize, java.lang.String orderBy, boolean orderAscending, java.util.Set<java.lang.String> moduleNames, java.lang.String moduleFlow, java.lang.String componentName, java.lang.String eventId, java.lang.String payloadId, java.util.Date fromDate, java.util.Date untilDate, java.lang.String payloadContent)
      Perform a paged search for WiretapFlowEvents
      org.ikasan.spec.search.PagedSearchResult<WiretapEvent> findWiretapEvents​(int pageNo, int pageSize, java.lang.String orderBy, boolean orderAscending, java.util.Set<java.lang.String> moduleNames, java.util.Set<java.lang.String> moduleFlow, java.util.Set<java.lang.String> componentName, java.lang.String eventId, java.lang.String payloadId, java.util.Date fromDate, java.util.Date untilDate, java.lang.String payloadContent)
      Perform a paged search for WiretapFlowEvents
      java.util.List<WiretapEvent> getHarvestableRecords​(int housekeepingBatchSize)
      Get a List of harvestable wiretaps.
      java.lang.Integer getHousekeepingBatchSize()
      Get the batch size for housekeeping.
      java.lang.Integer getTransactionBatchSize()
      Get the transaction bactch size used for housekeeping.
      boolean housekeepablesExist()
      Method to state that there are housekeepable records available.
      boolean isBatchHousekeepDelete()
      Get flag to indicate if housekeeping is in batch mode.
      void save​(java.util.List<WiretapEvent> wiretapEvents)
      Save a wiretapEvent entry.
      void save​(WiretapEvent wiretapEvent)
      Save a List of wiretapEvent entries.
      void setBatchHousekeepDelete​(boolean batchHousekeepDelete)
      Set flag to indicate if housekeeping is in batch mode.
      void setHarvestQueryOrdered​(boolean isHarvestQueryOrdered)
      Set flag to determine if harvest query should be ordered.
      void setHousekeepingBatchSize​(java.lang.Integer housekeepingBatchSize)
      Set the batch size for housekeeping.
      void setHousekeepQuery​(java.lang.String housekeepQuery)
      Set the housekeeping query.
      void setTransactionBatchSize​(java.lang.Integer transactionBatchSize)
      Set the transaction bactch size used for housekeeping.
      void updateAsHarvested​(java.util.List<WiretapEvent> events)
      Update records as harvested.

    • Method Detail

      • save

        void save​(WiretapEvent wiretapEvent)
        Save a List of wiretapEvent entries.
        Parameters:
        wiretapEvent - - The wiretap event to save

      • save

        void save​(java.util.List<WiretapEvent> wiretapEvents)
        Save a wiretapEvent entry.
        Parameters:
        wiretapEvents - - The wiretap event to save

      • findWiretapEvents

        org.ikasan.spec.search.PagedSearchResult<WiretapEvent> findWiretapEvents​(int pageNo,
                                                                         int pageSize,
                                                                         java.lang.String orderBy,
                                                                         boolean orderAscending,
                                                                         java.util.Set<java.lang.String> moduleNames,
                                                                         java.lang.String moduleFlow,
                                                                         java.lang.String componentName,
                                                                         java.lang.String eventId,
                                                                         java.lang.String payloadId,
                                                                         java.util.Date fromDate,
                                                                         java.util.Date untilDate,
                                                                         java.lang.String payloadContent)
        Perform a paged search for WiretapFlowEvents
        Parameters:
        pageNo - - The page number to retrieve
        pageSize - - The size of the page
        orderBy - - order by field
        orderAscending - - ascending flag
        moduleNames - - The list of module names
        moduleFlow - - The name of Flow internal to the Module
        componentName - - The component name
        eventId - - The event id
        payloadId - - The payload id
        fromDate - - The from date
        untilDate - - The to date
        payloadContent - - The payload content
        Returns:
        PagedSearchResult

      • findWiretapEvents

        org.ikasan.spec.search.PagedSearchResult<WiretapEvent> findWiretapEvents​(int pageNo,
                                                                         int pageSize,
                                                                         java.lang.String orderBy,
                                                                         boolean orderAscending,
                                                                         java.util.Set<java.lang.String> moduleNames,
                                                                         java.util.Set<java.lang.String> moduleFlow,
                                                                         java.util.Set<java.lang.String> componentName,
                                                                         java.lang.String eventId,
                                                                         java.lang.String payloadId,
                                                                         java.util.Date fromDate,
                                                                         java.util.Date untilDate,
                                                                         java.lang.String payloadContent)
        Perform a paged search for WiretapFlowEvents
        Parameters:
        pageNo - - The page number to retrieve
        pageSize - - The size of the page
        orderBy - - order by field
        orderAscending - - ascending flag
        moduleNames - - The list of module names
        moduleFlow - - The name of Flow internal to the Module
        componentName - - The component name
        eventId - - The event id
        payloadId - - The payload id
        fromDate - - The from date
        untilDate - - The to date
        payloadContent - - The payload content
        Returns:
        PagedSearchResult

      • findById

        WiretapEvent findById​(IDENTIFIER id)
        Find wiretap entry by identifier
        Parameters:
        id - - The id to search on
        Returns:
        WiretapFlowEvent

      • deleteAllExpired

        void deleteAllExpired()
        Deletes all WiretapFlowEvents that have surpassed their expiryDate

      • isBatchHousekeepDelete

        boolean isBatchHousekeepDelete()
        Get flag to indicate if housekeeping is in batch mode.
        Returns:

      • setBatchHousekeepDelete

        void setBatchHousekeepDelete​(boolean batchHousekeepDelete)
        Set flag to indicate if housekeeping is in batch mode.
        Parameters:
        batchHousekeepDelete -

      • getHousekeepingBatchSize

        java.lang.Integer getHousekeepingBatchSize()
        Get the batch size for housekeeping.
        Returns:

      • setHousekeepingBatchSize

        void setHousekeepingBatchSize​(java.lang.Integer housekeepingBatchSize)
        Set the batch size for housekeeping.
        Parameters:
        housekeepingBatchSize -

      • getTransactionBatchSize

        java.lang.Integer getTransactionBatchSize()
        Get the transaction bactch size used for housekeeping.
        Returns:

      • setTransactionBatchSize

        void setTransactionBatchSize​(java.lang.Integer transactionBatchSize)
        Set the transaction bactch size used for housekeeping.
        Parameters:
        transactionBatchSize -

      • housekeepablesExist

        boolean housekeepablesExist()
        Method to state that there are housekeepable records available.
        Returns:

      • getHarvestableRecords

        java.util.List<WiretapEvent> getHarvestableRecords​(int housekeepingBatchSize)
        Get a List of harvestable wiretaps.
        Parameters:
        housekeepingBatchSize -
        Returns:

      • setHousekeepQuery

        void setHousekeepQuery​(java.lang.String housekeepQuery)
        Set the housekeeping query.
        Parameters:
        housekeepQuery -

      • updateAsHarvested

        void updateAsHarvested​(java.util.List<WiretapEvent> events)
        Update records as harvested.
        Parameters:
        events -

      • setHarvestQueryOrdered

        void setHarvestQueryOrdered​(boolean isHarvestQueryOrdered)
        Set flag to determine if harvest query should be ordered.
        Parameters:
        isHarvestQueryOrdered -