public interface DirtyShareMultiplexer extends RemoteMultiplexer<java.lang.String>
RemoteDirtyShareManager
invokes the methods of this interface on a local proxy for a remote object,
in order to access the dirty share services of the remote P2J
server which is authoritative for a particular database.
Since the remote P2J server may manage multiple databases, but only a single instance of an implementor of this interface will be available at any given remote server, dirty share service requests must be multiplexed by database. For this reason, each of the methods defined by this interface accepts an integer ID, which uniquely identifies the target database at the remote server.
The database ID to use for a particular physical database is determined by
calling RemoteMultiplexer.getMultiplexID(Object)
. This is
the responsibility of the RemoteDirtyShareManager
and must be
done before any dirty share management service is requested.
This interface effectively mirrors that of the DirtyShareManager
API
, except for the additional database multiplex identifier which is the
first parameter to each method.
Modifier and Type | Method and Description |
---|---|
void |
cleanupChanges(int database,
java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> subChanges,
java.util.Set<RecordIdentifier<java.lang.String>> subInserts)
Stop tracking uncommitted changes to the the subset of records
represented by
subChanges , and remove from the master set
of uncommitted, inserted records the subset of records represented by
subInserts . |
void |
cleanupDeletes(int database,
java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> subDeletes)
Remove from the master set of uncommitted, deleted records the subset of
records represented by
subDeletes . |
void |
delete(int database,
java.lang.String entity,
java.lang.Long id,
boolean rollback,
boolean lock)
Mark a record as having been deleted in an uncommitted transaction, or
unmark a record which previously was so marked.
|
void |
deregisterForGlobalEvents(int database,
long registerID)
Deregister with a global event clearinghouse an interest in insert,
delete, and update events which affect a particular DMO type.
|
Record |
getDirtyDMO(int database,
java.lang.String entity,
java.lang.Long id)
Retrieve from the dirty database the record specified by the given
entity and primary key, if it exists.
|
DirtyInfo |
getDirtyInfo(int database,
java.lang.String entity,
java.lang.Long candidateID,
int index,
java.util.List<java.lang.String> statements,
java.lang.Object[] params,
boolean rowidLookup)
Given certain search criteria and possibly the primary key of a potential DMO match in the
primary database, report any significant information currently being tracked for uncommitted
transactions, which might override data (or the lack thereof) found in the primary database.
|
int |
getEntityDirtyState(int database,
java.lang.String entity)
Indicate whether any uncommitted modification is being tracked for the
database table associated with the specified entity.
|
GlobalChangeEvent[] |
getGlobalEvents(int database,
long registerID,
long lastID)
Retrieve any new events that have been collected by a global event
clearinghouse, representing inserts, deletes, and updates made to
record types for which the caller previously has registered interest.
|
void |
insert(int database,
java.lang.String entity,
Record copy,
IndexState indexState,
boolean lock)
Begin tracking a newly inserted record in the dirty database.
|
boolean |
isDeleted(int database,
java.lang.String entity,
java.lang.Long id)
Indicate whether the record specified by the given entity and primary
key has been deleted within an uncommitted transaction in any
context.
|
boolean |
isTracked(int database,
java.lang.String entity,
java.lang.Long id)
Indicate whether the record specified by the given entity and primary
key is being tracked for changes within an uncommitted transaction.
|
<T> java.util.List<T> |
list(int database,
java.lang.String hql,
java.lang.Object[] params,
int maxResults,
int startOffset,
boolean readOnly)
Execute an HQL query and return the results as a list.
|
void |
lockAllIndexes(int database,
java.lang.String entity,
int lockType)
Lock or unlock all indexes associated with the given DMO entity.
|
long |
registerForGlobalEvents(int database,
java.lang.String entity)
Register with a global event clearinghouse an interest in insert,
delete, and update events which affect the given DMO entity.
|
void |
rollbackInsert(int database,
RecordIdentifier<java.lang.String> ident,
boolean lock)
Rollback the insert of a record previously introduced with the
insert(int, String, Record, IndexState, boolean) method. |
void |
update(int database,
java.lang.String entity,
java.lang.Long id,
java.lang.String[] properties,
int[] extIndexes,
BaseDataType[] values,
boolean lock)
Retrieve a DMO which is being tracked in the dirty database, and apply the specified updates
to it, as provided by the
properties , extIndexes and values
arguments. |
void |
update(int database,
java.lang.String entity,
Record copy,
java.lang.String[] properties,
int[] extIndexes,
BaseDataType[] values,
boolean lock)
Begin tracking a DMO for changes, based on the updates indicated by the
properties , extIndexes and values arguments. |
getMultiplexID
long registerForGlobalEvents(int database, java.lang.String entity)
database
- Value that uniquely identifies the target database on the
remote server.entity
- DMO entity for which the caller is interested in tracking
change.getGlobalEvents(int, long, long)
,
deregisterForGlobalEvents(int, long)
void deregisterForGlobalEvents(int database, long registerID)
database
- Value that uniquely identifies the target database on the
remote server.registerID
- A unique identifier for the registrant being deregistered.getGlobalEvents(int, long, long)
,
registerForGlobalEvents(int, String)
GlobalChangeEvent[] getGlobalEvents(int database, long registerID, long lastID) throws EventRegistrationException
database
- Value that uniquely identifies the target database on the
remote server.registerID
- A unique identifier for an object which has registered interest
in DMO changing events.lastID
- A unique identifier representing the last event retrieved by
the caller. If less than 0, it is assumed no events have yet
been retrieved since the caller registered interest in these
events.null
if no
such events have been collected.EventRegistrationException
- if registerID
is invalid or has expired.void lockAllIndexes(int database, java.lang.String entity, int lockType) throws PersistenceException
database
- Value that uniquely identifies the target database on the
remote server.entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.lockType
- Type of lock to acquire, or NONE
to release
existing locks. NO_WAIT
variants will be treated
as regular, blocking variants.PersistenceException
- if there is an error querying JDBC metadata while retrieving
index information.void insert(int database, java.lang.String entity, Record copy, IndexState indexState, boolean lock) throws PersistenceException
This record is removed when the current transaction is committed or rolled back.
database
- Value that uniquely identifies the target database on the remote server.entity
- Name of an entity, which is the name of the DMO implementation class associated
with a table being tracked for uncommitted changes.copy
- Record to be tracked.indexState
- The index update state of the record at the time of insertion.lock
- true
to acquire write locks to insert the record; false
to assume write locks are acquired by calling code.PersistenceException
- if there is any database error.void rollbackInsert(int database, RecordIdentifier<java.lang.String> ident, boolean lock) throws PersistenceException
insert(int, String, Record, IndexState, boolean)
method.database
- Value that uniquely identifies the target database on the
remote server.ident
- Identifier for the target record, which encapsulates its entity
name and primary key.lock
- true
to acquire write locks;
false
to assume write locks are acquired by
calling code.PersistenceException
- if there is any database error.boolean isTracked(int database, java.lang.String entity, java.lang.Long id)
database
- Value that uniquely identifies the target database on the
remote server.entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key of the record to be checked.true
to indicate the target record is being
tracked for changes, else false
.void update(int database, java.lang.String entity, Record copy, java.lang.String[] properties, int[] extIndexes, BaseDataType[] values, boolean lock) throws PersistenceException
properties
, extIndexes
and values
arguments.
Make a copy of the given record, apply the specified updates to that copy, and store the copy in the dirty database.
This record is removed when the adding context's current transaction is committed or rolled back.
database
- Value that uniquely identifies the target database on the
remote server.entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.copy
- Record to be tracked.properties
- Array of names of those DMO properties which were updated.
These should represent columns which participate in one or more indexes.extIndexes
- In case of EXTENT fields this array contains their index. Otherwise -1.values
- Updated DMO property values. Each value in the array
corresponds positionally with its matching property name in the
properties
array.lock
- true
to acquire write locks to update the record;
false
to assume write locks are acquired by calling code.PersistenceException
- if there is any database error.void update(int database, java.lang.String entity, java.lang.Long id, java.lang.String[] properties, int[] extIndexes, BaseDataType[] values, boolean lock) throws PersistenceException
properties
, extIndexes
and values
arguments. It is assumed the DMO already exists in the database, from a previous call to
update(int, String, Record, String[], int[], BaseDataType[], boolean)
.database
- Value that uniquely identifies the target database on the
remote server.entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key id of the record to be retrieved and updated.properties
- Array of names of those DMO properties which were updated.
These should represent columns which participate in one or more indexes.extIndexes
- In case of EXTENT fields this array contains their index. Otherwise -1.values
- Updated DMO property values. Each value in the array
corresponds positionally with its matching property name in the
properties
array.lock
- true
to acquire write locks to update the record;
false
to assume write locks are acquired by calling code.PersistenceException
- if there is any database error.int getEntityDirtyState(int database, java.lang.String entity)
database
- Value that uniquely identifies the target database on the
remote server.entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.DirtyInfo
. Zero return indicates entity is not
dirty. Only CHANGE
and DELETE
are
detected, not INSERT
.boolean isDeleted(int database, java.lang.String entity, java.lang.Long id)
database
- Value that uniquely identifies the target database on the
remote server.entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key of the record to be checked.true
if the specified record has been deleted,
else false
.void delete(int database, java.lang.String entity, java.lang.Long id, boolean rollback, boolean lock) throws PersistenceException
A record is unmarked when the adding context's current transaction is committed or rolled back.
database
- Value that uniquely identifies the target database on the
remote server.entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key of deleted record.rollback
- If false
, the target record is marked as deleted;
if true
, it is unmarked.lock
- true
to acquire write locks to delete the record;
false
to assume write locks are acquired by
calling code.PersistenceException
- if there was an error deleting the record from the database.Record getDirtyDMO(int database, java.lang.String entity, java.lang.Long id) throws PersistenceException
database
- Value that uniquely identifies the target database on the
remote server.entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key of the record to be retrieved.null
.PersistenceException
- if there is any database error.<T> java.util.List<T> list(int database, java.lang.String hql, java.lang.Object[] params, int maxResults, int startOffset, boolean readOnly) throws PersistenceException
Object
s.
No locking is attempted.
database
- Value that uniquely identifies the target database on the remote server.hql
- HQL query statement passed to Hibernate. This method makes no
assumptions as to the types of object(s) returned.params
- Substitution values for the query. If none, this should be an empty array.maxResults
- The maximum number of elements to be returned in the list.
If this value is non-positive, no upper limit is applied.startOffset
- The 0-based offset of the first record to retrieve. If this
value is non-positive, an offset of 0 is used by default.readOnly
- true
to execute the query in read-only mode, else false
.null
if no result was found.PersistenceException
- if there was an error executing the query.DirtyInfo getDirtyInfo(int database, java.lang.String entity, java.lang.Long candidateID, int index, java.util.List<java.lang.String> statements, java.lang.Object[] params, boolean rowidLookup) throws PersistenceException
If a DirtyInfo
object is returned by this method, it will contain overriding
information, such as a dirty DMO which matched the search criteria, whether that record was
newly inserted, or the fact that the candidate record found in the primary search has been
deleted or modified in an uncommitted transaction. A null
return indicates no
overriding information was available.
database
- Value that uniquely identifies the target database on the remote server.entity
- Name of an entity, which is the name of the DMO implementation class associated
with a table being tracked for uncommitted changes.candidateID
- Primary key ID of DMO, if any, found in the primary database, which matches the
current query criteria.index
- UID of index which governs the ordering of data in the current query.statements
- One or more HQL statements to be executed against the dirty database to find a
record which matches the current query criteria. The list is in order of most
specific to least specific search criteria.params
- Query substitution parameters which match placeholders in the most specific HQL
statement.rowidLookup
- The predicate of the query does a lookup for ROWID/RECID of the table. In case of
transient records they are accessible without the need of having a full matched
index.null
if no uncommitted change
information was available for the given arguments.PersistenceException
- if there was any database error.void cleanupChanges(int database, java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> subChanges, java.util.Set<RecordIdentifier<java.lang.String>> subInserts) throws PersistenceException
subChanges
, and remove from the master set
of uncommitted, inserted records the subset of records represented by
subInserts
.database
- Value that uniquely identifies the target database on the
remote server.subChanges
- Sets of primary keys representing those records to be removed
from uncommitted change tracking, mapped by entity name.subInserts
- A set of identifiers of those records to be removed from the
master set of uncommitted inserts.PersistenceException
- if there is any database error.void cleanupDeletes(int database, java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> subDeletes)
subDeletes
.database
- Value that uniquely identifies the target database on the
remote server.subDeletes
- Sets of primary keys representing those records to be removed
from uncommitted delete tracking, mapped by entity name.