001/* ServantLocatorPOA.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 gnu.CORBA.Poa.gnuServantObject;
042
043import org.omg.CORBA.NO_IMPLEMENT;
044import org.omg.CORBA.ORB;
045import org.omg.CORBA.SystemException;
046import org.omg.CORBA.portable.InputStream;
047import org.omg.CORBA.portable.InvokeHandler;
048import org.omg.CORBA.portable.OutputStream;
049import org.omg.CORBA.portable.ResponseHandler;
050import org.omg.PortableServer.ServantLocatorPackage.CookieHolder;
051
052/**
053 * <p>The ServantLocator stub is an optional base for the
054 * servant locators. It cannot serve remote invocations, as
055 * methods in {@link ServantLocatorOperations} take POA as one of parameters.
056 * Both JDK 1.5 API and OMG specifies that POA is a local object that must not
057 * be transferred to the remote invocation target.
058 * </p><p>
059 * You do not need to derive your servant locator from this stub,
060 * it is enough to implement the {@link ServantLocator} interface.
061 * But you may choose to do this if you need its functional
062 * {@link org.omg.PortableServer.ServantActivatorPOA.delegator#_ids()} 
063 * method or want to keep default behaviour during pre- or post- invokcations.
064 * </p>
065 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
066 */
067public abstract class ServantLocatorPOA
068  extends Servant
069  implements ServantLocatorOperations, InvokeHandler
070{
071  /**
072   * Used to access the outer class in the nested classes.
073   */
074  final ServantLocatorPOA THIS = this;
075
076  /**
077   * Our implementation will not call this method. After setting your
078   * manager to POA, it will call incarnate and etherialize directly.
079   */
080  public OutputStream _invoke(String method, InputStream input,
081                              ResponseHandler handler
082                             )
083                       throws SystemException
084  {
085    throw new NO_IMPLEMENT();
086  }
087
088  /**
089   * Returns an array of interfaces, supported by the servant locator.
090   */
091  public String[] _all_interfaces(POA poa, byte[] Object_Id)
092  {
093    return new _ServantLocatorStub()._ids();
094  }
095
096  /**
097   * Return the complete instance of the servant activator, based on
098   * the current class (ServantActivatorPOA or derived).
099   */
100  public ServantLocator _this()
101  {
102    return new delegator(this);
103  }
104
105  /**
106   * Return the complete instance of the servant activator, based on
107   * the current class (ServantActivatorPOA or derived).
108   */
109  public ServantLocator _this(ORB orb)
110  {
111    return new delegator(this);
112  }
113
114  /**
115   * This class is used to support _this.
116   */
117  class delegator
118    extends gnuServantObject
119    implements ServantLocator
120  {
121    delegator(Servant s)
122    {
123      super(s, new byte[ 0 ], null, null);
124    }
125
126    public Servant preinvoke(byte[] Object_Id, POA poa, String method,
127                             CookieHolder cookie_holder
128                            )
129                      throws org.omg.PortableServer.ForwardRequest
130    {
131      return THIS.preinvoke(Object_Id, poa, method, cookie_holder);
132    }
133
134    public void postinvoke(byte[] Object_Id, POA poa, String method,
135                           java.lang.Object cookie, Servant servant
136                          )
137    {
138      THIS.postinvoke(Object_Id, poa, method, cookie, servant);
139    }
140
141    public String[] _ids()
142    {
143      return THIS._all_interfaces(null, null);
144    }
145  }
146}