001/* InterceptorOperations.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
041
042/**
043 * Defines operations, applicable for all types of {@link Interceptor}.
044 * The the derived interfaces define additional operations for they
045 * specific functionality.
046 *
047 * Portable Interceptors are hooks into the ORB through which ORB services can
048 * intercept the normal flow of execution in creation of IOR, sending request,
049 * receiving request and returning the reply.
050 *
051 * See {@link org.omg.PortableInterceptor} for more details about the possible
052 * interceptors and how to register them within the ORB.
053 *
054 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
055 */
056public interface InterceptorOperations
057{
058  /**
059   * This method is called when orb is being destroyed and destroys
060   * the interceptor. The ORB calls this method after completing all
061   * incoming requests. The method body should not invoke methods on other
062   * object, belonging to ORB being destoryed, as in this stage it is no
063   * longer capable to act as server. It is still, however, capable
064   * to act as a client, permitting remote invocations on other objects.
065   */
066  void destroy();
067
068  /**
069   * All interceptors of the same type, registered on the single ORB, must
070   * either have different names or be anonymous. The name of the anonymous
071   * interceptor is an empty string. The ORB supports multiple anonymous
072   * interceptors of the same type.
073   *
074   * @return the name of the interceptor.
075   */
076  String name();
077}