com.j_spaces.core.client
Class EntryArrivedRemoteEvent

java.lang.Object
  java.util.EventObject
      net.jini.core.event.RemoteEvent
          com.gigaspaces.events.SpaceRemoteEvent
              com.j_spaces.core.client.EntryArrivedRemoteEvent

All Implemented Interfaces:

com.gigaspaces.lrmi.nio.LRMIMethodTrackingIdProvider, Externalizable, Serializable, Cloneable

Direct Known Subclasses:

BatchRemoteEvent

public class EntryArrivedRemoteEvent
extends SpaceRemoteEvent
implements Cloneable, com.gigaspaces.lrmi.nio.LRMIMethodTrackingIdProvider

An EntryArrivedRemoteEvent is sent to a NotifyDelegator object when an entry that matches the delegator's template enters a GigaSpace.

Version:

2.0

Author:

Igor Goldenberg

See Also:

NotifyDelegator, Serialized Form

Field Summary

protected IJSpace	_spaceProxy keep the local ref, incase the notify delegator listener was constructed as listener.
protected String	_templateUID multicast TemplateID, not for serialized stream.

Fields inherited from class com.gigaspaces.events.SpaceRemoteEvent

EMPTY_STRING

Fields inherited from class net.jini.core.event.RemoteEvent

eventID, handback, seqNum, source

Constructor Summary

EntryArrivedRemoteEvent()
Empty constructor.

EntryArrivedRemoteEvent(IJSpace source, long eventID, long seqNum, MarshalledObject handback, com.gigaspaces.internal.transport.IEntryPacket entryPacket, NotifyActionType notifyType, boolean fromReplication, String templateUID, com.gigaspaces.internal.client.QueryResultTypeInternal resultType)
This constructor is reserved for internal usage only.

Method Summary

Object	clone() Returns a shallow copy of this EntryArrivedRemoteEvent instance.
Entry	getEntry() Deprecated. use getObject() instead.
Entry	getEntry(boolean getExternalEntry) Deprecated. use getObject() or getExternalEntry() instead.
com.gigaspaces.internal.transport.IEntryPacket	getEntryPacket() Returns an internal GigaSpaces structure to send/receive entries from the space.
ExternalEntry	getExternalEntry() Deprecated. Since 8.0.1 - ExternalEntry is deprecated since 8.0.
String	getKey()
String	getLRMIMethodTrackingId()
NotifyActionType	getNotifyActionType() Returns a notify type of this event.
int	getNotifyType() Deprecated. since 9.1 use getNotifyActionType() instead.
Object	getObject() Returns the entry by specification of user.
com.j_spaces.core.OperationID	getOperationID()
MarshalledObject	getRegistrationObject() Returns the handback object that was provided as a parameter to the event interest registration method, if any.
Object	getSource() The space on which the Event initially occurred.
Uuid	getSpaceUuid() Returns the unique uid of the space the event originated from.
String	getTemplateUID() returns multicast templateID, TODO remote this support after support TemplateID == NotifySpaceUID
protected boolean	isAcceptableByFilter(String filterID)
boolean	isFromReplication()
protected void	readExternal(ObjectInput in, com.gigaspaces.internal.version.PlatformLogicalVersion version) Reserved for internal usage.
void	setSpaceProxy(IJSpace spaceProxy)
protected void	setSpaceProxyUuid(Uuid spaceProxyUuid)
String	toString()
protected void	writeExternal(ObjectOutput out, com.gigaspaces.internal.version.PlatformLogicalVersion version) Reserved for internal usage.

Methods inherited from class com.gigaspaces.events.SpaceRemoteEvent

readExternal, writeExternal

Methods inherited from class net.jini.core.event.RemoteEvent

getID, getSequenceNumber

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_templateUID

protected String _templateUID

multicast TemplateID, not for serialized stream.

_spaceProxy

protected transient IJSpace _spaceProxy

keep the local ref, incase the notify delegator listener was constructed as listener.

Constructor Detail

EntryArrivedRemoteEvent

public EntryArrivedRemoteEvent()

Empty constructor.

EntryArrivedRemoteEvent

public EntryArrivedRemoteEvent(IJSpace source,
                               long eventID,
                               long seqNum,
                               MarshalledObject handback,
                               com.gigaspaces.internal.transport.IEntryPacket entryPacket,
                               NotifyActionType notifyType,
                               boolean fromReplication,
                               String templateUID,
                               com.gigaspaces.internal.client.QueryResultTypeInternal resultType)

This constructor is reserved for internal usage only.

Method Detail

getEntryPacket

public com.gigaspaces.internal.transport.IEntryPacket getEntryPacket()

Returns an internal GigaSpaces structure to send/receive entries from the space.

Returns:

the EntryPacket

getSource

public Object getSource()

The space on which the Event initially occurred.

Overrides:

getSource in class EventObject

Returns:

The space proxy on which the Event initially occurred.

getOperationID

public com.j_spaces.core.OperationID getOperationID()

getSpaceUuid

public Uuid getSpaceUuid()

Returns the unique uid of the space the event originated from.

Returns:

the unique uid of the space the event originated from.

getExternalEntry

@Deprecated
public ExternalEntry getExternalEntry()
                               throws UnusableEntryException

Deprecated. Since 8.0.1 - ExternalEntry is deprecated since 8.0.

Returns the ExternalEntry that triggered the specified remote event.

Returns:

the ExternalEntry that arrived at the space.

Throws:

UnusableEntryException - One or more fields in the entry cannot be deserialized, or the class for the entry type itself cannot be deserialized.

getEntry

@Deprecated
public Entry getEntry(boolean getExternalEntry)
               throws UnusableEntryException

Deprecated. use getObject() or getExternalEntry() instead.

Returns the entry/ExternalEntry that triggered the specified remote event.

Parameters:

getExternalEntry - if true this method will return ExternalEntry, otherwise Entry Object.

Returns:

the entry that arrived at the space.

Throws:

UnusableEntryException - One or more fields in the entry cannot be deserialized, or the class for the entry type itself cannot be deserialized.

getEntry

@Deprecated
public Entry getEntry()
               throws UnusableEntryException

Deprecated. use getObject() instead.

Returns the entry by specification of user.

Returns:

the entry that arrived at the space.

Throws:

UnusableEntryException - This exception is no longer thrown.

getObject

public Object getObject()
                 throws UnusableEntryException

Returns the entry by specification of user.

Returns:

the entry that arrived at the space.

Throws:

UnusableEntryException - This exception is no longer thrown.

getNotifyType

@Deprecated
public int getNotifyType()

Deprecated. since 9.1 use getNotifyActionType() instead.

Returns a notify type of this event.

Returns:

Returns a notify type of this event.

getNotifyActionType

public NotifyActionType getNotifyActionType()

Returns a notify type of this event.

Returns:

notify type of this event.

Since:

6.0

getRegistrationObject

public MarshalledObject getRegistrationObject()

Returns the handback object that was provided as a parameter to the event interest registration method, if any.

Overrides:

getRegistrationObject in class RemoteEvent

Returns:

the MarshalledObject that was provided as a parameter to the event interest registration method, if any.

setSpaceProxy

public void setSpaceProxy(IJSpace spaceProxy)

clone

public Object clone()

Returns a shallow copy of this EntryArrivedRemoteEvent instance.

Overrides:

clone in class Object

Returns:

A clone of this EntryArrivedRemoteEvent instance.

setSpaceProxyUuid

protected void setSpaceProxyUuid(Uuid spaceProxyUuid)

isAcceptableByFilter

protected boolean isAcceptableByFilter(String filterID)

Returns:

If this event was valid by filter, otherwise false.

getTemplateUID

public String getTemplateUID()

returns multicast templateID, TODO remote this support after support TemplateID == NotifySpaceUID

toString

public String toString()

Overrides:

toString in class EventObject

isFromReplication

public boolean isFromReplication()

Returns:

true if event comes from replication, otherwise false.

getKey

public String getKey()

writeExternal

protected void writeExternal(ObjectOutput out,
                             com.gigaspaces.internal.version.PlatformLogicalVersion version)
                      throws IOException

Description copied from class: SpaceRemoteEvent

Reserved for internal usage.

Overrides:

writeExternal in class SpaceRemoteEvent

Throws:

IOException

readExternal

protected void readExternal(ObjectInput in,
                            com.gigaspaces.internal.version.PlatformLogicalVersion version)
                     throws IOException,
                            ClassNotFoundException

Description copied from class: SpaceRemoteEvent

Reserved for internal usage.

Overrides:

readExternal in class SpaceRemoteEvent

Throws:

IOException

ClassNotFoundException

getLRMIMethodTrackingId

public String getLRMIMethodTrackingId()

Specified by:

getLRMIMethodTrackingId in interface com.gigaspaces.lrmi.nio.LRMIMethodTrackingIdProvider