com.gigaspaces.internal.transport

Class EntryPacket

java.lang.Object

com.gigaspaces.internal.serialization.AbstractExternalizable

com.gigaspaces.internal.transport.AbstractEntryPacket

com.gigaspaces.internal.transport.EntryPacket

All Implemented Interfaces:

RawEntry, ISwapExternalizable, IEntryPacket, ITransportPacket, Textualizable, SmartExternalizable, Externalizable, Serializable, Cloneable

Direct Known Subclasses:

ExternalEntryPacket, JoinedEntry, TemplatePacket

public class EntryPacket
extends AbstractEntryPacket

This class represents a packet of information transmitted between a J-Space client and its J-Space server (and vice versa).

The information transmitted is composed of 2 types: information on the entry's class, and information on the entry's data (the fields' values). Since the protocol between J-Space client and server are designed for minimum data passing, most of the fields in an EntryPacket are usually null (they are transmitted once for each entry class in a client's life-time).

All the fields in this class are public, in order to increase access and modification speed (no need to call a method).

Version:

1.0

Author:

Igor Goldenberg

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_returnOnlyUIDs
protected String	_typeName

Fields inherited from class com.gigaspaces.internal.transport.AbstractEntryPacket

_entryType, _entryTypeCode, _typeDesc, _typeDescChecksum

Constructor Summary

Constructors

Modifier	Constructor and Description
	EntryPacket() Default constructor required by Externalizable.
	EntryPacket(ITypeDesc typeDesc, EntryType entryType, Object[] fixedProperties, Map<String,Object> dynamicProperties, String uid, int version, long timeToLive, boolean isTransient)
protected	EntryPacket(ITypeDesc typeDesc, Object[] values)

Method Summary

Modifier and Type	Method and Description
IEntryPacket	clone() Returns a shallow copy of this EntryPacket instance.
ICustomQuery	getCustomQuery()
Map<String,Object>	getDynamicProperties()
Object	getFieldValue(int index)
Object[]	getFieldValues()
String[]	getMultipleUIDs()
TransportPacketType	getPacketType()
long	getTTL()
String	getTypeName()
String	getUID()
int	getVersion()
boolean	hasFixedPropertiesArray() true if the entry packet has an array of fixed properties
boolean	isFifo()
boolean	isNoWriteLease()
boolean	isReturnOnlyUids()
boolean	isTransient()
protected void	readExternal(ObjectInput in, PlatformLogicalVersion version)
void	readFromSwap(ObjectInput in)
void	setCustomQuery(ICustomQuery customQuery)
void	setDynamicProperties(Map<String,Object> dynamicProperties)
void	setFieldsValues(Object[] values)
void	setFieldValue(int index, Object value)
void	setMultipleUIDs(String[] multipleUIDs)
void	setReturnOnlyUIDs(boolean returnOnlyUIDs)
void	setTTL(long ttl)
void	setUID(String uid)
void	setVersion(int version)
protected void	writeExternal(ObjectOutput out, PlatformLogicalVersion version)
void	writeToSwap(ObjectOutput out)

Methods inherited from class com.gigaspaces.internal.transport.AbstractEntryPacket

equals, getCodebase, getEntryType, getExternalEntryImplClassName, getID, getOperationID, getPreviousVersion, getPropertyValue, getRoutingFieldValue, getTypeDescChecksum, getTypeDescriptor, hashCode, hasPreviousVersion, isExternalizableEntryPacket, isSerializeTypeDesc, readExternalImpl, setOperationID, setPreviousVersion, setPropertyValue, setSerializeTypeDesc, setTypeDesc, supportsTypeDescChecksum, toObject, toObject, toObject, toObject, toString, toText, validateStorageType, writeExternalImpl

Methods inherited from class com.gigaspaces.internal.serialization.AbstractExternalizable

readExternal, writeExternal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gigaspaces.internal.transport.IEntryPacket

allNullFieldValues, isHybrid

Methods inherited from interface com.gigaspaces.serialization.SmartExternalizable

enabledSmartExternalizableWithReference

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Field Detail

_typeName

protected String _typeName

_returnOnlyUIDs

protected boolean _returnOnlyUIDs

Constructor Detail

EntryPacket

public EntryPacket()

Default constructor required by Externalizable.

EntryPacket

public EntryPacket(ITypeDesc typeDesc,
                   EntryType entryType,
                   Object[] fixedProperties,
                   Map<String,Object> dynamicProperties,
                   String uid,
                   int version,
                   long timeToLive,
                   boolean isTransient)

EntryPacket

protected EntryPacket(ITypeDesc typeDesc,
                      Object[] values)

Method Detail

clone

public IEntryPacket clone()

Returns a shallow copy of this EntryPacket instance. And also only clone the values array.

Specified by:

clone in interface IEntryPacket

Overrides:

clone in class AbstractEntryPacket

Returns:

a shallow clone of this EntryPacket instance.

getPacketType

public TransportPacketType getPacketType()

getTypeName

public String getTypeName()

getUID

public String getUID()

setUID

public void setUID(String uid)

getMultipleUIDs

public String[] getMultipleUIDs()

setMultipleUIDs

public void setMultipleUIDs(String[] multipleUIDs)

isReturnOnlyUids

public boolean isReturnOnlyUids()

setReturnOnlyUIDs

public void setReturnOnlyUIDs(boolean returnOnlyUIDs)

getDynamicProperties

public Map<String,Object> getDynamicProperties()

setDynamicProperties

public void setDynamicProperties(Map<String,Object> dynamicProperties)

getFieldValues

public Object[] getFieldValues()

setFieldsValues

public void setFieldsValues(Object[] values)

getFieldValue

public Object getFieldValue(int index)

setFieldValue

public void setFieldValue(int index,
                          Object value)

isTransient

public boolean isTransient()

isFifo

public boolean isFifo()

getVersion

public int getVersion()

setVersion

public void setVersion(int version)

getTTL

public long getTTL()

setTTL

public void setTTL(long ttl)

isNoWriteLease

public boolean isNoWriteLease()

getCustomQuery

public ICustomQuery getCustomQuery()

setCustomQuery

public void setCustomQuery(ICustomQuery customQuery)

writeToSwap

public void writeToSwap(ObjectOutput out)
                 throws IOException

Specified by:

writeToSwap in interface ISwapExternalizable

Overrides:

writeToSwap in class AbstractEntryPacket

Throws:

IOException

readFromSwap

public void readFromSwap(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readFromSwap in interface ISwapExternalizable

Overrides:

readFromSwap in class AbstractEntryPacket

Throws:

IOException

ClassNotFoundException

writeExternal

protected void writeExternal(ObjectOutput out,
                             PlatformLogicalVersion version)
                      throws IOException

Overrides:

writeExternal in class AbstractEntryPacket

Throws:

IOException

readExternal

protected void readExternal(ObjectInput in,
                            PlatformLogicalVersion version)
                     throws IOException,
                            ClassNotFoundException

Overrides:

readExternal in class AbstractEntryPacket

Throws:

IOException

ClassNotFoundException

hasFixedPropertiesArray

public boolean hasFixedPropertiesArray()

true if the entry packet has an array of fixed properties

Specified by:

hasFixedPropertiesArray in interface IEntryPacket

Overrides:

hasFixedPropertiesArray in class AbstractEntryPacket