|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SequencingControl
Purpose: Define an interface to control sequencing functionality.
Description: This interface is accessed through DatabaseSession.getSequencingControl(). It allows to create, re-create, customize Sequencing object which is available through DatabaseSession.getSequencing() and provides sequencing values for all descriptors that use sequencing. Here's the lifecycle of Sequencing object used by DatabaseSession: 1. DatabaseSession created - sequencing object doesn't yet exist; 2. DatabaseSession.login() causes creation of Sequencing object; 3. DatabaseSession.logout() causes destruction of Sequencing object. In case sequencing object doesn't yet exist all the set parameters' values will be used during its creation. In case sequencing object already exists: 1. The following methods don't alter sequencing object - the corresponding parameters will only be used in case a new sequencing object is created: setShouldUseSeparateConnection; setLogin; setMinPoolSize; setMaxPoolSize. 2. The following methods cause immediate destruction of the sequencing object and creation of a new one: setValueGenerationPolicy; setShouldUseNativeSequencing; setShouldUseTableSequencing; resetSequencing; 3. The following methods cause change immediately: setPreallocationSize (next sequencing preallocation will use the set parameter's value).
Responsibilities:
Sequence
, DatabaseSession
Method Summary | |
---|---|
ConnectionPool |
getConnectionPool() ADVANCED: Return the connection pool to use for sequencing. |
Login |
getLogin() ADVANCED: Return a DatabaseLogin to be used by separate sequencing connection(s). |
int |
getMaxPoolSize() PUBLIC: Returns a maximum number of connections in sequencing connection pool |
int |
getMinPoolSize() PUBLIC: Returns a minimum number of connections in sequencing connection pool. |
void |
initializePreallocated() ADVANCED: Removes all preallocated sequencing objects. |
void |
initializePreallocated(java.lang.String seqName) ADVANCED: Removes all preallocated sequencing objects for the given sequence name. |
boolean |
isConnectedUsingSeparateConnection() PUBLIC: Indicates whether sequencing actually uses separate connection(s). |
void |
resetSequencing() ADVANCED: Immediately re-create sequencing object. |
void |
setConnectionPool(ConnectionPool pool) ADVANCED: Set the connection pool to use for sequencing. |
void |
setInitialPoolSize(int size) PUBLIC: Sets a initial number of connections in sequencing connection pool The set value is ignored if shouldUseSeparateConnection() returns false. |
void |
setLogin(Login login) ADVANCED: Returns a DatabaseLogin to be used by separate sequencing connection(s) The set value is ignored if shouldUseSeparateConnection() returns false. |
void |
setMaxPoolSize(int size) PUBLIC: Sets a maximum number of connections in sequencing connection pool The set value is ignored if shouldUseSeparateConnection() returns false. |
void |
setMinPoolSize(int size) PUBLIC: Sets a minimum number of connections in sequencing connection pool The set value is ignored if shouldUseSeparateConnection() returns false. |
void |
setShouldUseSeparateConnection(boolean shouldUseSeparateConnection) PUBLIC: Set whether separate connection(s) for sequencing could be used (by default it couldn't). |
boolean |
shouldUseSeparateConnection() PUBLIC: Indicate whether separate connection(s) for sequencing could be used (by default it couldn't). |
Method Detail |
---|
void resetSequencing()
boolean shouldUseSeparateConnection()
Sequence
void setShouldUseSeparateConnection(boolean shouldUseSeparateConnection)
Sequence
boolean isConnectedUsingSeparateConnection()
Sequence
Login getLogin()
DatabaseLogin
void setLogin(Login login)
DatabaseLogin
ConnectionPool getConnectionPool()
void setConnectionPool(ConnectionPool pool)
int getMinPoolSize()
ConnectionPool
, ServerSession
void setMinPoolSize(int size)
ConnectionPool
, ServerSession
int getMaxPoolSize()
ConnectionPool
, ServerSession
void setMaxPoolSize(int size)
ConnectionPool
, ServerSession
void setInitialPoolSize(int size)
ConnectionPool
, ServerSession
void initializePreallocated()
Sequence
void initializePreallocated(java.lang.String seqName)
Sequence
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |