001/* ServantLocatorHelper.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.Minor;
042import gnu.CORBA.OrbRestricted;
043
044import org.omg.CORBA.Any;
045import org.omg.CORBA.BAD_OPERATION;
046import org.omg.CORBA.BAD_PARAM;
047import org.omg.CORBA.MARSHAL;
048import org.omg.CORBA.TypeCode;
049import org.omg.CORBA.portable.InputStream;
050import org.omg.CORBA.portable.OutputStream;
051
052/**
053* The helper operations for the CORBA object {@link ServantLocator}.
054*
055* @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
056*/
057public abstract class ServantLocatorHelper
058{
059  /**
060   * Get the type code of the {@link ServantLocator}.
061   */
062  public static TypeCode type()
063  {
064    return OrbRestricted.Singleton.create_interface_tc(id(), "ServantLocator");
065  }
066
067  /**
068   * Insert the ServantLocator into the given Any.
069   *
070   * @param any the Any to insert into.
071   * @param that the ServantLocator to insert.
072   */
073  public static void insert(Any any, ServantLocator that)
074  {
075    any.insert_Object(that);
076  }
077
078  /**
079   * Extract the ServantLocator from given Any.
080   *
081   * @throws BAD_OPERATION if the passed Any does not contain ServantLocator.
082   */
083  public static ServantLocator extract(Any any)
084  {
085    return narrow(any.extract_Object());
086  }
087
088  /**
089   * Get the ServantLocator repository id.
090   *
091   * @return "org.omg.PortableServer.ServantLocatorOperations", always.
092   */
093  public static String id()
094  {
095    return "org.omg.PortableServer.ServantLocatorOperations";
096  }
097
098  /**
099   * Cast the passed object into the ServantLocator.
100   *
101   * @param obj the object to narrow.
102   * @return narrowed instance.
103   * @throws BAD_PARAM if the passed object is not a ServantLocator.
104   */
105  public static ServantLocator narrow(org.omg.CORBA.Object obj)
106  {
107    try
108      {
109        return (ServantLocator) obj;
110      }
111    catch (ClassCastException ex)
112      {
113        BAD_OPERATION bad = new BAD_OPERATION();
114        bad.minor = Minor.ClassCast;
115        bad.initCause(ex);
116        throw bad;
117      }
118  }
119
120  /**
121   * Narrow the given object to the ServantLocator. For the objects that are
122   * always local, this operation does not differ from the ordinary
123   * {@link #narrow} (ClassCastException will be thrown if narrowing something
124   * different). See OMG issue 4158.
125   *
126   * @param obj the object to cast.
127   *
128   * @return the casted ServantLocator.
129   *
130   * @since 1.5
131   */
132  public static ServantLocator unchecked_narrow(org.omg.CORBA.Object obj)
133  {
134    return narrow(obj);
135  }
136
137  /**
138   * This should read the servant locator, but it cannot be transferred
139   * this way as its operations cannot be remote. The operations cannot
140   * be remote because one of the method parameters, POA, is required to be
141   * always a local object (both by 1.5 API and 3.0.3 OMG).
142   *
143   * @throws MARSHAL, always.
144   *
145   * @specnote Same as Sun.
146   */
147  public static ServantLocator read(InputStream input)
148  {
149    MARSHAL m = new MARSHAL("Inappropriate");
150    m.minor = Minor.Inappropriate;
151    throw m;
152  }
153
154  /**
155   * This should write the servant activator, but it cannot be transferred
156   * this way as its operations cannot be remote. The operations cannot
157   * be remote because one of the method parameters, POA, is required to be
158   * always a local object (both by 1.5 API and 3.0.3 OMG).
159   *
160   * @throws MARSHAL, always.
161   *
162   * @specnote Same as Sun.
163   */
164  public static void write(OutputStream output, ServantLocator value)
165  {
166    MARSHAL m = new MARSHAL("Inappropriate");
167    m.minor = Minor.Inappropriate;
168    throw m;
169  }
170}