001    /* _ServantActivatorStub.java --
002       Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.PortableServer;
040    
041    import java.io.Serializable;
042    
043    import org.omg.CORBA.portable.ObjectImpl;
044    
045    /**
046     * <p>This ServantActivator stub is an optional base for the
047     * servant activators. This stub cannot accept remote invocations, as
048     * methods in {@link ServantActivatorOperations} take POA as one of parameters.
049     * Both JDK 1.5 API and OMG specifies that POA is a local object that must not
050     * be transferred to the remote invocation target.
051     * </p><p>
052     * You do not need to derive your servant activator from this stub,
053     * it is enough to implement the {@link ServantActivator} interface.
054     * But you may choose to do this if you need the functional
055     * {@link #_ids()} method or want to keep default behavior during
056     * the incarnation or etherialization.
057     * </p>
058     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
059     */
060    public class _ServantActivatorStub
061      extends ObjectImpl
062      implements ServantActivator, Serializable
063    {
064      /**
065       * Use serialVersionUID (v1.4) for interoperability.
066       */
067      private static final long serialVersionUID = -685959979577281419L;
068    
069      /**
070       * This the purpose of this field is undocumented up till 1.5 java API
071       * inclusive.
072       */
073      public static final Class _opsClass = ServantActivatorOperations.class;
074    
075      /**
076       * Return the array of repository ids for this object.
077       *
078       * @return { "IDL:omg.org/PortableServer/ServantActivator:2.3",
079       *           "IDL:omg.org/PortableServer/ServantManager:1.0" }, always.
080       */
081      public String[] _ids()
082      {
083        return new String[]
084               {
085                 "IDL:omg.org/PortableServer/ServantActivator:2.3",
086                 "IDL:omg.org/PortableServer/ServantManager:1.0"
087               };
088      }
089    
090      /**
091       * It is your responsibility to handle the incarnation event and
092       * supply the servant. Override this method if using the class.
093       * The default method instructs POA that the servant cannot be
094       * provided by activator. The OBJ_ADAPTER exception will be
095       * thrown by POA, unless the servant is provided as one of the
096       * parameters in the activation method.
097       *
098       * @see ServantActivatorOperations#incarnate
099       *
100       * @specnote in GNU Classpath, returning null means that the
101       * activator does not supply the servant.
102       *
103       * @throws ForwardRequest
104       */
105      public Servant incarnate(byte[] Object_id, POA poa)
106                        throws ForwardRequest
107      {
108        return null;
109      }
110    
111      /**
112       * It is your responsibility to handle the etherialization event.
113       * Override this method if using the class. The default method
114       * does nothing.
115       *
116       * @see ServantActivatorOperations#incarnate
117       */
118      public void etherealize(byte[] Object_id, POA poa, Servant servant,
119                              boolean cleanup, boolean remaining
120                             )
121      {
122      }
123    }