Package com.gigaspaces.internal.sync

Class SynchronizationStorageAdapter

java.lang.Object

com.gigaspaces.internal.sync.SynchronizationStorageAdapter

All Implemented Interfaces:

IStorageAdapter

public class SynchronizationStorageAdapter
extends Object
implements IStorageAdapter

Since:

9.5

Author:

idan, eitany

Constructor Summary

Constructors

Constructor	Description
SynchronizationStorageAdapter(SpaceEngine engine, SpaceDataSource spaceDataSource, SpaceSynchronizationEndpoint synchronizationEndpointInterceptor)

Method Summary

Modifier and Type	Method	Description
void	addIndexes(String typeName, SpaceIndex[] indexes)
void	commit(ServerTransaction xtn, boolean anyUpdates)	Performs commit to transaction- delete taken entries, commit new entries.
int	count(ITemplateHolder template, String[] subClasses)	Returns the number of entries that match the template.
Class<?>	getDataClass()
Map<String,IEntryHolder>	getEntries(Context context, Object[] ids, String typeName, IEntryHolder[] templates)	Gets a map of entries from the storage adapter
IEntryHolder	getEntry(Context context, String uid, String typeName, IEntryHolder template)	Gets an entry object from the storage adapter.
SpaceSynchronizationEndpoint	getSynchronizationInterceptor()
void	initialize()	Initializes the SA for work (first API called by engine)
ISAdapterIterator<?>	initialLoad(Context context, ITemplateHolder template, InitialLoadInfo initialLoadInfo)
void	insertEntry(Context context, IEntryHolder entryHolder, boolean origin, boolean shouldReplicate)	Inserts a new entry to the SA storage.
void	introduceDataType(ITypeDesc typeDesc)
boolean	isReadOnly()	If returns true - then the storage adapter is read-only and can't be written to.
ISAdapterIterator<IEntryHolder>	makeEntriesIter(ITemplateHolder template, long SCNFilter, long leaseFilter, IServerTypeDesc[] subTypes)	Returns an iterator with entries that match the template, and the other parameters.
void	prepare(Context context, ServerTransaction xtn, ArrayList<IEntryHolder> pLocked, boolean singleParticipant, Map<String,Object> partialUpdatesAndInPlaceUpdatesInfo, boolean shouldReplicate)	Performs prepare to transaction- write to SA all new entries under the xtn, mark taken entries under the xtn
void	removeEntry(Context context, IEntryHolder entryHolder, boolean origin, boolean fromLeaseExpiration, boolean shouldReplicate)	Removes an entry from the SA storage.
void	rollback(ServerTransaction xtn, boolean anyUpdates)	Performs rollback to transaction- rewrite taken entries, remove new entries.
void	shutDown()	called by the engine after all connections have been closed.
boolean	supportsExternalDB()
boolean	supportsGetEntries()	Denotes whether the implementing class has an implementation for {@ #getEntries(Object[], String, IEntryHolder[])}
boolean	supportsPartialUpdate()
void	updateEntry(Context context, IEntryHolder updatedEntry, boolean updateRedoLog, boolean origin, boolean[] partialUpdateValuesIndicators)	updates an entry.

Methods inherited from class java.lang.Object

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

Constructor Details

SynchronizationStorageAdapter

public SynchronizationStorageAdapter(SpaceEngine engine,
 SpaceDataSource spaceDataSource,
 SpaceSynchronizationEndpoint synchronizationEndpointInterceptor)
                              throws ClassNotFoundException,
IllegalAccessException,
InstantiationException

Throws:

ClassNotFoundException

IllegalAccessException

InstantiationException

Method Details

initialize

public void initialize()
                throws SAException

Description copied from interface: IStorageAdapter

Initializes the SA for work (first API called by engine)

If initMode is WARM : SA is required to set its internal working tables and environment to the state recorded in its persistent storage, and verify that all the SA space-related data is in consistent state.

If initMode is COLD : SA is required to clean its internal state.

Specified by:

initialize in interface IStorageAdapter

Throws:

SAException - - In case a SQL error occurred.

initialLoad

public ISAdapterIterator<?> initialLoad(Context context,
 ITemplateHolder template,
 InitialLoadInfo initialLoadInfo)
                                 throws SAException

Specified by:

initialLoad in interface IStorageAdapter

Throws:

SAException

insertEntry

public void insertEntry(Context context,
 IEntryHolder entryHolder,
 boolean origin,
 boolean shouldReplicate)
                 throws SAException

Description copied from interface: IStorageAdapter

Inserts a new entry to the SA storage.

Specified by:

insertEntry in interface IStorageAdapter

entryHolder - entry to insert

Throws:

SAException

updateEntry

public void updateEntry(Context context,
 IEntryHolder updatedEntry,
 boolean updateRedoLog,
 boolean origin,
 boolean[] partialUpdateValuesIndicators)
                 throws SAException

Description copied from interface: IStorageAdapter

updates an entry.

Specified by:

updateEntry in interface IStorageAdapter

updatedEntry - new content, same UID and class

Throws:

SAException

removeEntry

public void removeEntry(Context context,
 IEntryHolder entryHolder,
 boolean origin,
 boolean fromLeaseExpiration,
 boolean shouldReplicate)
                 throws SAException

Description copied from interface: IStorageAdapter

Removes an entry from the SA storage.

Specified by:

removeEntry in interface IStorageAdapter

entryHolder - entry to remove

Throws:

SAException

prepare

public void prepare(Context context,
 ServerTransaction xtn,
 ArrayList<IEntryHolder> pLocked,
 boolean singleParticipant,
 Map<String,Object> partialUpdatesAndInPlaceUpdatesInfo,
 boolean shouldReplicate)
             throws SAException

Description copied from interface: IStorageAdapter

Performs prepare to transaction- write to SA all new entries under the xtn, mark taken entries under the xtn

Specified by:

prepare in interface IStorageAdapter

xtn - transaction to prepare

pLocked - a vector of all entries locked (written or taken) under the xtn

singleParticipant - - if true, a transactional SA needs to do all the transaction related operations in one DB transaction and the prepare is actually the commit (no other transaction related APIs will be called for this xtn)

Throws:

SAException

rollback

public void rollback(ServerTransaction xtn,
 boolean anyUpdates)
              throws SAException

Description copied from interface: IStorageAdapter

Performs rollback to transaction- rewrite taken entries, remove new entries.

Specified by:

rollback in interface IStorageAdapter

Parameters:

xtn - transaction to roll-back

anyUpdates - true if any updates performed under tjis xtn

Throws:

SAException

supportsGetEntries

public boolean supportsGetEntries()

Description copied from interface: IStorageAdapter

Denotes whether the implementing class has an implementation for {@ #getEntries(Object[], String, IEntryHolder[])}

Specified by:

supportsGetEntries in interface IStorageAdapter

getEntries

public Map<String,IEntryHolder> getEntries(Context context,
 Object[] ids,
 String typeName,
 IEntryHolder[] templates)
                                    throws SAException

Description copied from interface: IStorageAdapter

Gets a map of entries from the storage adapter

Specified by:

getEntries in interface IStorageAdapter

ids - the ids of the entries to get

typeName - type of the entries to get

templates - templates matching the ids of the entries to get

Returns:

A map between entries uid and the entry holder returning null from this method implies this operation is not supported by the underlying storage mechanism and other methods for obtaining these entries should be applied.

Throws:

SAException

getEntry

public IEntryHolder getEntry(Context context,
 String uid,
 String typeName,
 IEntryHolder template)
                      throws SAException

Description copied from interface: IStorageAdapter

Gets an entry object from the storage adapter.

Specified by:

getEntry in interface IStorageAdapter

uid - ID of the entry to get

typeName - class of the entry to get

template - selection template,may be null, currently used by cacheload/cachestore in order to pass primery key fields when GS uid is not saved in an external DB

Returns:

IEntryHolder

Throws:

SAException

makeEntriesIter

public ISAdapterIterator<IEntryHolder> makeEntriesIter(ITemplateHolder template,
 long SCNFilter,
 long leaseFilter,
 IServerTypeDesc[] subTypes)
                                                throws SAException

Description copied from interface: IStorageAdapter

Returns an iterator with entries that match the template, and the other parameters.

Specified by:

makeEntriesIter in interface IStorageAdapter

Parameters:

template - - the entries should match that template.

SCNFilter - - if != 0 gets only templates that are <= from SCNFilter.

leaseFilter - if != 0 gets only templates that have expiration_time >= leaseFilter.

subTypes - - array of sub classes of the template, the entries should belong to a subcalss.

Returns:

ISadapterIterator

Throws:

SAException

commit

public void commit(ServerTransaction xtn,
 boolean anyUpdates)
            throws SAException

Description copied from interface: IStorageAdapter

Performs commit to transaction- delete taken entries, commit new entries.

Specified by:

commit in interface IStorageAdapter

Parameters:

xtn - transaction to commit

anyUpdates - true if any updates performed under tjis xtn

Throws:

SAException

count

public int count(ITemplateHolder template,
 String[] subClasses)
          throws SAException

Description copied from interface: IStorageAdapter

Returns the number of entries that match the template.

Specified by:

count in interface IStorageAdapter

Parameters:

template - - the entries should match the template.

subClasses - - subclassesof the template, the entries can be in one of them.

Returns:

int - number of entries that match the parameters.

Throws:

SAException

shutDown

public void shutDown()
              throws SAException

Description copied from interface: IStorageAdapter

called by the engine after all connections have been closed. if the ShotDownString property is set- the string is executed by the SA

Specified by:

shutDown in interface IStorageAdapter

Throws:

SAException

isReadOnly

public boolean isReadOnly()

Description copied from interface: IStorageAdapter

If returns true - then the storage adapter is read-only and can't be written to.

Specified by:

isReadOnly in interface IStorageAdapter

supportsExternalDB

public boolean supportsExternalDB()

Specified by:

supportsExternalDB in interface IStorageAdapter

supportsPartialUpdate

public boolean supportsPartialUpdate()

Specified by:

supportsPartialUpdate in interface IStorageAdapter

introduceDataType

public void introduceDataType(ITypeDesc typeDesc)

Specified by:

introduceDataType in interface IStorageAdapter

addIndexes

public void addIndexes(String typeName,
 SpaceIndex[] indexes)

Specified by:

addIndexes in interface IStorageAdapter

getSynchronizationInterceptor

public SpaceSynchronizationEndpoint getSynchronizationInterceptor()

Specified by:

getSynchronizationInterceptor in interface IStorageAdapter

getDataClass

public Class<?> getDataClass()

Specified by:

getDataClass in interface IStorageAdapter