Interface PayloadBus
-
- All Superinterfaces:
org.refcodes.eventbus.DispatchStrategyAccessor
,org.refcodes.observer.EventMatcher<ApplicationEvent>
,org.refcodes.eventbus.GenericBusObservable<ApplicationEvent,org.refcodes.observer.Observer<ApplicationEvent>,ApplicationMatcher,java.lang.String>
,org.refcodes.eventbus.GenericBusPublisher<ApplicationEvent>
,org.refcodes.eventbus.GenericEventBus<ApplicationEvent,org.refcodes.observer.Observer<ApplicationEvent>,ApplicationMatcher,org.refcodes.observer.EventMetaData,java.lang.String>
,org.refcodes.component.HandleLookup<java.lang.String,org.refcodes.observer.Observer<ApplicationEvent>>
,org.refcodes.matcher.Matcher<ApplicationEvent>
,org.refcodes.observer.Publisher<ApplicationEvent>
- All Known Subinterfaces:
ApplicationBus
,MessagePropertiesBus
- All Known Implementing Classes:
ApplicationBusImpl
public interface PayloadBus extends org.refcodes.eventbus.GenericEventBus<ApplicationEvent,org.refcodes.observer.Observer<ApplicationEvent>,ApplicationMatcher,org.refcodes.observer.EventMetaData,java.lang.String>
ThePayloadBus
extends theApplicationBus
with convenience functionality common to everyday application and service development regarding dispatching of payloads.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default java.lang.String
onPayload(java.lang.Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.default java.lang.String
onPayload(java.lang.Enum<?> aAction, java.lang.Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.default java.lang.String
onPayload(java.lang.Enum<?> aAction, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.default java.lang.String
onPayload(java.lang.Enum<?> aAction, java.lang.String aChannel, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.default java.lang.String
onPayload(java.lang.Enum<?> aAction, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.default java.lang.String
onPayload(java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.default java.lang.String
onPayload(java.lang.String aChannel, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.default java.lang.String
onPayload(org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.Class<?> aPublisherType)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.String aChannel)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, org.refcodes.observer.EventMetaData aEventMetaData)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(java.lang.Enum<?> aAction, P aPayload, org.refcodes.observer.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, java.lang.Class<?> aPublisherType)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, java.lang.Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, java.lang.String aChannel)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, java.lang.String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, org.refcodes.observer.EventMetaData aEventMetaData)
Publishes an event with the provided payload and the given attributes.default <P> void
publishPayload(P aPayload, org.refcodes.observer.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.-
Methods inherited from interface org.refcodes.eventbus.GenericBusObservable
subscribe, subscribe, subscribe, unsubscribeAll
-
Methods inherited from interface org.refcodes.eventbus.GenericEventBus
onAction, onAction, onActions, onActions, onAlias, onAlias, onCatchAll, onChannel, onChannel, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onGroup, onGroup, onType, onUniversalId, onUniversalId, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent
-
-
-
-
Method Detail
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.Class<?> aPublisherType)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which this represents.aPayload
- The payload to be carried by the event.aPublisherType
- The type of the event publisher.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.String aChannel)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which this represents.aPayload
- The payload to be carried by the event.aChannel
- The channel name on which the event is receivable.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which this represents.aPayload
- The payload to be carried by the event.aAlias
- The alias property.aGroup
- The group property.aChannel
- The channel property.aUid
- The UID (Universal-ID) property.aPublisherType
- The type of the event publisher.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, org.refcodes.observer.EventMetaData aEventMetaData)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which the event represents.aPayload
- The payload to be carried by the event.aEventMetaData
- The Meta-Data to by supplied by the event.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which the event represents.aPayload
- The payload to be carried by the event.
-
publishPayload
default <P> void publishPayload(P aPayload, java.lang.Class<?> aPublisherType)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aPublisherType
- The type of the event publisher.
-
publishPayload
default <P> void publishPayload(P aPayload, java.lang.String aChannel)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aChannel
- The channel name on which the event is receivable.
-
publishPayload
default <P> void publishPayload(P aPayload, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aAlias
- The alias property.aGroup
- The group property.aChannel
- The channel property.aUid
- The UID (Universal-ID) property.aPublisherType
- The type of the event publisher.
-
publishPayload
default <P> void publishPayload(P aPayload, org.refcodes.observer.EventMetaData aEventMetaData)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aEventMetaData
- The Meta-Data to by supplied by the event.
-
publishPayload
default <P> void publishPayload(P aPayload)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which this represents.aPayload
- The payload to be carried by the event.aPublisherType
- The type of the event publisher.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which this represents.aPayload
- The payload to be carried by the event.aChannel
- The channel name on which the event is receivable.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which this represents.aPayload
- The payload to be carried by the event.aAlias
- The alias property.aGroup
- The group property.aChannel
- The channel property.aUid
- The UID (Universal-ID) property.aPublisherType
- The type of the event publisher.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, org.refcodes.observer.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which the event represents.aPayload
- The payload to be carried by the event.aEventMetaData
- The Meta-Data to by supplied by the event.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(java.lang.Enum<?> aAction, P aPayload, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aAction
- The action which the event represents.aPayload
- The payload to be carried by the event.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(P aPayload, java.lang.Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aPublisherType
- The type of the event publisher.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(P aPayload, java.lang.String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aChannel
- The channel name on which the event is receivable.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(P aPayload, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aAlias
- The alias property.aGroup
- The group property.aChannel
- The channel property.aUid
- The UID (Universal-ID) property.aPublisherType
- The type of the event publisher.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(P aPayload, org.refcodes.observer.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aEventMetaData
- The Meta-Data to by supplied by the event.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
publishPayload
default <P> void publishPayload(P aPayload, org.refcodes.eventbus.DispatchStrategy aStrategy)
Publishes an event with the provided payload and the given attributes.- Type Parameters:
P
- The type of the payload to carry.- Parameters:
aPayload
- The payload to be carried by the event.aStrategy
- TheDispatchStrategy
to use when dispatching the event.
-
onPayload
default java.lang.String onPayload(org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances.- Parameters:
aObserver
- The observer to be notified.- Returns:
- A handle to unsubscribe this combination.
-
onPayload
default java.lang.String onPayload(java.lang.Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.- Parameters:
aPublisherType
- The type of the event publisher.aObserver
- The observer to be notified.- Returns:
- A handle to unsubscribe this combination.
-
onPayload
default java.lang.String onPayload(java.lang.String aChannel, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.- Parameters:
aChannel
- The channel name on which the event is receivable.aObserver
- The observer to be notified.- Returns:
- A handle to unsubscribe this combination.
-
onPayload
default java.lang.String onPayload(java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.- Parameters:
aAlias
- The alias property.aGroup
- The group property.aChannel
- The channel property.aUid
- The UID (Universal-ID) property.aPublisherType
- The type of the event publisher.aObserver
- The observer to be notified.- Returns:
- A handle to unsubscribe this combination.
-
onPayload
default java.lang.String onPayload(java.lang.Enum<?> aAction, java.lang.Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.- Parameters:
aAction
- The action property.aPublisherType
- The type of the event publisher.aObserver
- The observer to be notified.- Returns:
- A handle to unsubscribe this combination.
-
onPayload
default java.lang.String onPayload(java.lang.Enum<?> aAction, java.lang.String aChannel, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.- Parameters:
aAction
- The action property.aChannel
- The channel name on which the event is receivable.aObserver
- The observer to be notified.- Returns:
- A handle to unsubscribe this combination.
-
onPayload
default java.lang.String onPayload(java.lang.Enum<?> aAction, java.lang.String aAlias, java.lang.String aGroup, java.lang.String aChannel, java.lang.String aUid, java.lang.Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes.- Parameters:
aAction
- The action property.aAlias
- The alias property.aGroup
- The group property.aChannel
- The channel property.aUid
- The UID (Universal-ID) property.aPublisherType
- The type of the event publisher.aObserver
- The observer to be notified.- Returns:
- A handle to unsubscribe this combination.
-
onPayload
default java.lang.String onPayload(java.lang.Enum<?> aAction, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
Similar to the more generic methodGenericBusObservable.subscribe(EventMatcher, Observer)
THOUGH subscribes forPayloadBusEvent
instances with the given attributes. YourObservable
may be of the required type!- Parameters:
aAction
- The action property.aObserver
- The observer to be notified.- Returns:
- A handle to unsubscribe this combination.
-
-