javax.resource.spi.BootstrapContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.resource-api Show documentation
Show all versions of javax.resource-api Show documentation
Java EE Connector Architecture API
/*
* 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 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
* (start(BootstrapContext)) method on the
* ResourceAdapter 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 WorkManager instance. The
* WorkManager instance could be used by a resource adapter to
* do its work by submitting Work instances for execution.
*
* @return a WorkManager instance.
*/
WorkManager getWorkManager();
/**
* Provides a handle to a XATerminator instance. The
* XATerminator instance could be used by a resource adapter
* to flow-in transaction completion and crash recovery calls from an EIS.
*
* @return a XATerminator instance.
*/
XATerminator getXATerminator();
/**
* Creates a new java.util.Timer instance. The
* Timer instance could be used to perform periodic
* Work executions or other tasks.
*
* @throws UnavailableException indicates that a
* Timer instance is not available. The
* request may be retried later.
*
* @return a new Timer 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
* java.lang.Class.equals(java.lang.Class) 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
* WorkContext 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 workContextClass is supported
* by the application server. false if the workContextClass
* is unsupported or unknown to the application server.
*
* @since 1.6
*/
boolean isContextSupported(
Class workContextClass);
/**
* Provides a handle to a TransactionSynchronization instance. The
* TransactionSynchronizationRegistry 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 TransactionSynchronizationRegistry instance.
* @since 1.6
*/
TransactionSynchronizationRegistry getTransactionSynchronizationRegistry();
/**
* Returns the name of the application server instance in which this method is
* being executed. If the application has been deployed into a clustered application
* server then this name must be different for every instance within the cluster.
* Otherwise if this resource adapter is deployed into a standalone application
* server, returns null.
*
* The name must consist of Java letters or digits (as defined in the Java Language
* Specification) or the ASCII underscore (_ or \u005f).
*
* Since an instance name may be visible to the user or administrator it is
* recommended that this name is at least partly human-readable.
*
* It is recommended that this name remains unchanged even if the application server
* instance is restarted or reconfigured.
*
* The resource adapter may use this value in combination with the value returned
* by the MessageEndpointFactory.getActivationName method as a valid
* JMS subscription name which is unique to the message endpoint.
*
* The combination of this value and the value returned by the
* MessageEndpointFactory.getActivationName method should be no longer
* than 128 characters.
*
* @return a new String instance.
* @see javax.resource.spi.endpoint.MessageEndpointFactory
* @version Java EE Connector Architecture 1.7
*/
String getInstanceName();
}