jakarta.resource.spi.work.WorkContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

The newest version!

/*
 * Copyright (c) 1997, 2020 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.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.resource.spi.work;

import java.io.Serializable;

/**
 * This class serves as a standard mechanism for a resource adapter to propagate
 * an imported context from an enterprise information system to an application
 * server.
 * 
 * 
 * A Work instance, that implements the
 * WorkContextProvider, could provide a List of these
 * WorkContext instances (through the getWorkContexts() method),
 * and have them setup as the execution context by the WorkManager
 * when the Work instance gets executed.
 *
 * The resource adapter must not make any changes to the state of the 
 * WorkContext after the Work instance corresponding 
 * to that WorkContext has been submitted to the WorkManager.
 *
 * @since 1.6
 */

public interface WorkContext extends Serializable {
	/**
	 * Get the associated name of the WorkContext. This could be
	 * used by the WorkManager and the resource adapter for debugging purposes.
	 * 

	 * 
	 * @return the associated name of the WorkContext
	 */
	String getName();

	/**
	 * Get the brief description of the role played by the
	 * WorkContext and any other related debugging information.
	 * This could be used by the WorkManager and the resource adapter for
	 * debugging purposes.
	 * 
	 * 
	 * @return the associated description of the WorkContext
	 */
	String getDescription();

}