Java tutorial
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 1997-2018 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://oss.oracle.com/licenses/CDDL+GPL-1.1 * or 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 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 javax.resource.spi; import java.util.Timer; import javax.resource.spi.work.WorkManager; import javax.resource.spi.work.WorkContext; import javax.transaction.TransactionSynchronizationRegistry; /** * This provides a mechanism to pass a bootstrap context to a resource adapter * instance when it is bootstrapped. That is, when * (<code>start(BootstrapContext)</code>) method on the * <code>ResourceAdapter</code> class is invoked. The bootstrap * context contains references to useful facilities that could be used by the * resource adapter instance. * * @version Java EE Connector Architecture 1.6 * @author Ram Jeyaraman, Sivakumar Thyagarajan */ public interface BootstrapContext { /** * Provides a handle to a <code>WorkManager</code> instance. The * <code>WorkManager</code> instance could be used by a resource adapter to * do its work by submitting <code>Work</code> instances for execution. * * @return a <code>WorkManager</code> instance. */ WorkManager getWorkManager(); /** * Provides a handle to a <code>XATerminator</code> instance. The * <code>XATerminator</code> instance could be used by a resource adapter * to flow-in transaction completion and crash recovery calls from an EIS. * * @return a <code>XATerminator</code> instance. */ XATerminator getXATerminator(); /** * Creates a new <code>java.util.Timer</code> instance. The * <code>Timer</code> instance could be used to perform periodic * <code>Work</code> executions or other tasks. * * @throws UnavailableException indicates that a * <code>Timer</code> instance is not available. The * request may be retried later. * * @return a new <code>Timer</code> instance. */ Timer createTimer() throws UnavailableException; /** * A resource adapter can check an application server's support * for a particular WorkContext type through this method. * This mechanism enables a resource adapter developer to * dynamically change the WorkContexts submitted with a Work instance * based on the support provided by the application server. * * The application server must employ an exact type equality check (that is * <code>java.lang.Class.equals(java.lang.Class)</code> check) in * this method, to check if it supports the WorkContext type provided * by the resource adapter. This method must be idempotent, that is all * calls to this method by a resource adapter for a particular * <code>WorkContext</code> type must return the same boolean value * throughout the lifecycle of that resource adapter instance. * * @param workContextClass The WorkContext type that is tested for * support by the application server. * * @return true if the <code>workContextClass</code> is supported * by the application server. false if the <code>workContextClass</code> * is unsupported or unknown to the application server. * * @since 1.6 */ boolean isContextSupported(Class<? extends WorkContext> workContextClass); /** * Provides a handle to a <code>TransactionSynchronization</code> instance. The * <code>TransactionSynchronizationRegistry</code> instance could be used by a * resource adapter to register synchronization objects, get transaction state and * status etc. This interface is implemented by the application server by a * stateless service object. The same object can be used by any number of * resource adapter objects with thread safety. * * @return a <code>TransactionSynchronizationRegistry</code> instance. * @since 1.6 */ TransactionSynchronizationRegistry getTransactionSynchronizationRegistry(); }