Purpose: Add login and configuration API to that of Session. This interface is to be used during the creation and login of the session only. The Session interface should be used after login for normal reading/writing.
| Modifier and Type | Method and Description |
|---|---|
| public void | |
| public void | |
| public void | |
| public void | |
| public void | |
| public void | |
| public void | deleteAllObjects(Collection<E> domainObjects)
PUBLIC: delete all of the objects and all of their privately owned parts in the database. |
| public Object | deleteObject(Object domainObject)
PUBLIC: Delete the object and all of its privately owned parts from the database. |
| public CommandManager | Returns: The CommandManager instance that controls the remote command service for this session.ADVANCED: Return the CommandManager that allows this session to act as a CommandProcessor and receive or propagate commands from/to the EclipseLink cluster. |
| public DatabaseEventListener | getDatabaseEventListener()
Return the database event listener, this allows database events to invalidate the cache. |
| public SequencingControl | getSequencingControl()
PUBLIC: Return SequencingControl which used for sequencing setup and customization including management of sequencing preallocation. |
| public ServerPlatform | getServerPlatform()
Redeclares org. |
| public Object | insertObject(Object domainObject)
PUBLIC: Insert the object and all of its privately owned parts into the database. |
| public boolean | isInTransaction()
PUBLIC: Return if the session is currently in the progress of a database transaction. |
| public void | |
| public void | |
| public void | |
| public void | |
| public Object | refreshAndLockObject(Object object)
PUBLIC: Refresh the attributes of the object and of all of its private parts from the database. |
| public Object | refreshAndLockObject(Object object, short lockMode)
PUBLIC: Refresh the attributes of the object and of all of its private parts from the database. |
| public void | |
| public void | setCommandManager(CommandManager
The CommandManager instance to control the remote command
service for this session. commandManager)ADVANCED: Set the CommandManager that allows this session to act as a CommandProcessor and receive or propagate commands from/to the EclipseLink cluster. |
| public void | setDatabaseEventListener(DatabaseEventListener databaseEventListener)
PUBLIC: Set the database event listener, this allows database events to invalidate the cache. |
| public void | |
| public void | setExternalTransactionController(ExternalTransactionController etc)
Redeclares org. |
| public void | |
| public void | setServerPlatform(ServerPlatform newServerPlatform)
PUBLIC: Set the server platform defining server-specific behavior for the receiver (Oc4j, WLS, ... |
| public void | setShouldPropagateChanges(boolean
If true (and the CommandManager is set) then propagation will occur. choice)ADVANCED: Set if cache changes should be propagated to other sessions or applications in a EclipseLink cluster through the Remote Command Manager mechanism. |
| public boolean | Returns: true if propagation is set to occur, false if not.ADVANCED: Return whether changes should be propagated to other sessions or applications in a EclipseLink cluster through the Remote Command Manager mechanism. |
| public Object | updateObject(Object domainObject)
PUBLIC: Update the object and all of its privately owned parts in the database. |
| public void | writeAllObjects(Collection<E> domainObjects)
PUBLIC: Write all of the objects and all of their privately owned parts in the database. |
| public Object | writeObject(Object domainObject)
PUBLIC: Write the object and all of its privately owned parts in the database. |
| addDescriptor | back to summary |
|---|---|
| public void addDescriptor(ClassDescriptor descriptor) PUBLIC: Add the descriptor to the session. All persistent classes must have a descriptor registered for them with the session. It is best to add the descriptors before login, if added after login the order in which descriptors are added is dependent on inheritance and references unless the addDescriptors method is used. | |
| addDescriptors | back to summary |
|---|---|
| public void addDescriptors(Collection<E> descriptors) PUBLIC: Add the descriptors to the session. All persistent classes must have a descriptor registered for them with the session. This method allows for a batch of descriptors to be added at once so that EclipseLink can resolve the dependencies between the descriptors and perform initialization optimally. | |
| addDescriptors | back to summary |
|---|---|
| public void addDescriptors(Project project) PUBLIC: Add the descriptors to the session from the Project. This can be used to combine the descriptors from multiple projects into a single session. This can be called after the session has been connected as long as there are no external dependencies. | |
| addSequence | back to summary |
|---|---|
| public void addSequence(Sequence sequence) PUBLIC: Add the sequence to the session. Allows to add a new sequence to the session even if the session is connected. If the session is connected then the sequence is added only if there is no sequence with the same name already in use. Call this method before addDescriptor(s) if need to add new descriptor with a new non-default sequence to connected session.
| |
| beginTransaction | back to summary |
|---|---|
| public void beginTransaction() throws DatabaseException PUBLIC: Begin a transaction on the database. This allows a group of database modification to be committed or rolledback as a unit. All writes/deletes will be sent to the database be will not be visible to other users until commit. Although databases do not allow nested transaction, EclipseLink supports nesting through only committing to the database on the outer commit.
| |
| commitTransaction | back to summary |
|---|---|
| public void commitTransaction() throws DatabaseException PUBLIC: Commit the active database transaction. This allows a group of database modification to be committed or rolledback as a unit. All writes/deletes will be sent to the database be will not be visible to other users until commit. Although databases do not allow nested transaction, EclipseLink supports nesting through only committing to the database on the outer commit.
| |
| deleteAllObjects | back to summary |
|---|---|
| public void deleteAllObjects(Collection<E> domainObjects) PUBLIC: delete all of the objects and all of their privately owned parts in the database. The allows for a group of objects to be deleted as a unit. The objects will be deleted through a single transactions.
| |
| deleteObject | back to summary |
|---|---|
| public Object deleteObject(Object domainObject) throws DatabaseException, OptimisticLockException PUBLIC: Delete the object and all of its privately owned parts from the database. The delete operation can be customized through using a delete query. | |
| getCommandManager | back to summary |
|---|---|
| public CommandManager getCommandManager() ADVANCED: Return the CommandManager that allows this session to act as a CommandProcessor and receive or propagate commands from/to the EclipseLink cluster. This can be set to enable cache synchronization in a clustered environment where multiple servers in the cluster update the same database.
| |
| getDatabaseEventListener | back to summary |
|---|---|
| public DatabaseEventListener getDatabaseEventListener() Return the database event listener, this allows database events to invalidate the cache. | |
| getSequencingControl | back to summary |
|---|---|
| public SequencingControl getSequencingControl() PUBLIC: Return SequencingControl which used for sequencing setup and customization including management of sequencing preallocation. | |
| getServerPlatform | back to summary |
|---|---|
| public ServerPlatform getServerPlatform() Redeclares org. PUBLIC: Answer the server platform defining server-specific behavior for the receiver (Oc4j, WLS, ...). If the user wants a different external transaction controller class or to provide some different behavior than the provided ServerPlatform(s), we recommend subclassing org.eclipse.persistence.platform.server.ServerPlatformBase (or a subclass), and overriding: ServerPlatformBase.getExternalTransactionControllerClass() ServerPlatformBase.registerMBean() ServerPlatformBase.unregisterMBean() for the desired behavior.
| |
| insertObject | back to summary |
|---|---|
| public Object insertObject(Object domainObject) throws DatabaseException PUBLIC: Insert the object and all of its privately owned parts into the database. Insert should only be used if the application knows that the object is new, otherwise writeObject should be used. The insert operation can be customized through using an insert query. | |
| isInTransaction | back to summary |
|---|---|
| public boolean isInTransaction() PUBLIC: Return if the session is currently in the progress of a database transaction. Because nested transactions are allowed check if the transaction mutex has been acquired. | |
| login | back to summary |
|---|---|
| public void login() throws DatabaseException PUBLIC: Connect to the database using the predefined login. The login must have been assign when or after creating the session.
| |
| login | back to summary |
|---|---|
| public void login(String userName, String password) throws DatabaseException PUBLIC: Connect to the database using the given user name and password. The additional login information must have been preset in the session's login attribute. This is the login that should be used if each user has their own id, but all users share the same database configuration. Under this login mode the password should not stay within the login definition after login. | |
| login | back to summary |
|---|---|
| public void login(Login login) throws DatabaseException PUBLIC: Connect to the database using the given login. The login may also the preset and the login() protocol called. This is the login should only be used if each user has their own database configuration. Under this login mode the password should not stay within the login definition after login. | |
| logout | back to summary |
|---|---|
| public void logout() throws DatabaseException PUBLIC: Disconnect from the database.
| |
| refreshAndLockObject | back to summary |
|---|---|
| public Object refreshAndLockObject(Object object) PUBLIC: Refresh the attributes of the object and of all of its private parts from the database. The object will be pessimistically locked on the database for the duration of the transaction. If the object is already locked this method will wait until the lock is released. A no wait option is available through setting the lock mode.
| |
| refreshAndLockObject | back to summary |
|---|---|
| public Object refreshAndLockObject(Object object, short lockMode) PUBLIC: Refresh the attributes of the object and of all of its private parts from the database. The object will be pessimistically locked on the database for the duration of the transaction. Lock Modes: ObjectBuildingQuery.NO_LOCK, LOCK, LOCK_NOWAIT | |
| rollbackTransaction | back to summary |
|---|---|
| public void rollbackTransaction() throws DatabaseException PUBLIC: Rollback the active database transaction. This allows a group of database modification to be committed or rolled back as a unit. All writes/deletes will be sent to the database be will not be visible to other users until commit. Although databases do not allow nested transaction, EclipseLink supports nesting through only committing to the database on the outer commit.
| |
| setCommandManager | back to summary |
|---|---|
| public void setCommandManager(CommandManager commandManager) ADVANCED: Set the CommandManager that allows this session to act as a CommandProcessor and receive or propagate commands from/to the EclipseLink cluster. This can be used to enable cache synchronization in a clustered environment where multiple servers in the cluster update the same database. To enable cache synchronization you must also set, setShouldPropagateChanges to true.
| |
| setDatabaseEventListener | back to summary |
|---|---|
| public void setDatabaseEventListener(DatabaseEventListener databaseEventListener) PUBLIC: Set the database event listener, this allows database events to invalidate the cache. | |
| setDatasourceLogin | back to summary |
|---|---|
| public void setDatasourceLogin(Login login) PUBLIC: Set the login. | |
| setExternalTransactionController | back to summary |
|---|---|
| public void setExternalTransactionController(ExternalTransactionController etc) Redeclares org. PUBLIC: Used for JTS integration. If your application requires to have JTS control transactions instead of EclipseLink an external transaction controller must be specified. EclipseLink provides JTS controllers for JTS 1.0 and Weblogic's JTS. | |
| setLogin | back to summary |
|---|---|
| public void setLogin(Login login) PUBLIC: Set the login. | |
| setServerPlatform | back to summary |
|---|---|
| public void setServerPlatform(ServerPlatform newServerPlatform) PUBLIC: Set the server platform defining server-specific behavior for the receiver (Oc4j, WLS, ... ). This is not permitted after the session is logged in. If the user wants a different external transaction controller class or to provide some different behavior than the provided ServerPlatform(s), we recommend subclassing org.eclipse.persistence.platform.server.ServerPlatformBase (or a subclass), and overriding: ServerPlatformBase.getExternalTransactionControllerClass() ServerPlatformBase.registerMBean() ServerPlatformBase.unregisterMBean() for the desired behavior. | |
| setShouldPropagateChanges | back to summary |
|---|---|
| public void setShouldPropagateChanges(boolean choice) ADVANCED: Set if cache changes should be propagated to other sessions or applications in a EclipseLink cluster through the Remote Command Manager mechanism. This can be used to enable cache synchronization in a clustered environment where multiple servers in the cluster update the same database. In order for this to occur the CommandManager must be set.
| |
| shouldPropagateChanges | back to summary |
|---|---|
| public boolean shouldPropagateChanges() ADVANCED: Return whether changes should be propagated to other sessions or applications in a EclipseLink cluster through the Remote Command Manager mechanism. In order for this to occur the CommandManager must be set.
| |
| updateObject | back to summary |
|---|---|
| public Object updateObject(Object domainObject) throws DatabaseException, OptimisticLockException PUBLIC: Update the object and all of its privately owned parts in the database. Update should only be used if the application knows that the object is new, otherwise writeObject should be used. The update operation can be customized through using an update query. | |
| writeAllObjects | back to summary |
|---|---|
| public void writeAllObjects(Collection<E> domainObjects) PUBLIC: Write all of the objects and all of their privately owned parts in the database. The allows for a group of objects to be committed as a unit. The objects will be committed through a single transactions.
| |
| writeObject | back to summary |
|---|---|
| public Object writeObject(Object domainObject) throws DatabaseException, OptimisticLockException PUBLIC: Write the object and all of its privately owned parts in the database. Write will determine if an insert or an update should be done, it may go to the database to determine this (by default will check the identity map). The write operation can be customized through using an write query. | |