001/* NamingContextHelper.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.CosNaming;
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.TypeCode;
048import org.omg.CORBA.portable.Delegate;
049import org.omg.CORBA.portable.InputStream;
050import org.omg.CORBA.portable.ObjectImpl;
051import org.omg.CORBA.portable.OutputStream;
052
053/**
054 * The helper operations for the naming context.
055 *
056 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
057 */
058public abstract class NamingContextHelper
059{
060  /**
061   * The naming context repository id.
062   */
063  private static String _id = "IDL:omg.org/CosNaming/NamingContext:1.0";
064
065  /**
066   * Extract the naming context from the given {@link Any}.
067   */
068  public static NamingContext extract(Any a)
069  {
070    try
071      {
072        return ((NamingContextHolder) a.extract_Streamable()).value;
073      }
074    catch (ClassCastException ex)
075      {
076        BAD_OPERATION bad = new BAD_OPERATION("Naming context expected");
077        bad.initCause(ex);
078        bad.minor = Minor.Any;        
079        throw bad;
080      }
081  }
082
083  /**
084   * Get the {@link NamingContext} repository id.
085   */
086  public static String id()
087  {
088    return _id;
089  }
090
091  /**
092   * Insert the naming context into the given {@link Any}
093   */
094  public static void insert(Any a, NamingContext that)
095  {
096    a.insert_Streamable(new NamingContextHolder(that));
097  }
098
099  /**
100   * Cast the passed object into the NamingContext. If the
101   * object has a different java type, create an instance
102   * of the NamingContext, using the same delegate, as for
103   * the passed parameter.
104   *
105   * If the object repository Id indicates that it is an instance of
106   *  {@link NamingContextExt} that is a subclass of the NamingContext,
107   * the functionality is  delegated to {@link NamingContextHelper#narrow}.
108   *
109   * @param obj the object to cast.
110   * @return casted instance.
111   *
112   * @throws BAD_PARAM if the passed object is not an instance of
113   * {@link NamingContext} or {@link NamingContextExt}.
114   */
115  public static NamingContext narrow(org.omg.CORBA.Object obj)
116  {
117    if (obj == null)
118      return null;
119    else if (obj instanceof NamingContext)
120      return (NamingContext) obj;
121    else if (obj._is_a(id()))
122      {
123        Delegate delegate = ((ObjectImpl) obj)._get_delegate();
124        return new _NamingContextStub(delegate);
125      }
126    else if (obj._is_a(NamingContextExtHelper.id()))
127      return NamingContextExtHelper.narrow(obj);
128    else
129      throw new BAD_PARAM();
130  }
131  
132  /**
133   * Narrow the given object to the NamingContext. No type-checking is performed
134   * to verify that the object actually supports the requested type. The
135   * {@link BAD_OPERATION} will be thrown if unsupported operations are invoked
136   * on the new returned reference, but no failure is expected at the time of
137   * the unchecked_narrow. See OMG issue 4158.
138   * 
139   * @param obj the object to cast.
140   * 
141   * @return the casted NamingContext.
142   */
143  public static NamingContext unchecked_narrow(org.omg.CORBA.Object obj)
144  {
145    if (obj == null)
146      return null;
147    else if (obj instanceof NamingContext)
148      return (NamingContext) obj;
149    else
150      {
151        // Do not call the _is_a(..).
152        Delegate delegate = ((ObjectImpl) obj)._get_delegate();
153        return new _NamingContextStub(delegate);
154      }    
155  }  
156
157  /**
158   * Read the naming context from the given CDR input stream.
159   */
160  public static NamingContext read(InputStream istream)
161  {
162    return narrow(istream.read_Object(_NamingContextStub.class));
163  }
164
165  /**
166   * Get the type code of the {@link NamingContext}.
167   */
168  public static TypeCode type()
169  {
170    return OrbRestricted.Singleton.create_interface_tc(id(), "NamingContext");
171  }
172
173  /**
174   * Write the given naming context into the given CDR output stream.
175   */
176  public static void write(OutputStream ostream, NamingContext value)
177  {
178    ostream.write_Object(value);
179  }
180}