001/* _ServantActivatorStub.java --
002   Copyright (C) 2005, 2006 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.PortableServer;
040
041import java.io.Serializable;
042
043import 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 */
060public 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  @SuppressWarnings("unchecked") // Needed for API compatibility
074  public static final Class _opsClass = ServantActivatorOperations.class;
075
076  /**
077   * Return the array of repository ids for this object.
078   *
079   * @return { "IDL:omg.org/PortableServer/ServantActivator:2.3",
080   *           "IDL:omg.org/PortableServer/ServantManager:1.0" }, always.
081   */
082  public String[] _ids()
083  {
084    return new String[]
085           {
086             "IDL:omg.org/PortableServer/ServantActivator:2.3",
087             "IDL:omg.org/PortableServer/ServantManager:1.0"
088           };
089  }
090
091  /**
092   * It is your responsibility to handle the incarnation event and
093   * supply the servant. Override this method if using the class.
094   * The default method instructs POA that the servant cannot be
095   * provided by activator. The OBJ_ADAPTER exception will be
096   * thrown by POA, unless the servant is provided as one of the
097   * parameters in the activation method.
098   *
099   * @see ServantActivatorOperations#incarnate
100   *
101   * @specnote in GNU Classpath, returning null means that the
102   * activator does not supply the servant.
103   *
104   * @throws ForwardRequest
105   */
106  public Servant incarnate(byte[] Object_id, POA poa)
107                    throws ForwardRequest
108  {
109    return null;
110  }
111
112  /**
113   * It is your responsibility to handle the etherialization event.
114   * Override this method if using the class. The default method
115   * does nothing.
116   *
117   * @see ServantActivatorOperations#incarnate
118   */
119  public void etherealize(byte[] Object_id, POA poa, Servant servant,
120                          boolean cleanup, boolean remaining
121                         )
122  {
123  }
124}