com.j_spaces.core.client
Class NotifyDelegator

java.lang.Object
  com.j_spaces.core.client.NotifyDelegator

All Implemented Interfaces:

com.gigaspaces.events.batching.BatchRemoteEventListener, Remote, EventListener, RemoteEventListener

Deprecated. Use EventSessionFactory instead.

@Deprecated
public class NotifyDelegator
extends Object
implements com.gigaspaces.events.batching.BatchRemoteEventListener

Just like the call to JavaSpace.notify(), it serves to register interest in matching entries for a specific period of time. If a matching entry is written to the space before the notification request expires, then the notify() method on the given event listener will be called. In comparison to JavaSpace.notify() there is no need to set the client codebase. Both clients and server agree on this proxy object to be used for notifications.

1. Registering for notifications

We use com.j_spaces.core.client.NotifyModifiers as the notification interest. You could either register for all notifications with NotifyModifiers.NOTIFY_ALL or you could use bitwise or operator "|" and have several notifications: e.g. NotifyModifiers.NOTIFY_WRITE | NotifyModifiers.NOTIFY_READ

 NotifyDelegator ntfyDelegator =
        new NotifyDelegator((IJSpace) spaceProxy,
                                new MyEntry(),
                                theTransaction,
                                theListener,
                                Lease.FOREVER,
                                null,
                                fifoEnabled,
                                NotifyModifiers.NOTIFY_ALL);
 

theListener has to implement RemoteEventListener and its inherited method notify().
theTransaction could be either a null transaction or an obtained one from a TransactionManager.

2. The notification event

When new entries that match the template arrive at the space, the supplied listener's notify() method will be called by the delegator. From the notification event you can access the entry that triggered the event in the space, and act upon each interested notification.

 public void notify(RemoteEvent event)
 {
        EntryArrivedRemoteEvent arrivedRemoteEvent = (EntryArrivedRemoteEvent)event;
        int notifyType = arrivedRemoteEvent.getNotifyType();

        // section for write notifications
        if (notifyType == NotifyModifiers.NOTIFY_WRITE)
        {
                MyEntry myEntry = (MyEntry)((EntryArrivedRemoteEvent)event).getEntry();
                ...
        }
 }
 

3. Canceling the registration

In order to cancel the notify registration, you can use the Event Registration object of this delegator:

 ntfyDelegator.getEventRegistration().getLease().cancel();
 

4. Closing the listener

Leasing does not close the NotifyDelegator once the lease expires. Although no notifications will be delegated, it is good practice to close any excess resources.

 ntfyDelegator.close()
 

Version:

4.0

See Also:

EntryArrivedRemoteEvent

Constructor Summary

NotifyDelegator(IJSpace space, Object template, Transaction txn, long lease, com.gigaspaces.events.NotifyInfo info)
Deprecated. Creates a new delegator that can receive ordered notifications.

NotifyDelegator(IJSpace space, Object template, Transaction txn, RemoteEventListener listener, long lease, MarshalledObject handback, boolean fifoEnabled, int notifyMask)
Deprecated. Creates a new delegator that can receive ordered notifications.

Method Summary

void	close() Deprecated. Cancels all the registered notify template and un-exports this instance of NotifyDelegator.
protected void	finalize() Deprecated.
com.gigaspaces.events.GSEventRegistration	getEventRegistration() Deprecated. Returns an EventRegistration object that can be used to cancel or renew the notification lease, to get the unique id of the registration, to get the sequence number at the time of registration and the space that is the source of the registration.
IJSpace	getSpace() Deprecated. Returns space proxy or null if NotifyDelegator was constructed as listener, not via constructor with spaceProxy as parameter.
void	notify(RemoteEvent event) Deprecated. Notify the listener about an event.
void	notifyBatch(com.gigaspaces.events.batching.BatchRemoteEvent theEvents) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotifyDelegator

public NotifyDelegator(IJSpace space,
                       Object template,
                       Transaction txn,
                       RemoteEventListener listener,
                       long lease,
                       MarshalledObject handback,
                       boolean fifoEnabled,
                       int notifyMask)
                throws TransactionException,
                       RemoteException

Deprecated.

Creates a new delegator that can receive ordered notifications.

Parameters:

space - the space to register for notification.

template - the template to use for notification.

txn - the transaction to use for notification.

listener - user supplied listener (implementing RemoteEventListener).

lease - the lease of the notification template.

handback - the handback to use for notification.

fifoEnabled - enables/disables ordered notifications.

notifyMask - Available Notify Types: NotifyModifiers.NOTIFY_WRITE NotifyModifiers.NOTIFY_UPDATE NotifyModifiers.NOTIFY_TAKE NotifyModifiers.NOTIFY_LEASE_EXPIRATION NotifyModifiers.NOTIFY_ALL NotifyDelegator nd = new NotifyDelegator(space, template, transaction, listener, Lease.FOREVER, handback, true, NotifyModifiers.NOTIFY_WRITE | NotifyModifiers.NOTIFY_TAKE );

Throws:

TransactionException - if the transaction is not valid

RemoteException - if a communication error occurs

See Also:

NotifyModifiers

NotifyDelegator

public NotifyDelegator(IJSpace space,
                       Object template,
                       Transaction txn,
                       long lease,
                       com.gigaspaces.events.NotifyInfo info)
                throws TransactionException,
                       RemoteException

Deprecated.

Creates a new delegator that can receive ordered notifications.

Parameters:

space - the space to register for notification.

template - the template to use for notification.

txn - the transaction to use for notification.

lease - the lease of the notification template. NotifyDelegator nd = new NotifyDelegator(space, template, transaction, listener, Lease.FOREVER, handback, true, NotifyModifiers.NOTIFY_WRITE | NotifyModifiers.NOTIFY_TAKE );

Throws:

TransactionException - if the transaction is not valid

RemoteException - if a communication error occurs

See Also:

NotifyModifiers

Method Detail

notify

public void notify(RemoteEvent event)
            throws UnknownEventException,
                   RemoteException

Deprecated.

Description copied from interface: RemoteEventListener

Notify the listener about an event.

The call to notify is synchronous to allow the party making the call to know if the call succeeded. However, it is not part of the semantics of the call that the notification return can be delayed while the recipient of the call reacts to the occurrence of the event. Simply put, the best strategy on the part of the recipient is to note the occurrence in some way and then return from the notify method as quickly as possible.

UnknownEventException is thrown when the recipient does not recognize the combination of the event identifier and the event source as something in which it is interested. Throwing this exception has the effect of asking the sender to not send further notifications of this kind of event from this source in the future.

Specified by:

notify in interface RemoteEventListener

Parameters:

event - the remote event that occurred

Throws:

UnknownEventException - the recipient does not recognize the combination of event identifier and event source

RemoteException

notifyBatch

public void notifyBatch(com.gigaspaces.events.batching.BatchRemoteEvent theEvents)
                 throws UnknownEventException,
                        RemoteException

Deprecated.

Specified by:

notifyBatch in interface com.gigaspaces.events.batching.BatchRemoteEventListener

Throws:

UnknownEventException

RemoteException

getEventRegistration

public com.gigaspaces.events.GSEventRegistration getEventRegistration()

Deprecated.

Returns an EventRegistration object that can be used to cancel or renew the notification lease, to get the unique id of the registration, to get the sequence number at the time of registration and the space that is the source of the registration.

Returns:

the EventRegistration object returned from calling notify() on the space.

getSpace

public IJSpace getSpace()

Deprecated.

Returns space proxy or null if NotifyDelegator was constructed as listener, not via constructor with spaceProxy as parameter.

Returns:

space proxy.

close

public void close()

Deprecated.

Cancels all the registered notify template and un-exports this instance of NotifyDelegator.

finalize

protected void finalize()
                 throws Throwable

Deprecated.

Overrides:

finalize in class Object

Throws:

Throwable