javax.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 Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging 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: 35.0.0.Beta1

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2008-2009, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package javax.resource.spi.work;

import java.io.Serializable;
import java.util.List;

/**
 * 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
 * @version Java EE Connector Architecture 1.6
 */
public interface WorkContextProvider extends Serializable
{
   /**
    * Gets an instance 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();
}