org.openspaces.events.notify

Annotation Type Notify

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Component
public @interface Notify

Marks an event listener as polled event listener. It will be wrapped automtically with SimpleNotifyEventListenerContainer.

Template can be provided using EventTemplate marked on a general method that returns the template.

The event listener method should be marked with SpaceDataEvent.

Author:

kimchy

See Also:

TransactionalEvent, NotifyBatch, NotifyLease, NotifyType

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoStart Set whether this container will start once instantiated.
boolean	durable
boolean	fifo
String	gigaSpace The name of the bean that is the GigaSpace this container will use.
boolean	guaranteed Deprecated.
boolean	ignoreEventOnNullTake
Class<INotifyDelegatorFilter>	notifyFilter
boolean	passArrayAsIs When batching is turned on, should the batch of events be passed as an Object[] to the listener.
boolean	performSnapshot
boolean	performTakeOnNotify
ReplicateNotifyTemplateType	replicateNotifyTemplate
String	tag A tag can be supplied to identify a durable notification listener endpoint for debug/auditing purposes.
TriggerNotifyTemplateType	triggerNotifyTemplate
String	value The value may indicate a suggestion for a logical component name, to be turned into a Spring bean in case of an autodetected component.

Element Detail

value

public abstract String value

The value may indicate a suggestion for a logical component name, to be turned into a Spring bean in case of an autodetected component.

Returns:

the suggested component name, if any

Default:

""

gigaSpace

public abstract String gigaSpace

The name of the bean that is the GigaSpace this container will use.

Note, this is optional. If there is only one GigaSpace defined in the application context, it will be used.

Default:

""

performSnapshot

public abstract boolean performSnapshot

See Also:

AbstractEventListenerContainer.setPerformSnapshot(boolean)

Default:

true

performTakeOnNotify

public abstract boolean performTakeOnNotify

See Also:

SimpleNotifyEventListenerContainer.setPerformTakeOnNotify(boolean)

Default:

false

ignoreEventOnNullTake

public abstract boolean ignoreEventOnNullTake

See Also:

SimpleNotifyEventListenerContainer.setIgnoreEventOnNullTake(boolean)

Default:

false

guaranteed

@Deprecated
public abstract boolean guaranteed

Deprecated.

See Also:

SimpleNotifyEventListenerContainer.setGuaranteed(Boolean)

Default:

false

durable

public abstract boolean durable

See Also:

SimpleNotifyEventListenerContainer.setDurable(Boolean)

Default:

false

tag

public abstract String tag

A tag can be supplied to identify a durable notification listener endpoint for debug/auditing purposes. The tag is attached to the replication statistics and outgoing channel of durable notifications.

Returns:

A name/id/tag to identify this durable notification listener endpoint.

Since:

14.5

Default:

""

fifo

public abstract boolean fifo

See Also:

SimpleNotifyEventListenerContainer.setFifo(boolean)

Default:

false

passArrayAsIs

public abstract boolean passArrayAsIs

When batching is turned on, should the batch of events be passed as an Object[] to the listener. Default to false which means it will be passed one event at a time.

See Also:

SimpleNotifyEventListenerContainer.setPassArrayAsIs(boolean)

Default:

false

notifyFilter

public abstract Class<INotifyDelegatorFilter> notifyFilter

See Also:

SimpleNotifyEventListenerContainer.setNotifyFilter(com.j_spaces.core.client.INotifyDelegatorFilter)

Default:

com.j_spaces.core.client.INotifyDelegatorFilter.class

autoStart

public abstract boolean autoStart

Set whether this container will start once instantiated.

Default is true. Set to false in order for this container to be started using AbstractEventListenerContainer.start().

Default:

true

replicateNotifyTemplate

public abstract ReplicateNotifyTemplateType replicateNotifyTemplate

See Also:

SimpleNotifyEventListenerContainer.setReplicateNotifyTemplate(boolean)

Default:

org.openspaces.events.notify.ReplicateNotifyTemplateType.DEFAULT

triggerNotifyTemplate

public abstract TriggerNotifyTemplateType triggerNotifyTemplate

See Also:

SimpleNotifyEventListenerContainer.setTriggerNotifyTemplate(boolean)

Default:

org.openspaces.events.notify.TriggerNotifyTemplateType.DEFAULT