GigaSpaces XAP 9.0 API

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
 boolean autoStart
          Set whether this container will start once instantiated.
 NotifyComType commType
           
 boolean durable
           
 boolean fifo
           
 String gigaSpace
          The name of the bean that that is the GigaSpace this container will used.
 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
           
 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.
 

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 that is the GigaSpace this container will used.

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:
AbstractTemplateEventListenerContainer.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:
AbstractNotifyEventListenerContainer.setGuaranteed(Boolean)
Default:
false

durable

public abstract boolean durable
See Also:
AbstractNotifyEventListenerContainer.setDurable(Boolean)
Default:
false

commType

public abstract NotifyComType commType
See Also:
AbstractNotifyEventListenerContainer.setComType(int)
Default:
org.openspaces.events.notify.NotifyComType.UNICAST

fifo

public abstract boolean fifo
See Also:
AbstractNotifyEventListenerContainer.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:
AbstractNotifyEventListenerContainer.setPassArrayAsIs(boolean)
Default:
false

notifyFilter

public abstract Class<INotifyDelegatorFilter> notifyFilter
See Also:
AbstractNotifyEventListenerContainer.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 AbstractSpaceListeningContainer.start().

Default:
true

replicateNotifyTemplate

public abstract ReplicateNotifyTemplateType replicateNotifyTemplate
See Also:
AbstractNotifyEventListenerContainer.setReplicateNotifyTemplate(boolean)
Default:
org.openspaces.events.notify.ReplicateNotifyTemplateType.DEFAULT

triggerNotifyTemplate

public abstract TriggerNotifyTemplateType triggerNotifyTemplate
See Also:
AbstractNotifyEventListenerContainer.setTriggerNotifyTemplate(boolean)
Default:
org.openspaces.events.notify.TriggerNotifyTemplateType.DEFAULT

GigaSpaces XAP 9.0 API

Copyright © GigaSpaces.