Interface Spout<E extends GenericEvent<?>,P,S>

Type Parameters:
E - the type of the object extending GenericEvent to be serialized
P - the type of the payload object
S - the type of the serialized object to be returned by the serialize() method
All Known Implementing Classes:
AccountInsertedSpout, AccountUpdatedSpout, AddressInsertedSpout, AddressUpdatedSpout, AssetDetachedSpout, AssetInsertedSpout, AssetUpdatedSpout, CompanyCreateEventSpoutImpl, CompanyUpdateEventSpoutImpl, DataCollectionTemplateStructureOutcomeRuleInsertedSpout, DataCollectionTemplateStructureOutcomeRuleUpdatedSpout, DCTemplateVisibilityRuleHeaderDeletedSpout, DCTemplateVisibilityRuleHeaderInsertedSpout, DCTemplateVisibilityRuleHeaderUpdatedSpout, DCTemplateVisibilityRuleRowDeletedSpout, DCTemplateVisibilityRuleRowInsertedSpout, JsonSpout, LoggingConfigChangeSpoutImpl, LoginSpoutImpl, LogoutSpoutImpl, MobileFormsSheetInsertedSpout, MobileFormsSheetStatusUpdatedSpout, MobileFormsSheetUpdatedSpout, MobileFormsTemplateStructureReleaseInsertedSpout, SystemConfigChangeSpoutImpl, TechnicalObjectAddressInsertedSpout, TenantConfigChangeSpoutImpl, TenantStartupSpoutImpl, UserCreateEventSpoutImpl, UserTypeCreateEventSpoutImpl, UserTypeUpdateEventSpoutImpl, UserUpdateEventSpoutImpl, WorkOrderHeaderInsertedSpout, WorkOrderHeaderStatusUpdatedSpout, WorkOrderHeaderUpdatedSpout, WorkOrderOperationInsertedSpout, WorkOrderOperationStatusUpdatedSpout, WorkOrderOperationUpdatedSpout

public interface Spout<E extends GenericEvent<?>,P,S>
Serializer for GenericEvent objects.
  • Method Summary

    Modifier and Type
    Method
    Description
    getPayload(PoolKit pk, E event)
    Extracts the payload from the given event using the provided PoolKit.
    serialize(P message)
    Serializes a message, returning an object of generic type.
  • Method Details

    • getPayload

      P getPayload(PoolKit pk, E event) throws SpoutException
      Extracts the payload from the given event using the provided PoolKit.
      Parameters:
      pk - the PoolKit instance used for database operations
      event - the event from which to extract the payload
      Returns:
      the extracted payload of type P
      Throws:
      SpoutException - if an error occurs during payload extraction
    • serialize

      S serialize(P message) throws MessageDispatchException
      Serializes a message, returning an object of generic type.
      Parameters:
      message - the message
      Returns:
      the serialized message.
      Throws:
      MessageDispatchException - the message dispatch exception