org.eclipse.persistence.sessions.DatabaseSession Maven / Gradle / Ivy
Show all versions of eclipselink Show documentation
/*
* Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.sessions;
import org.eclipse.persistence.descriptors.ClassDescriptor;
import org.eclipse.persistence.exceptions.ConcurrencyException;
import org.eclipse.persistence.exceptions.DatabaseException;
import org.eclipse.persistence.exceptions.EclipseLinkException;
import org.eclipse.persistence.exceptions.OptimisticLockException;
import org.eclipse.persistence.platform.database.events.DatabaseEventListener;
import org.eclipse.persistence.platform.server.ServerPlatform;
import org.eclipse.persistence.sequencing.Sequence;
import org.eclipse.persistence.sequencing.SequencingControl;
import org.eclipse.persistence.sessions.coordination.CommandManager;
import java.util.Collection;
/**
*
* 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.
*/
public interface DatabaseSession extends Session {
/**
* 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.
*
* @see #addDescriptors(Collection)
* @see #addDescriptors(Project)
*/
void addDescriptor(ClassDescriptor descriptor);
/**
* 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.
*/
void addDescriptors(Collection descriptors);
/**
* 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.
*
* @see #addDescriptor
* @see #addDescriptors
*/
void addSequence(Sequence sequence);
/**
* 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.
*/
void addDescriptors(org.eclipse.persistence.sessions.Project project);
/**
* 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.
*
* @exception DatabaseException if the database connection is lost or the begin is rejected.
*
* @see #isInTransaction()
*/
void beginTransaction() 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.
*
* @exception DatabaseException most databases validate changes as they are done,
* normally errors do not occur on commit unless the disk fails or the connection is lost.
* @exception ConcurrencyException if this session is not within a transaction.
*/
void commitTransaction() throws DatabaseException;
/**
* 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.
*
* @exception DatabaseException if an error occurs on the database,
* these include constraint violations, security violations and general database errors.
* @exception OptimisticLockException if the object's descriptor is using optimistic locking and
* the object has been updated or deleted by another user since it was last read.
*/
void deleteAllObjects(Collection domainObjects);
/**
* 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.
*
* @see org.eclipse.persistence.queries.DeleteObjectQuery
*/
Object deleteObject(Object domainObject) throws DatabaseException, OptimisticLockException;
/**
* 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.
*
* @see org.eclipse.persistence.queries.InsertObjectQuery
* @see #writeObject(Object)
*/
Object insertObject(Object domainObject) throws DatabaseException;
/**
* 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.
*/
boolean isInTransaction();
/**
* 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.
*
* @see org.eclipse.persistence.platform.server.ServerPlatformBase
*/
void setServerPlatform(ServerPlatform newServerPlatform);
/**
* 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.
*
* @see org.eclipse.persistence.platform.server.ServerPlatformBase
*/
@Override ServerPlatform getServerPlatform();
/**
* PUBLIC:
* Return SequencingControl which used for sequencing setup and
* customization including management of sequencing preallocation.
*/
SequencingControl getSequencingControl();
/**
* PUBLIC:
* Connect to the database using the predefined login.
* The login must have been assign when or after creating the session.
*
* @see #login(Login)
*/
void login() 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.
*/
void login(String userName, String password) 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.
*/
void login(Login login) throws DatabaseException;
/**
* PUBLIC:
* Disconnect from the database.
*
* @exception EclipseLinkException if a transaction is active, you must rollback any active transaction before logout.
* @exception DatabaseException the database will also raise an error if their is an active transaction,
* or a general error occurs.
*/
void logout() throws DatabaseException;
/**
* 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.
* @see #refreshAndLockObject(Object, short)
*/
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.
*
Lock Modes: ObjectBuildingQuery.NO_LOCK, LOCK, LOCK_NOWAIT
*/
Object refreshAndLockObject(Object object, short lockMode);
/**
* 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.
*
* @exception DatabaseException if the database connection is lost or the rollback fails.
* @exception ConcurrencyException if this session is not within a transaction.
*/
void rollbackTransaction() throws DatabaseException;
/**
* 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.
* @see org.eclipse.persistence.transaction.JTATransactionController
* @see org.eclipse.persistence.platform.server.CustomServerPlatform
*/
//@deprecated was removed from this method as there is no viable alternative bug 5637867 was filed to
// have this resolved.
@Override void setExternalTransactionController(ExternalTransactionController etc);
/**
* 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.
*
* @see CommandManager
* @return The CommandManager instance that controls the remote command
* service for this session.
*/
CommandManager getCommandManager();
/**
* 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.
*
* @see #setShouldPropagateChanges(boolean)
* @see CommandManager
* @param commandManager The CommandManager instance to control the remote command
* service for this session.
*/
void setCommandManager(CommandManager commandManager);
/**
* 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.
*
* @see #setCommandManager(CommandManager)
* @param choice If true (and the CommandManager is set) then propagation will occur.
*/
void setShouldPropagateChanges(boolean choice);
/**
* 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.
*
* @see #setCommandManager(CommandManager)
* @return true if propagation is set to occur, false if not.
*/
boolean shouldPropagateChanges();
/**
* PUBLIC:
* Set the login.
*/
void setLogin(Login login);
/**
* PUBLIC:
* Set the login.
*/
void setDatasourceLogin(Login login);
/**
* 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.
*
* @see org.eclipse.persistence.queries.UpdateObjectQuery
* @see #writeObject(Object)
*/
Object updateObject(Object domainObject) throws DatabaseException, OptimisticLockException;
/**
* 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.
*
* @exception DatabaseException if an error occurs on the database,
* these include constraint violations, security violations and general database errors.
* @exception OptimisticLockException if the object's descriptor is using optimistic locking and
* the object has been updated or deleted by another user since it was last read.
*/
void writeAllObjects(Collection domainObjects);
/**
* 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.
*
* @see org.eclipse.persistence.queries.WriteObjectQuery
* @see #insertObject(Object)
* @see #updateObject(Object)
*/
Object writeObject(Object domainObject) throws DatabaseException, OptimisticLockException;
/**
* Return the database event listener, this allows database events to invalidate the cache.
*/
DatabaseEventListener getDatabaseEventListener();
/**
* PUBLIC:
* Set the database event listener, this allows database events to invalidate the cache.
*/
void setDatabaseEventListener(DatabaseEventListener databaseEventListener);
}