jakarta.resource.spi.work.WorkContextProvider 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).

There is a newer version: 34.0.0.Final

Show 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.util.List;
import java.io.Serializable;

/**
 * This interface specifies the methods a {@link Work Work} instance uses to
 * associate a List of {@link WorkContext WorkContext} instances to
 * be set when the Work instance gets executed by a
 * {@link WorkManager WorkManager}.
 * 
 * 
 * A Work instance could optionally implement this interface to
 * indicate to the WorkManager, that the WorkContexts
 * provided by this Work instance through the
 * {@link #getWorkContexts() getWorkContexts} method must be used while setting
 * the execution context of the Work instance.
 *
 * If the {@link #getWorkContexts() getWorkContexts} method returns an empty List
 * or null, the WorkManager must treat it as if no additional execution contexts
 * are associated with that Work instance.
 * 
 * 
 * @since 1.6
 */
public interface WorkContextProvider extends Serializable {

	/**
	 * Gets an list of WorkContexts that needs to be used by the
	 * WorkManager to set up the execution context while executing
	 * a Work instance.
     * 
	 * @return an List of WorkContext instances.
     * 
	 */
	List getWorkContexts();
}