/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.connectors;
import com.sun.appserv.connectors.internal.api.ConnectorRuntimeException;
import com.sun.appserv.connectors.internal.api.WorkContextHandler;
import com.sun.enterprise.config.serverbeans.Cluster;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.config.serverbeans.Server;
import com.sun.logging.LogDomains;
import javax.resource.spi.BootstrapContext;
import javax.resource.spi.XATerminator;
import javax.resource.spi.work.WorkManager;
import javax.resource.spi.work.WorkContext;
import javax.transaction.TransactionSynchronizationRegistry;
import javax.naming.InitialContext;
import org.glassfish.internal.api.Globals;
import org.glassfish.server.ServerEnvironmentImpl;
import org.glassfish.api.admin.ProcessEnvironment;
import org.glassfish.api.admin.ProcessEnvironment.ProcessType;
import java.io.Serializable;
import java.util.Timer;
import java.util.logging.Logger;
import java.util.logging.Level;
/**
* BootstrapContext implementation.
*
* @author Qingqing Ouyang, Binod P.G
*/
public final class BootstrapContextImpl implements BootstrapContext, Serializable {
private static final long serialVersionUID = -8449694716854376406L;
private String poolId;
private transient WorkManager wm;
private XATerminator xa;
private String moduleName;
private String threadPoolId;
private ClassLoader rarCL;
private String instanceName;
private ProcessType processType;
private static final Logger logger =
LogDomains.getLogger(BootstrapContextImpl.class, LogDomains.RSR_LOGGER);
/**
* Constructs a <code>BootstrapContext</code> with default
* thread pool for work manager.
*
* @param moduleName resource-adapter name
* @throws ConnectorRuntimeException If there is a failure in
* retrieving WorkManager.
*/
public BootstrapContextImpl (String moduleName) throws ConnectorRuntimeException{
this.moduleName = moduleName;
initializeWorkManager();
}
/**
* Constructs a <code>BootstrapContext</code> with a specified
* thread pool for work manager.
*
* @param poolId thread-pool-id
* @param moduleName resource-adapter name
* @throws ConnectorRuntimeException If there is a failure in
* retrieving WorkManager.
*/
public BootstrapContextImpl (String poolId, String moduleName, ClassLoader rarCL)
throws ConnectorRuntimeException{
this.threadPoolId = poolId;
this.moduleName = moduleName;
this.rarCL = rarCL;
initializeWorkManager();
}
/**
* Creates a <code>java.util.Timer</code> instance.
* This can cause a problem, since the timer threads are not actually
* under appserver control. We should override the timer later.
*
* @return <code>java.util.Timer</code> object.
*/
public Timer createTimer() {
// set the timer as 'daemon' such that RAs that do not cancel the timer during
// ra.stop() will not block (eg : server shutdown)
return new Timer("connectors-runtime-context", true);
}
/**
* {@inheritDoc}
*/
public boolean isContextSupported(Class<? extends WorkContext> aClass) {
WorkContextHandler wch = ConnectorRuntime.getRuntime().getWorkContextHandler();
wch.init(moduleName, rarCL);
return wch.isContextSupported(true, aClass.getName());
}
/**
* {@inheritDoc}
*/
public TransactionSynchronizationRegistry getTransactionSynchronizationRegistry() {
try{
InitialContext ic = new InitialContext();
return (TransactionSynchronizationRegistry)ic.lookup("java:comp/TransactionSynchronizationRegistry");
}catch(Exception e){
logger.log(Level.WARNING, "tx.sync.registry.lookup.failed", e);
RuntimeException re = new RuntimeException("Transaction Synchronization Registry Unavailable");
re.initCause(e);
throw re;
}
}
/**
* Retrieves the work manager.
*
* @return <code>WorkManager</code> instance.
* @see com.sun.enterprise.connectors.work.CommonWorkManager
* @see com.sun.enterprise.connectors.work.WorkManagerFactoryImpl
*/
public WorkManager getWorkManager() {
initializeWorkManager();
return wm;
}
/**
* initialize work manager reference
*/
private void initializeWorkManager() {
if (wm == null) {
try {
wm = ConnectorRuntime.getRuntime().getWorkManagerProxy(threadPoolId, moduleName, rarCL);
} catch(Exception e) {
logger.log(Level.SEVERE, "workmanager.instantiation_error", e);
}
}
}
/**
* Retrieves the <code>XATerminator</code> object.
*/
public XATerminator getXATerminator() {
initializeXATerminator();
return xa;
}
/**
* initializes XATerminator reference
*/
private void initializeXATerminator() {
if (xa == null) {
xa = ConnectorRuntime.getRuntime().getXATerminatorProxy(moduleName);
}
}
/**
* {@inheritDoc}
* @Override
*/
public String getInstanceName(){
if(processType == null){
ProcessEnvironment pe = Globals.get(ProcessEnvironment.class);
processType = pe.getProcessType();
// Only if this RA is running in a server environment and the server
// is a clustered instance, set the variable instanceName as the real
// server instance name. Otherwise keep the instance name as null.
if(processType.isServer()){
ServerEnvironmentImpl env = Globals.get(ServerEnvironmentImpl.class);
String instance = env.getInstanceName();
// Only if this RA is running in a server environment, then the Domain instance
// can be looked up through HK2.
Domain domain = Globals.get(Domain.class);
Server server = domain.getServerNamed(instance);
Cluster cluster = server.getCluster();
if(cluster!=null){
String cName = cluster.getName();
instanceName = instance;
}
}
}
return instanceName;
}
}