org.eclipse.persistence.platform.server.CustomServerPlatform Maven / Gradle / Ivy
/*
* 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.platform.server;
import org.eclipse.persistence.sessions.DatabaseSession;
import org.eclipse.persistence.sessions.ExternalTransactionController;
/**
* INTERNAL:
*
* This is the concrete subclass responsible for handling backward compatibility for 9.0.4.
*
* This platform overrides:
*
* getExternalTransactionControllerClass(): to use a user-specified controller class
*
* This platform adds:
*
* setExternalTransactionControllerClass(Class newClass): to allow the user to define
* the external transaction controller when the 904 sessions.xml defines an
* external-transaction-controller-class.
*
*/
public final class CustomServerPlatform extends ServerPlatformBase {
/**
* INTERNAL:
* Default Constructor: JTA is disabled until a transaction controller class is set.
* Runtime services are disabled.
*/
public CustomServerPlatform(DatabaseSession newDatabaseSession) {
super(newDatabaseSession);
this.disableRuntimeServices();
}
/**
* INTERNAL: getExternalTransactionControllerClass(): Answer the class of external transaction controller to use
* in the DatabaseSession
* This is defined by the user via the 904 sessions.xml.
*
* @return Class externalTransactionControllerClass
*
* @see org.eclipse.persistence.transaction.JTATransactionController
* @see #isJTAEnabled()
* @see #disableJTA()
* @see #initializeExternalTransactionController()
*/
@Override
public Class getExternalTransactionControllerClass() {
return externalTransactionControllerClass;
}
/**
* INTERNAL: externalTransactionControllerNotNullWarning():
* When the external transaction controller is being initialized, we warn the developer
* if they have already defined the external transaction controller in some way other
* than subclassing ServerPlatformBase.
*
* This warning is omitted in 9.0.4.
*
* @see ServerPlatformBase
*
*/
@Override
protected void externalTransactionControllerNotNullWarning() {
//do nothing, because it would be really annoying to show a warning here
}
}