com.gigaspaces.internal.server.space

Class SpaceEngine

java.lang.Object

com.gigaspaces.internal.server.space.SpaceEngine

All Implemented Interfaces:

ISpaceModeListener, IClusterInfoChangedListener, Remote, EventListener

public class SpaceEngine
extends Object
implements ISpaceModeListener, IClusterInfoChangedListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpaceEngine.EntryRemoveReasonCodes why is entry removed.
static class	SpaceEngine.TemplateRemoveReasonCodes why is entry removed.

Constructor Summary

Constructors

Constructor and Description
SpaceEngine(SpaceImpl spaceImpl)

Method Summary

Modifier and Type	Method and Description
void	abort(TransactionManager mgr, ServerTransaction st, boolean supportsTwoPhaseReplication, OperationID operationID)
void	abortSA(TransactionManager mgr, ServerTransaction st, boolean fromLeaseExpiration, boolean verifyExpiredXtn, boolean supportsTwoPhaseReplication, OperationID operationID)
void	afterClusterInfoChange(SpaceClusterInfo clusterInfo) Updates server side components that holds SpaceClusterInfo instances when SpaceClusterInfo changes (i.e horizontal scale event)
void	afterSpaceModeChange(SpaceMode newMode) Called right after the space mode changes.
void	aggregate(ITemplatePacket queryPacket, List<SpaceEntriesAggregator> aggregators, int readModifiers, SpaceContext sc)
protected void	attachFromGatewayStateToTransactionIfNeeded(SpaceContext sc, XtnEntry txnEntry)
XtnEntry	attachToXtn(ServerTransaction txn, boolean fromReplication) Join the specified transaction, if not already joined.
void	beforeAuthentication(SecurityContext securityContext) Invokes the "before-authentication" filter.
void	beforeSpaceModeChange(SpaceMode newMode) Called right before the space mode changes. Implementors usually use it to allow specific service initializations.
ExtendedAnswerHolder	change(ITemplatePacket template, Transaction txn, long lease, long timeout, SpaceContext sc, boolean fromReplication, boolean origin, Collection<SpaceEntryMutator> mutators, int operationModifiers, boolean returnOnlyUid) perform an update in place using mutators
void	checkWFValidityAfterUpdate(Context context, IEntryHolder entry) update performed for an entry under xtn, if there are templates wf this entry, is there any use to keep on waiting (i.e.
Pair<Integer,SingleExplainPlan>	clear(ITemplatePacket template, Transaction txn, SpaceContext sc, int operationModifiers)
void	clearDataTypeMetricRegistrarIfExists(String dataTypeName)
void	clearDataTypeMetricRegistrarIfExists(String typeName, String indexName)
void	close() Closes engine, including all working groups and contexts.
void	closeServerIterator(UUID uuid)
void	commit(TransactionManager mgr, ServerTransaction st, boolean supportsTwoPhaseReplication, OperationID operationID, boolean mayBeFromReplication)
Pair<Integer,SingleExplainPlan>	count(ITemplatePacket template, Transaction txn, SpaceContext sc, int operationModifiers)
int	countIncomingConnections()
int	countTransactions(int type, int status)
String	createTransactionDetailsString(ServerTransaction st, OperationID operationID)
String	createUIDFromCounter()
Object	directLocalReadById(Object id, String typeName, QueryResultTypeInternal queryResultType) For local reads without xtn and timeout, used only in local cache, only with object reference mode
void	dropClass(String className) Drop all Class entries and all its templates from the space.
void	enableDuplicateExecutionProtection(OperationID operationID)
void	executeOnMatchingEntries(Context context, ITemplateHolder template, boolean makeWaitForInfo) Searches the engine for a matching entry using the BFS tree of the specified template.
MetricRegistrator	extendSpaceMetricRegistrator(String prefix, Map<String,String> extraTags, Map<String,DynamicMetricTag> extraDynamicTags)
String	generateGroupName()
String	generateUid()
void	getAdmin(SpaceContext sc) check authority to get admin.
CacheManager	getCacheManager()
ITypeDesc	getClassTypeInfo(String className) get the basic class info from the space directory.
ITypeDesc	getClassTypeInfo(String className, boolean asVirtualType)
SpaceClusterInfo	getClusterInfo()
ClusterPolicy	getClusterPolicy()
List<ISpaceComponentsHandler>	getComponentsHandlers() get the list of component handlers
SpaceConfigReader	getConfigReader()
ConflictingOperationPolicy	getConflictingOperationPolicy()
MetricRegistrator	getDataTypeMetricRegistrar(String dataTypeName)
MetricRegistrator	getDataTypeMetricRegistrar(String typeName, String indexName)
EntryArrivedPacketsFactory	getEntryArrivedPacketsFactory()
EntryDataType	getEntryDataType()
FifoGroupsHandler	getFifoGroupsHandler()
FilterManager	getFilterManager()
String	getFullSpaceName()
List<FilterProvider>	getInternalFilters() Returns a list of internal filters that should be used by the FilterManager
ServerIteratorsManager	getIteratorsManager()
long	getLastEntryTimestamp()
LeaseManager	getLeaseManager()
LocalViewRegistrations	getLocalViewRegistrations()
List<UnderTxnLockedObject>	getLockedObjects(Transaction txn) getLockedObjects returns Info about all the locked Object by the given Transaction.
org.slf4j.Logger	getLogger()
IEntryHolder	getMatchedEntryAndOperateSA(Context context, ITemplateHolder template, boolean makeWaitForInfo, boolean useSCN) Searches the engine for a matching entry using the BFS tree of the specified template.
MemoryManager	getMemoryManager()
MetricManager	getMetricManager()
MetricRegistrator	getMetricRegistrator()
Map<String,Object>	getMetricsSnapshotByPrefix(Collection<String> prefixes)
int	getNotifierQueueSize()
int	getNumberOfPartitions()
org.slf4j.Logger	getOperationLogger()
int	getPartitionIdOneBased() gets the number of this space in the partition.
int	getPartitionIdZeroBased()
PartitionRoutingInfo	getPartitionRoutingInfo()
int	getProcessorQueueSize()
WorkingGroup<BusPacket<Processor>>	getProcessorWG()
SpaceReplicationManager	getReplicationManager()
IReplicationNode	getReplicationNode()
SpaceRuntimeInfo	getRuntimeInfo() Returns the runtime information for all objects in space
SpaceRuntimeInfo	getRuntimeInfo(String typeName) Returns the runtime information for a given class and its subclasses
SpaceImpl	getSpaceImpl()
String	getSpaceName()
TemplateScanner	getTemplateScanner()
List<TemplateInfo>	getTemplatesInfo(String className)
XtnEntry	getTransaction(ServerTransaction st)
TransactionHandler	getTransactionHandler()
TransactionInfo[]	getTransactionsInfo(int type, int status) Returns all the transactions that have the type and status.
SpaceTypeManager	getTypeManager()
IServerTypeDesc	getTypeTableEntry(String className)
List<Throwable>	getUnhealthyReasons()
protected void	handleExceptionOnPrepare(TransactionManager mgr, ServerTransaction st, boolean supportsTwoPhaseReplication, XtnEntry xtnEntry)
boolean	hasMirror()
boolean	indicateDirtyRead(ITemplateHolder template) given an entry and a template, return true if dirty-read should be performed
void	init(boolean loadDataFromDB, boolean considerMemoryRecovery)
void	invokeFilters(SpaceContext sc, int operationCode, Object subject)
boolean	isBlobStorePersistent()
boolean	isCleanUnusedEmbeddedGlobalXtns()
boolean	isClusteredExternalDBEnabled(IStorageAdapter storageAdapter)
boolean	isColdStart()
boolean	isEntryFromPartition(IEntryHolder entryHolder) return true if entry belongs to the partition of the space, false if entry is not from space partition
boolean	isExpiredEntryStayInSpace(IEntryHolder entry)
boolean	isFailOverDuringRecovery()
boolean	isLocalCache()
boolean	isMemoryRecoveryEnabled()
boolean	isMirrorService()
boolean	isNonBlockingReadForOperation(ITemplateHolder tHolder)
boolean	isNoWriteLease(IEntryPacket entryPacket, int modifiers, boolean fromReplication)
boolean	isPartitionedSpace() return true if space is part of a partitioned cluster
boolean	isReplicated()
boolean	isReplicatedPersistentBlobstore()
boolean	isSyncReplicationEnabled() is sync-replication enabled for at least one member in a clustered space.
boolean	isTransactionalSA()
AnswerHolder	newAdaptUpdateMultiple(IEntryPacket[] entries, Transaction txn, long lease, long[] leases, SpaceContext sc, long timeout, int modifiers)
AnswerHolder	newUpdateMultiple(IEntryPacket[] entries, Transaction txn, long[] leases, SpaceContext sc, long timeout, int operationModifiers) perform update of multiple entries.
GSEventRegistration	notify(ITemplatePacket template, long lease, boolean fromReplication, String templateUid, SpaceContext sc, NotifyInfo info)
WriteEntriesResult	oldAdaptUpdateMultiple(IEntryPacket[] entries, Transaction txn, long lease, long[] leases, SpaceContext sc, int modifiers, boolean newRouter)
int	performReplication(Context context) perform sync replication from sync-packets list or a single sync-packet contained in the context.
void	performTemplateOnEntrySA(Context context, ITemplateHolder template, IEntryHolder entry, boolean makeWaitForInfo) try to process an entry , if the entry has a shadow try it too if the entry don't suite
int	prepare(TransactionManager mgr, ServerTransaction st, boolean singleParticipant, boolean supportsTwoPhaseReplication, OperationID operationID)
int	prepareAndCommit(TransactionManager mgr, ServerTransaction st, OperationID operationID) Prepare and commit the transaction - called for single participant transaction or transaction without changes
AnswerHolder	read(ITemplatePacket template, Transaction txn, long timeout, boolean ifExists, boolean take, SpaceContext sc, boolean returnOnlyUid, boolean fromReplication, boolean origin, int operationModifiers)
AnswerHolder	readMultiple(ITemplatePacket template, Transaction txn, long timeout, boolean ifExists, boolean take, SpaceContext sc, boolean returnOnlyUid, int operationModifiers, BatchQueryOperationContext batchOperationContext, List<SpaceEntriesAggregator> aggregators, ServerIteratorRequestInfo serverIteratorRequestInfo)
void	registerLocalView(ITemplatePacket[] queryPackets, Collection<SpaceQueryDetails> queryDescriptions, RouterStubHolder viewStub, int batchSize, long batchTimeout, SpaceContext spaceContext)
void	registerTypeDesc(ITypeDesc typeDesc, boolean fromGateway) Attempts to register the provided ITypeDesc instance and replicate the operation if necessary.
void	removeEntrySA(Context context, IEntryHolder entry, boolean fromReplication, boolean origin, boolean ofReplicatableClass, SpaceEngine.EntryRemoveReasonCodes removeReason, boolean disableReplication, boolean disableProcessorCall, boolean disableSADelete)
void	removeEntrySA(Context context, IEntryHolder entry, IServerTypeDesc typeDesc, boolean fromReplication, boolean origin, SpaceEngine.EntryRemoveReasonCodes removeReason) Delete an entry (direct delete).
void	removeEntrySA(Context context, IEntryHolder entry, IServerTypeDesc typeDesc, boolean fromReplication, boolean origin, SpaceEngine.EntryRemoveReasonCodes removeReason, boolean disableReplication, boolean disableProcessorCall, boolean disableSADelete) Delete an entry (direct delete).
void	renewServerIteratorLease(UUID uuid)
void	rollbackCopyReplica(ISpaceCopyResult replicaResult)
void	setLastEntryTimestamp(long timestamp)
void	setReplicationUnhealthyReason(Exception cause)
boolean	shouldReplicate(ReplicationOperationType operType, boolean ofReplicatableClass, boolean disableReplication, boolean fromReplication)
boolean	shouldReplicate(ReplicationOperationType operType, IServerTypeDesc serverTypeDesc, boolean disableReplication, boolean fromReplication)
boolean	skipBroadcastTable(Context context, ITemplateHolder template)
void	snapshot(ITemplatePacket entryPacket) Return a snapshot of the given entry.
ISpaceCopyReplicaState	spaceBroadcastNotifyTemplatesReplica(SpaceURL sourceRemoteUrl, int chunkSize, boolean transientOnly)
ISpaceCopyReplicaState	spaceCopyReplica(SpaceURL sourceRemoteUrl, String sourceMemberName, IRemoteSpace remoteJSpace, ITemplatePacket templPacket, boolean includeNotifyTemplates, int chunkSize, SpaceContext sc, SpaceContext remoteSpaceContext)
ISpaceSynchronizeReplicaState	spaceSynchronizeReplica(SpaceURL sourceRemoteUrl, int chunkSize, boolean transientOnly, boolean memoryOnly)
boolean	supportsGuaranteedNotifications() Returns true if this cluster topology supports guaranteed notifications.
void	touchLastEntryTimestamp()
void	unregisterLocalView(String viewStubHolderName)
ExtendedAnswerHolder	update(IEntryPacket updated_entry, Transaction txn, long lease, long timeout, SpaceContext sc, boolean fromReplication, boolean origin, boolean newRouter, int modifiers) perform an update operation- make it atomic NOTE- returnonlyUID is ignored
ExtendedAnswerHolder	update(IEntryPacket updated_entry, Transaction txn, long lease, long timeout, SpaceContext sc, boolean fromReplication, boolean origin, boolean newRouter, int modifiers, MultipleIdsContext multipleIdsContext)
Object[]	updateMultiple(IEntryPacket[] entries, Transaction txn, long[] leases, SpaceContext sc, int operationModifiers, boolean newRouter) perform update of multiple entries.
void	updateObjectTypeReadCounts(IServerTypeDesc serverTypeDesc, ITemplatePacket template)
ExtendedAnswerHolder	updateOrWrite(UpdateOrWriteContext ctx, boolean newRouter)
ExtendedAnswerHolder	updateOrWrite(UpdateOrWriteContext ctx, boolean fromReplication, boolean origin, boolean newRouter)
void	waitForConsistentState() Wait until the engine is a consistent state, which means it has no pending operations that will be lost when closing the engine
WriteEntriesResult	write(IEntryPacket[] entryPackets, Transaction txn, long lease, long[] leases, int modifiers, SpaceContext sc, long timeout, boolean newRouter) Creates IEntryHolder objects from the specified entry packets and inserts them into all relevant engine tables.
WriteEntryResult	write(IEntryPacket entryPacket, Transaction txn, long lease, int modifiers, boolean fromReplication, boolean origin, SpaceContext sc) Creates an IEntryHolder object from the specified entry packet and inserts it into all relevant engine tables.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpaceEngine

public SpaceEngine(SpaceImpl spaceImpl)
            throws CreateException,
                   RemoteException

Throws:

CreateException

RemoteException

Method Detail

extendSpaceMetricRegistrator

public MetricRegistrator extendSpaceMetricRegistrator(String prefix,
                                                      Map<String,String> extraTags,
                                                      Map<String,DynamicMetricTag> extraDynamicTags)

init

public void init(boolean loadDataFromDB,
                 boolean considerMemoryRecovery)
          throws CreateException

Throws:

CreateException

getTemplateScanner

public TemplateScanner getTemplateScanner()

getSpaceImpl

public SpaceImpl getSpaceImpl()

getOperationLogger

public org.slf4j.Logger getOperationLogger()

getConfigReader

public SpaceConfigReader getConfigReader()

getTypeManager

public SpaceTypeManager getTypeManager()

getFilterManager

public FilterManager getFilterManager()

getLeaseManager

public LeaseManager getLeaseManager()

getEntryArrivedPacketsFactory

public EntryArrivedPacketsFactory getEntryArrivedPacketsFactory()

getEntryDataType

public EntryDataType getEntryDataType()

getProcessorWG

public WorkingGroup<BusPacket<Processor>> getProcessorWG()

invokeFilters

public void invokeFilters(SpaceContext sc,
                          int operationCode,
                          Object subject)

write

public WriteEntryResult write(IEntryPacket entryPacket,
                              Transaction txn,
                              long lease,
                              int modifiers,
                              boolean fromReplication,
                              boolean origin,
                              SpaceContext sc)
                       throws TransactionException,
                              UnusableEntryException,
                              UnknownTypeException,
                              RemoteException

Creates an IEntryHolder object from the specified entry packet and inserts it into all relevant engine tables. if entryPacket.NoWriteLease=true the return value will be Entry UID(String) of Entry, otherwise Lease object.

Throws:

TransactionException

UnusableEntryException

UnknownTypeException

RemoteException

isNoWriteLease

public boolean isNoWriteLease(IEntryPacket entryPacket,
                              int modifiers,
                              boolean fromReplication)

notify

public GSEventRegistration notify(ITemplatePacket template,
                                  long lease,
                                  boolean fromReplication,
                                  String templateUid,
                                  SpaceContext sc,
                                  NotifyInfo info)
                           throws TransactionException,
                                  UnusableEntryException,
                                  UnknownTypeException,
                                  RemoteException

Throws:

TransactionException

UnusableEntryException

UnknownTypeException

RemoteException

read

public AnswerHolder read(ITemplatePacket template,
                         Transaction txn,
                         long timeout,
                         boolean ifExists,
                         boolean take,
                         SpaceContext sc,
                         boolean returnOnlyUid,
                         boolean fromReplication,
                         boolean origin,
                         int operationModifiers)
                  throws TransactionException,
                         UnusableEntryException,
                         UnknownTypeException,
                         RemoteException,
                         InterruptedException

Throws:

TransactionException

UnusableEntryException

UnknownTypeException

RemoteException

InterruptedException

isNonBlockingReadForOperation

public boolean isNonBlockingReadForOperation(ITemplateHolder tHolder)

snapshot

public void snapshot(ITemplatePacket entryPacket)
              throws UnusableEntryException

Return a snapshot of the given entry.

Note: Snapshot doesn't finalize FIFO indicator and thus no InvalidFifoException is thrown.

Throws:

UnusableEntryException

write

public WriteEntriesResult write(IEntryPacket[] entryPackets,
                                Transaction txn,
                                long lease,
                                long[] leases,
                                int modifiers,
                                SpaceContext sc,
                                long timeout,
                                boolean newRouter)
                         throws TransactionException,
                                RemoteException,
                                UnknownTypesException

Creates IEntryHolder objects from the specified entry packets and inserts them into all relevant engine tables. if entryPacket.NoWriteLease=true the return value will be Entry UID(String) of Entry, otherwise Lease object.

Throws:

TransactionException

RemoteException

UnknownTypesException

oldAdaptUpdateMultiple

public WriteEntriesResult oldAdaptUpdateMultiple(IEntryPacket[] entries,
                                                 Transaction txn,
                                                 long lease,
                                                 long[] leases,
                                                 SpaceContext sc,
                                                 int modifiers,
                                                 boolean newRouter)
                                          throws RemoteException,
                                                 TransactionException,
                                                 UnknownTypesException

Throws:

RemoteException

TransactionException

UnknownTypesException

newAdaptUpdateMultiple

public AnswerHolder newAdaptUpdateMultiple(IEntryPacket[] entries,
                                           Transaction txn,
                                           long lease,
                                           long[] leases,
                                           SpaceContext sc,
                                           long timeout,
                                           int modifiers)
                                    throws RemoteException,
                                           TransactionException,
                                           UnknownTypesException

Throws:

RemoteException

TransactionException

UnknownTypesException

updateObjectTypeReadCounts

public void updateObjectTypeReadCounts(IServerTypeDesc serverTypeDesc,
                                       ITemplatePacket template)

readMultiple

public AnswerHolder readMultiple(ITemplatePacket template,
                                 Transaction txn,
                                 long timeout,
                                 boolean ifExists,
                                 boolean take,
                                 SpaceContext sc,
                                 boolean returnOnlyUid,
                                 int operationModifiers,
                                 BatchQueryOperationContext batchOperationContext,
                                 List<SpaceEntriesAggregator> aggregators,
                                 ServerIteratorRequestInfo serverIteratorRequestInfo)
                          throws TransactionException,
                                 UnusableEntryException,
                                 UnknownTypeException,
                                 RemoteException,
                                 InterruptedException

Throws:

TransactionException

UnusableEntryException

UnknownTypeException

RemoteException

InterruptedException

attachFromGatewayStateToTransactionIfNeeded

protected void attachFromGatewayStateToTransactionIfNeeded(SpaceContext sc,
                                                           XtnEntry txnEntry)

count

public Pair<Integer,SingleExplainPlan> count(ITemplatePacket template,
                                             Transaction txn,
                                             SpaceContext sc,
                                             int operationModifiers)
                                      throws UnusableEntryException,
                                             UnknownTypeException,
                                             TransactionException,
                                             RemoteException

Throws:

UnusableEntryException

UnknownTypeException

TransactionException

RemoteException

clear

public Pair<Integer,SingleExplainPlan> clear(ITemplatePacket template,
                                             Transaction txn,
                                             SpaceContext sc,
                                             int operationModifiers)
                                      throws UnusableEntryException,
                                             UnknownTypeException,
                                             TransactionException,
                                             RemoteException

Throws:

UnusableEntryException

UnknownTypeException

TransactionException

RemoteException

update

public ExtendedAnswerHolder update(IEntryPacket updated_entry,
                                   Transaction txn,
                                   long lease,
                                   long timeout,
                                   SpaceContext sc,
                                   boolean fromReplication,
                                   boolean origin,
                                   boolean newRouter,
                                   int modifiers)
                            throws UnusableEntryException,
                                   UnknownTypeException,
                                   TransactionException,
                                   RemoteException,
                                   InterruptedException

perform an update operation- make it atomic NOTE- returnonlyUID is ignored

Throws:

UnusableEntryException

UnknownTypeException

TransactionException

RemoteException

InterruptedException

update

public ExtendedAnswerHolder update(IEntryPacket updated_entry,
                                   Transaction txn,
                                   long lease,
                                   long timeout,
                                   SpaceContext sc,
                                   boolean fromReplication,
                                   boolean origin,
                                   boolean newRouter,
                                   int modifiers,
                                   MultipleIdsContext multipleIdsContext)
                            throws UnusableEntryException,
                                   UnknownTypeException,
                                   TransactionException,
                                   RemoteException,
                                   InterruptedException

Throws:

UnusableEntryException

UnknownTypeException

TransactionException

RemoteException

InterruptedException

updateOrWrite

public ExtendedAnswerHolder updateOrWrite(UpdateOrWriteContext ctx,
                                          boolean newRouter)
                                   throws TransactionException,
                                          UnusableEntryException,
                                          UnknownTypeException,
                                          RemoteException,
                                          InterruptedException

Throws:

TransactionException

UnusableEntryException

UnknownTypeException

RemoteException

InterruptedException

updateOrWrite

public ExtendedAnswerHolder updateOrWrite(UpdateOrWriteContext ctx,
                                          boolean fromReplication,
                                          boolean origin,
                                          boolean newRouter)
                                   throws TransactionException,
                                          UnusableEntryException,
                                          UnknownTypeException,
                                          RemoteException,
                                          InterruptedException

Throws:

TransactionException

UnusableEntryException

UnknownTypeException

RemoteException

InterruptedException

change

public ExtendedAnswerHolder change(ITemplatePacket template,
                                   Transaction txn,
                                   long lease,
                                   long timeout,
                                   SpaceContext sc,
                                   boolean fromReplication,
                                   boolean origin,
                                   Collection<SpaceEntryMutator> mutators,
                                   int operationModifiers,
                                   boolean returnOnlyUid)
                            throws UnusableEntryException,
                                   UnknownTypeException,
                                   TransactionException,
                                   RemoteException,
                                   InterruptedException

perform an update in place using mutators

Throws:

UnusableEntryException

UnknownTypeException

TransactionException

RemoteException

InterruptedException

updateMultiple

public Object[] updateMultiple(IEntryPacket[] entries,
                               Transaction txn,
                               long[] leases,
                               SpaceContext sc,
                               int operationModifiers,
                               boolean newRouter)
                        throws UnusableEntryException,
                               UnknownTypeException,
                               TransactionException,
                               RemoteException

perform update of multiple entries. the entries array contains the entries to update, each entry must contain a UID and (optionally) a versionID NOTE- returnonlyUID is ignored

Throws:

UnusableEntryException

UnknownTypeException

TransactionException

RemoteException

newUpdateMultiple

public AnswerHolder newUpdateMultiple(IEntryPacket[] entries,
                                      Transaction txn,
                                      long[] leases,
                                      SpaceContext sc,
                                      long timeout,
                                      int operationModifiers)
                               throws UnusableEntryException,
                                      UnknownTypeException,
                                      TransactionException,
                                      RemoteException,
                                      InterruptedException

perform update of multiple entries. the entries array contains the entries to update, each entry must contain a UID and (optionally) a versionID NOTE- returnonlyUID is ignored

Throws:

UnusableEntryException

UnknownTypeException

TransactionException

RemoteException

InterruptedException

getRuntimeInfo

public SpaceRuntimeInfo getRuntimeInfo()

Returns the runtime information for all objects in space

getRuntimeInfo

public SpaceRuntimeInfo getRuntimeInfo(String typeName)

Returns the runtime information for a given class and its subclasses

Parameters:

typeName - the name of the class

createUIDFromCounter

public String createUIDFromCounter()

dropClass

public void dropClass(String className)
               throws DropClassException

Drop all Class entries and all its templates from the space. Calling this method will remove all internal meta data related to this class stored in the space. When using persistent spaced the relevant RDBMS table will be dropped. It is the caller responsibility to ensure that no entries from this class are written to the space while this method is called. This method is protected through the space Default Security Filter. Admin permissions required to execute this request successfully.

Parameters:

className - - name of class to delete.

Throws:

DropClassException

prepare

public int prepare(TransactionManager mgr,
                   ServerTransaction st,
                   boolean singleParticipant,
                   boolean supportsTwoPhaseReplication,
                   OperationID operationID)
            throws UnknownTransactionException,
                   RemoteException

Throws:

UnknownTransactionException

RemoteException

handleExceptionOnPrepare

protected void handleExceptionOnPrepare(TransactionManager mgr,
                                        ServerTransaction st,
                                        boolean supportsTwoPhaseReplication,
                                        XtnEntry xtnEntry)
                                 throws RemoteException

Throws:

RemoteException

prepareAndCommit

public int prepareAndCommit(TransactionManager mgr,
                            ServerTransaction st,
                            OperationID operationID)
                     throws UnknownTransactionException,
                            RemoteException

Prepare and commit the transaction - called for single participant transaction or transaction without changes

Throws:

UnknownTransactionException

RemoteException

commit

public void commit(TransactionManager mgr,
                   ServerTransaction st,
                   boolean supportsTwoPhaseReplication,
                   OperationID operationID,
                   boolean mayBeFromReplication)
            throws UnknownTransactionException,
                   RemoteException

Throws:

UnknownTransactionException

RemoteException

createTransactionDetailsString

public String createTransactionDetailsString(ServerTransaction st,
                                             OperationID operationID)

abort

public void abort(TransactionManager mgr,
                  ServerTransaction st,
                  boolean supportsTwoPhaseReplication,
                  OperationID operationID)
           throws UnknownTransactionException

Throws:

UnknownTransactionException

getTemplatesInfo

public List<TemplateInfo> getTemplatesInfo(String className)

getTransactionsInfo

public TransactionInfo[] getTransactionsInfo(int type,
                                             int status)
                                      throws RemoteException

Returns all the transactions that have the type and status.

Parameters:

type - TransactionInfo.LOCAL, TransactionInfo.JINI or TransactionInfo.XA

status - TransactionConstants

Returns:

array of TransactionInfo

Throws:

RemoteException

countTransactions

public int countTransactions(int type,
                             int status)
                      throws RemoteException

Throws:

RemoteException

getLockedObjects

public List<UnderTxnLockedObject> getLockedObjects(Transaction txn)
                                            throws RemoteException

getLockedObjects returns Info about all the locked Object by the given Transaction.

Parameters:

txn - - the Transaction that locks the Objects.

Returns:

List of UnderTxnLockedObject

Throws:

RemoteException

getTypeTableEntry

public IServerTypeDesc getTypeTableEntry(String className)

waitForConsistentState

public void waitForConsistentState()

Wait until the engine is a consistent state, which means it has no pending operations that will be lost when closing the engine

getMetricsSnapshotByPrefix

public Map<String,Object> getMetricsSnapshotByPrefix(Collection<String> prefixes)

close

public void close()

Closes engine, including all working groups and contexts.

getMatchedEntryAndOperateSA

public IEntryHolder getMatchedEntryAndOperateSA(Context context,
                                                ITemplateHolder template,
                                                boolean makeWaitForInfo,
                                                boolean useSCN)
                                         throws TransactionException,
                                                TemplateDeletedException,
                                                SAException

Searches the engine for a matching entry using the BFS tree of the specified template. If a matched entry is found, perform template on entry and return reference to entry. Otherwise, return null. Handles also null templates.

Throws:

TransactionException

TemplateDeletedException

SAException

executeOnMatchingEntries

public void executeOnMatchingEntries(Context context,
                                     ITemplateHolder template,
                                     boolean makeWaitForInfo)
                              throws TransactionException,
                                     TemplateDeletedException,
                                     SAException

Searches the engine for a matching entry using the BFS tree of the specified template. If a matched entry is found, perform template on entry and return reference to entry. Otherwise, return empty Collection. Handles also null templates.

Throws:

TransactionException

TemplateDeletedException

SAException

skipBroadcastTable

public boolean skipBroadcastTable(Context context,
                                  ITemplateHolder template)

hasMirror

public boolean hasMirror()

Returns:

performTemplateOnEntrySA

public void performTemplateOnEntrySA(Context context,
                                     ITemplateHolder template,
                                     IEntryHolder entry,
                                     boolean makeWaitForInfo)
                              throws TransactionConflictException,
                                     EntryDeletedException,
                                     TemplateDeletedException,
                                     TransactionNotActiveException,
                                     SAException,
                                     NoMatchException,
                                     FifoException

try to process an entry , if the entry has a shadow try it too if the entry don't suite

Throws:

TransactionConflictException

EntryDeletedException

TemplateDeletedException

TransactionNotActiveException

SAException

NoMatchException

FifoException

indicateDirtyRead

public boolean indicateDirtyRead(ITemplateHolder template)

given an entry and a template, return true if dirty-read should be performed

checkWFValidityAfterUpdate

public void checkWFValidityAfterUpdate(Context context,
                                       IEntryHolder entry)
                                throws SAException

update performed for an entry under xtn, if there are templates wf this entry, is there any use to keep on waiting (i.e. is there still a match with master or shadow ?) NOTE: entry is locked while calling this routine

Throws:

SAException

attachToXtn

public XtnEntry attachToXtn(ServerTransaction txn,
                            boolean fromReplication)
                     throws TransactionException,
                            RemoteException

Join the specified transaction, if not already joined.

Parameters:

txn - the transaction to join

Throws:

TransactionException

RemoteException

removeEntrySA

public void removeEntrySA(Context context,
                          IEntryHolder entry,
                          IServerTypeDesc typeDesc,
                          boolean fromReplication,
                          boolean origin,
                          SpaceEngine.EntryRemoveReasonCodes removeReason)
                   throws SAException

Delete an entry (direct delete). Assumes the specified entry is locked.

Throws:

SAException

removeEntrySA

public void removeEntrySA(Context context,
                          IEntryHolder entry,
                          IServerTypeDesc typeDesc,
                          boolean fromReplication,
                          boolean origin,
                          SpaceEngine.EntryRemoveReasonCodes removeReason,
                          boolean disableReplication,
                          boolean disableProcessorCall,
                          boolean disableSADelete)
                   throws SAException

Delete an entry (direct delete). Assumes the specified entry is locked.

Throws:

SAException

removeEntrySA

public void removeEntrySA(Context context,
                          IEntryHolder entry,
                          boolean fromReplication,
                          boolean origin,
                          boolean ofReplicatableClass,
                          SpaceEngine.EntryRemoveReasonCodes removeReason,
                          boolean disableReplication,
                          boolean disableProcessorCall,
                          boolean disableSADelete)
                   throws SAException

Throws:

SAException

isReplicated

public boolean isReplicated()

isReplicatedPersistentBlobstore

public boolean isReplicatedPersistentBlobstore()

abortSA

public void abortSA(TransactionManager mgr,
                    ServerTransaction st,
                    boolean fromLeaseExpiration,
                    boolean verifyExpiredXtn,
                    boolean supportsTwoPhaseReplication,
                    OperationID operationID)
             throws UnknownTransactionException

Throws:

UnknownTransactionException

getTransaction

public XtnEntry getTransaction(ServerTransaction st)

Parameters:

st -

Returns:

aggregate

public void aggregate(ITemplatePacket queryPacket,
                      List<SpaceEntriesAggregator> aggregators,
                      int readModifiers,
                      SpaceContext sc)
               throws Exception

Throws:

Exception

countIncomingConnections

public int countIncomingConnections()
                             throws RemoteException

Throws:

RemoteException

getIteratorsManager

public ServerIteratorsManager getIteratorsManager()

getMetricManager

public MetricManager getMetricManager()

afterClusterInfoChange

public void afterClusterInfoChange(SpaceClusterInfo clusterInfo)

Description copied from interface: IClusterInfoChangedListener

Updates server side components that holds SpaceClusterInfo instances when SpaceClusterInfo changes (i.e horizontal scale event)

Specified by:

afterClusterInfoChange in interface IClusterInfoChangedListener

getAdmin

public void getAdmin(SpaceContext sc)
              throws RemoteException

check authority to get admin.

Throws:

RemoteException

getClusterPolicy

public ClusterPolicy getClusterPolicy()

beforeAuthentication

public void beforeAuthentication(SecurityContext securityContext)
                          throws RemoteException

Invokes the "before-authentication" filter.

Throws:

RemoteException

spaceCopyReplica

public ISpaceCopyReplicaState spaceCopyReplica(SpaceURL sourceRemoteUrl,
                                               String sourceMemberName,
                                               IRemoteSpace remoteJSpace,
                                               ITemplatePacket templPacket,
                                               boolean includeNotifyTemplates,
                                               int chunkSize,
                                               SpaceContext sc,
                                               SpaceContext remoteSpaceContext)

generateGroupName

public String generateGroupName()

spaceSynchronizeReplica

public ISpaceSynchronizeReplicaState spaceSynchronizeReplica(SpaceURL sourceRemoteUrl,
                                                             int chunkSize,
                                                             boolean transientOnly,
                                                             boolean memoryOnly)

spaceBroadcastNotifyTemplatesReplica

public ISpaceCopyReplicaState spaceBroadcastNotifyTemplatesReplica(SpaceURL sourceRemoteUrl,
                                                                   int chunkSize,
                                                                   boolean transientOnly)
                                                            throws InterruptedException

Throws:

InterruptedException

rollbackCopyReplica

public void rollbackCopyReplica(ISpaceCopyResult replicaResult)

getClassTypeInfo

public ITypeDesc getClassTypeInfo(String className)

get the basic class info from the space directory.

getClassTypeInfo

public ITypeDesc getClassTypeInfo(String className,
                                  boolean asVirtualType)

isSyncReplicationEnabled

public final boolean isSyncReplicationEnabled()

is sync-replication enabled for at least one member in a clustered space.

isMirrorService

public final boolean isMirrorService()

Returns:

true if this space serves as MirrorService to receive async bulk operations to be saved into persistent cache adaptor.

isTransactionalSA

public boolean isTransactionalSA()

performReplication

public int performReplication(Context context)

perform sync replication from sync-packets list or a single sync-packet contained in the context.

isEntryFromPartition

public boolean isEntryFromPartition(IEntryHolder entryHolder)

return true if entry belongs to the partition of the space, false if entry is not from space partition

Parameters:

entryHolder- - to check

Returns:

true if entry belong to space partition

isPartitionedSpace

public boolean isPartitionedSpace()

return true if space is part of a partitioned cluster

Returns:

return true if space is part of a partition

getCacheManager

public CacheManager getCacheManager()

getMemoryManager

public final MemoryManager getMemoryManager()

getComponentsHandlers

public List<ISpaceComponentsHandler> getComponentsHandlers()

get the list of component handlers

getNumberOfPartitions

public int getNumberOfPartitions()

Returns:

the number of partitions in the static cluster.

getPartitionRoutingInfo

public PartitionRoutingInfo getPartitionRoutingInfo()

getPartitionIdOneBased

public int getPartitionIdOneBased()

gets the number of this space in the partition. starting from 1. returns 0 in case the cluster is not partitioned

Returns:

the number of Partition

getPartitionIdZeroBased

public int getPartitionIdZeroBased()

Returns:

Gets the number of this space in the partition (zero based)

getSpaceName

public String getSpaceName()

getFullSpaceName

public String getFullSpaceName()

getLastEntryTimestamp

public long getLastEntryTimestamp()

setLastEntryTimestamp

public void setLastEntryTimestamp(long timestamp)

touchLastEntryTimestamp

public void touchLastEntryTimestamp()

isColdStart

public boolean isColdStart()

isMemoryRecoveryEnabled

public boolean isMemoryRecoveryEnabled()

getTransactionHandler

public TransactionHandler getTransactionHandler()

Returns:

the transactionHandler

getInternalFilters

public List<FilterProvider> getInternalFilters()

Returns a list of internal filters that should be used by the FilterManager

supportsGuaranteedNotifications

public boolean supportsGuaranteedNotifications()

Returns true if this cluster topology supports guaranteed notifications. It is supported only for primary/backup topologies.

directLocalReadById

public Object directLocalReadById(Object id,
                                  String typeName,
                                  QueryResultTypeInternal queryResultType)

For local reads without xtn and timeout, used only in local cache, only with object reference mode

shouldReplicate

public boolean shouldReplicate(ReplicationOperationType operType,
                               IServerTypeDesc serverTypeDesc,
                               boolean disableReplication,
                               boolean fromReplication)

shouldReplicate

public boolean shouldReplicate(ReplicationOperationType operType,
                               boolean ofReplicatableClass,
                               boolean disableReplication,
                               boolean fromReplication)

getReplicationNode

public IReplicationNode getReplicationNode()

isCleanUnusedEmbeddedGlobalXtns

public boolean isCleanUnusedEmbeddedGlobalXtns()

afterSpaceModeChange

public void afterSpaceModeChange(SpaceMode newMode)

Description copied from interface: ISpaceModeListener

Called right after the space mode changes.
Implementors usually use it to invoke any needed services.

Specified by:

afterSpaceModeChange in interface ISpaceModeListener

Parameters:

newMode - the new mode change after it was published.

beforeSpaceModeChange

public void beforeSpaceModeChange(SpaceMode newMode)

Description copied from interface: ISpaceModeListener

Called right before the space mode changes.
Implementors usually use it to allow specific service initializations.

Specified by:

beforeSpaceModeChange in interface ISpaceModeListener

Parameters:

newMode - the new mode change before it's published.

isClusteredExternalDBEnabled

public boolean isClusteredExternalDBEnabled(IStorageAdapter storageAdapter)

getUnhealthyReasons

public List<Throwable> getUnhealthyReasons()

getReplicationManager

public SpaceReplicationManager getReplicationManager()

getProcessorQueueSize

public int getProcessorQueueSize()

getNotifierQueueSize

public int getNotifierQueueSize()

generateUid

public String generateUid()

setReplicationUnhealthyReason

public void setReplicationUnhealthyReason(Exception cause)

getConflictingOperationPolicy

public ConflictingOperationPolicy getConflictingOperationPolicy()

getFifoGroupsHandler

public FifoGroupsHandler getFifoGroupsHandler()

enableDuplicateExecutionProtection

public void enableDuplicateExecutionProtection(OperationID operationID)

isExpiredEntryStayInSpace

public boolean isExpiredEntryStayInSpace(IEntryHolder entry)

isFailOverDuringRecovery

public boolean isFailOverDuringRecovery()

isLocalCache

public boolean isLocalCache()

registerTypeDesc

public void registerTypeDesc(ITypeDesc typeDesc,
                             boolean fromGateway)
                      throws DetailedUnusableEntryException

Attempts to register the provided ITypeDesc instance and replicate the operation if necessary.

Throws:

DetailedUnusableEntryException

getLocalViewRegistrations

public LocalViewRegistrations getLocalViewRegistrations()

getMetricRegistrator

public MetricRegistrator getMetricRegistrator()

getDataTypeMetricRegistrar

public MetricRegistrator getDataTypeMetricRegistrar(String dataTypeName)

clearDataTypeMetricRegistrarIfExists

public void clearDataTypeMetricRegistrarIfExists(String dataTypeName)

getDataTypeMetricRegistrar

public MetricRegistrator getDataTypeMetricRegistrar(String typeName,
                                                    String indexName)

clearDataTypeMetricRegistrarIfExists

public void clearDataTypeMetricRegistrarIfExists(String typeName,
                                                 String indexName)

registerLocalView

public void registerLocalView(ITemplatePacket[] queryPackets,
                              Collection<SpaceQueryDetails> queryDescriptions,
                              RouterStubHolder viewStub,
                              int batchSize,
                              long batchTimeout,
                              SpaceContext spaceContext)
                       throws UnusableEntryException,
                              UnknownTypeException

Throws:

UnusableEntryException

UnknownTypeException

unregisterLocalView

public void unregisterLocalView(String viewStubHolderName)

isBlobStorePersistent

public boolean isBlobStorePersistent()

getClusterInfo

public SpaceClusterInfo getClusterInfo()

closeServerIterator

public void closeServerIterator(UUID uuid)

renewServerIteratorLease

public void renewServerIteratorLease(UUID uuid)

getLogger

public org.slf4j.Logger getLogger()