001/* CurrentOperations.java --
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.PortableInterceptor;
040
041import org.omg.CORBA.Any;
042import org.omg.CORBA.BAD_INV_ORDER;
043
044/**
045 * Defines the operations, applicable to the portable interceptor Current.
046 *
047 * Portable Interceptors Current (also known as PICurrent) is a slot table. Each
048 * slot has an integer identifier, can hold a CORBA {@link Any} and is used by
049 * some service to transfer data between thread and request contexts. Each
050 * service which wishes to use PICurrent reserves a slot or slots at
051 * initialization time and uses those slots during the processing of requests
052 * and replies.
053 *
054 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
055 */
056public interface CurrentOperations
057  extends org.omg.CORBA.CurrentOperations
058{
059  /**
060   * Get data from the slot with the given slot_id.
061   *
062   * @param slot_id the slot slot_id.
063   *
064   * @return the Any that was stored in the slot. If the given slot has not been
065   * set, the returned Any contains a type code with a TCKind value of tk_null
066   * and has no value.
067   *
068   * @throws InvalidSlot for the unknown slot.
069   * @throws BAD_INV_ORDER minor 10 if called from the {@link ORBInitializer}
070   * methods.
071   */
072  Any get_slot(int slot_id) throws InvalidSlot, BAD_INV_ORDER;
073
074  /**
075   * Sets data for the slot with the given slot_id.
076   *
077   * @param slot_id the slot slot_id.
078   *
079   * @param data the Any that will be stored into the slot.
080   *
081   * @throws InvalidSlot for the unknown slot.
082   * @throws BAD_INV_ORDER minor 10 if called from the {@link ORBInitializer}
083   * methods.
084   *
085   */
086  void set_slot(int slot_id, Any data) throws InvalidSlot, BAD_INV_ORDER;
087}