javax.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 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.Final

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;

/**
 * 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
 * @version Java EE Connector Architecture 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();
}