Source for org.omg.PortableInterceptor.CurrentOperations

   1: /* CurrentOperations.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package org.omg.PortableInterceptor;
  40: 
  41: import org.omg.CORBA.Any;
  42: import org.omg.CORBA.BAD_INV_ORDER;
  43: 
  44: /**
  45:  * Defines the operations, applicable to the portable interceptor Current.
  46:  *
  47:  * Portable Interceptors Current (also known as PICurrent) is a slot table. Each
  48:  * slot has an integer identifier, can hold a CORBA {@link Any} and is used by
  49:  * some service to transfer data between thread and request contexts. Each
  50:  * service which wishes to use PICurrent reserves a slot or slots at
  51:  * initialization time and uses those slots during the processing of requests
  52:  * and replies.
  53:  *
  54:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  55:  */
  56: public interface CurrentOperations
  57:   extends org.omg.CORBA.CurrentOperations
  58: {
  59:   /**
  60:    * Get data from the slot with the given slot_id.
  61:    *
  62:    * @param slot_id the slot slot_id.
  63:    *
  64:    * @return the Any that was stored in the slot. If the given slot has not been
  65:    * set, the returned Any contains a type code with a TCKind value of tk_null
  66:    * and has no value.
  67:    *
  68:    * @throws InvalidSlot for the unknown slot.
  69:    * @throws BAD_INV_ORDER minor 10 if called from the {@link ORBInitializer}
  70:    * methods.
  71:    */
  72:   Any get_slot(int slot_id) throws InvalidSlot, BAD_INV_ORDER;
  73: 
  74:   /**
  75:    * Sets data for the slot with the given slot_id.
  76:    *
  77:    * @param slot_id the slot slot_id.
  78:    *
  79:    * @param data the Any that will be stored into the slot.
  80:    *
  81:    * @throws InvalidSlot for the unknown slot.
  82:    * @throws BAD_INV_ORDER minor 10 if called from the {@link ORBInitializer}
  83:    * methods.
  84:    *
  85:    */
  86:   void set_slot(int slot_id, Any data) throws InvalidSlot, BAD_INV_ORDER;
  87: }