001    /* POAHelper.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 gnu.CORBA.Minor;
042    import gnu.CORBA.OrbRestricted;
043    
044    import org.omg.CORBA.BAD_OPERATION;
045    import org.omg.CORBA.BAD_PARAM;
046    import org.omg.CORBA.TypeCode;
047    import org.omg.CORBA.Any;
048    import org.omg.CORBA.portable.InputStream;
049    import org.omg.CORBA.MARSHAL;
050    import org.omg.CORBA.portable.OutputStream;
051    
052    /**
053     * The helper operations for the CORBA object {@link POA}.
054     *
055     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
056     */
057    public abstract class POAHelper
058    {
059      /**
060       * Cast the passed object into the POA. As POA is a local object, the method
061       * just uses java type cast.
062       *
063       * @param obj the object to narrow.
064       * @return narrowed instance.
065       * @throws BAD_PARAM if the passed object is not a POA.
066       */
067      public static POA narrow(org.omg.CORBA.Object obj)
068      {
069        try
070          {
071            return (POA) obj;
072          }
073        catch (ClassCastException cex)
074          {
075            throw new BAD_PARAM(obj.getClass().getName() + " is not a POA");
076          }
077      }
078    
079      /**
080       * Get the type code of the {@link POA}.
081       */
082      public static TypeCode type()
083      {
084        return OrbRestricted.Singleton.create_interface_tc(id(), "POA");
085      }
086    
087      /**
088       * Insert the POA into the given Any.
089       *
090       * @param any the Any to insert into.
091       *
092       * @param that the POA to insert.
093       */
094      public static void insert(Any any, POA that)
095      {
096        any.insert_Object(that);
097      }
098    
099      /**
100       * Extract the POA from given Any.
101       *
102       * @throws BAD_OPERATION if the passed Any does not contain POA.
103       */
104      public static POA extract(Any any)
105      {
106        return narrow(any.extract_Object());
107      }
108    
109      /**
110       * Get the POA repository id.
111       *
112       * @return "IDL:omg.org/PortableServer/POA:2.3", always.
113       */
114      public static String id()
115      {
116        return "IDL:omg.org/PortableServer/POA:2.3";
117      }
118    
119      /**
120       * This should read POA from the CDR input stream, but, following the specs,
121       * it doesnot. The jdk 1.5 API specification defines that POA cannot be
122       * exported.
123       *
124       * @param input a org.omg.CORBA.portable stream to read from.
125       *
126       * @specenote Sun throws the same exception.
127       *
128       * @throws MARSHAL, always.
129       */
130      public static POA read(InputStream input)
131      {
132        MARSHAL m = new MARSHAL("Inappropriate");
133        m.minor = Minor.Inappropriate;
134        throw m;
135      }
136    
137      /**
138       * This should read POA from the CDR input stream, but, following the specs,
139       * it doesnot. The jdk 1.5 API specification defines that POA cannot be
140       * exported.
141       *
142       * @param output a org.omg.CORBA.portable stream to write into.
143       *
144       * @specenote Sun throws the same exception.
145       *
146       * @throws MARSHAL, always.
147       */
148      public static void write(OutputStream output, POA value)
149      {
150        MARSHAL m = new MARSHAL("Inappropriate");
151        m.minor = Minor.Inappropriate;
152        throw m;
153      }
154    }