Package de.hybris.platform.servicelayer.event.events

Class AbstractEvent

java.lang.Object
java.util.EventObject
org.springframework.context.ApplicationEvent
de.hybris.platform.servicelayer.event.events.AbstractEvent
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AbstractCommerceUserEvent, AbstractConsentEvent, AbstractCronJobEvent, AbstractDataImportEvent, AbstractLoginEvent, AbstractPersistenceEvent, AbstractProcessEvent, AbstractSyncEvent, AbstractTrackingEvent, AbstractWebserviceActionEvent, AfterInitializationEndEvent, AfterInitializationStartEvent, AfterSessionAttributeChangeEvent, AfterSessionCreationEvent, AfterSessionUserChangeEvent, AfterTenantInitializationClusterAwareEvent, AfterTenantRestartClusterAwareEvent, AfterTenantRestartEvent, AnonymousConsentChangeEvent, ApprovalProcessCompleteEvent, ApprovalProcessStartEvent, BackofficeEvent, BackofficeRoleUpdatedClusterAwareEvent, BaseWebhookEvent, BeforeSessionCloseEvent, CancelFinishedEvent, CancelPendingEvent, ConsignmentProcessingEvent, CreateReturnEvent, CronJobInfoEvent, DatahubAdapterImportEvent, DynamicProcessEvent, EventExportDisabledEvent, EventExportEnabledEvent, EventExportFailedEvent, ExportDataEvent, InvalidateCertificateCredentialsCacheEvent, InvalidateCharonCacheEvent, InvalidateConsumptionLayerUserSegmentsProviderCacheEvent, InvalidateModelConverterRegistryEvent, ItemSavedEvent, KieModuleSwappingEvent, MerchantApprovedEvent, MerchantRejectedEvent, OrderApprovalRejectionEvent, OrderApprovedEvent, OrderFraudEmployeeNotificationEvent, OrderPendingApprovalEvent, OrderProcessingEvent, OrderRejectedEvent, OutboundSyncEvent, QuoteApprovedEvent, QuoteBuyerOrderPlacedEvent, QuoteRejectedEvent, ReplenishmentOrderConfirmationEvent, RepollEvent, RuleEngineInitializedEvent, RuleEngineModuleSwapCompletedEvent, RulesCompilationInProgressQueryEvent, RulesCompilationInProgressResponseEvent, RuleUpdatedEvent, SendOrderPartiallyCanceledMessageEvent, SendOrderPartiallyRefundedMessageEvent, SendReturnLabelEvent, SessionEvent, SubmitOrderEvent, TestDummyEvent, TestingEvent, TestPerformanceEvent, TestScriptingEvent, UploadDataEvent
public abstract class AbstractEvent extends org.springframework.context.ApplicationEvent
Super class for the hybris event framework which is based on the spring event framework. An event consists of a source object that denotes the origin of the event. The source object is serializable - the original source object of ApplicationEvent is transient. This is needed for sending events in a cluster environment.
See Also:

  • Constructor Details

    • AbstractEvent

      public AbstractEvent()

    • AbstractEvent

      public AbstractEvent(Serializable source)

  • Method Details

    • getSource

      public Object getSource()
      Overrides:
      getSource in class EventObject
      Returns:
      the object on which the Event initially occurred.

    • getScope

      public EventScope getScope()
      Returns:
      the EventScope of this event

    • setScope

      public void setScope(EventScope scope)
      Sets the EventScope for this event.
      Parameters:
      scope - the EventScope to be set

    • toString

      public String toString()
      Overrides:
      toString in class EventObject

    • isFromCluster

      public boolean isFromCluster()
      Returns:
      true if event is from a cluster system. Returns as default false (no cluster system).

    • setFromCluster

      public void setFromCluster(boolean fromCluster)
      If the Event is send by a cluster system (tcp message or udp packet is a hint) this method sets the internal variable to true.
      Parameters:
      fromCluster - default value is false, event is not from a cluster system