oracle.toplink.essentials.platform.server.CustomServerPlatform Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.platform.server;
import oracle.toplink.essentials.internal.sessions.DatabaseSessionImpl;
import oracle.toplink.essentials.platform.server.ServerPlatformBase;
/**
* 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(DatabaseSessionImpl 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 oracle.toplink.essentials.transaction.JTATransactionController
* @see #isJTAEnabled()
* @see #disableJTA()
* @see #initializeExternalTransactionController()
*/
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
*
* @return void
*
*/
protected void externalTransactionControllerNotNullWarning() {
//do nothing, because it would be really annoying to show a warning here
}
}