Source for org.omg.CosNaming.NamingContextHelper

   1: /* NamingContextHelper.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package org.omg.CosNaming;
  40: 
  41: import gnu.CORBA.Minor;
  42: 
  43: import org.omg.CORBA.Any;
  44: import org.omg.CORBA.BAD_OPERATION;
  45: import org.omg.CORBA.BAD_PARAM;
  46: import org.omg.CORBA.ORB;
  47: import org.omg.CORBA.TypeCode;
  48: import org.omg.CORBA.portable.Delegate;
  49: import org.omg.CORBA.portable.InputStream;
  50: import org.omg.CORBA.portable.ObjectImpl;
  51: import org.omg.CORBA.portable.OutputStream;
  52: 
  53: /**
  54:  * The helper operations for the naming context.
  55:  *
  56:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  57:  */
  58: public abstract class NamingContextHelper
  59: {
  60:   /**
  61:    * The naming context repository id.
  62:    */
  63:   private static String _id = "IDL:omg.org/CosNaming/NamingContext:1.0";
  64: 
  65:   /**
  66:    * The cached {@link NamingContext} typecode.
  67:    */
  68:   private static TypeCode typeCode;
  69: 
  70:   /**
  71:    * Extract the naming context from the given {@link Any}.
  72:    */
  73:   public static NamingContext extract(Any a)
  74:   {
  75:     try
  76:       {
  77:         return ((NamingContextHolder) a.extract_Streamable()).value;
  78:       }
  79:     catch (ClassCastException ex)
  80:       {
  81:         BAD_OPERATION bad = new BAD_OPERATION("Naming context expected");
  82:         bad.initCause(ex);
  83:         bad.minor = Minor.Any;        
  84:         throw bad;
  85:       }
  86:   }
  87: 
  88:   /**
  89:    * Get the {@link NamingContext} repository id.
  90:    */
  91:   public static String id()
  92:   {
  93:     return _id;
  94:   }
  95: 
  96:   /**
  97:    * Insert the naming context into the given {@link Any}
  98:    */
  99:   public static void insert(Any a, NamingContext that)
 100:   {
 101:     a.insert_Streamable(new NamingContextHolder(that));
 102:   }
 103: 
 104:   /**
 105:    * Cast the passed object into the NamingContext. If the
 106:    * object has a different java type, create an instance
 107:    * of the NamingContext, using the same delegate, as for
 108:    * the passed parameter.
 109:    *
 110:    * If the object repository Id indicates that it is an instance of
 111:    *  {@link NamingContextExt} that is a subclass of the NamingContext,
 112:    * the functionality is  delegated to {@link NamingContextHelper#narrow}.
 113:    *
 114:    * @param obj the object to cast.
 115:    * @return casted instance.
 116:    *
 117:    * @throws BAD_PARAM if the passed object is not an instance of
 118:    * {@link NamingContext} or {@link NamingContextExt}.
 119:    */
 120:   public static NamingContext narrow(org.omg.CORBA.Object obj)
 121:   {
 122:     if (obj == null)
 123:       return null;
 124:     else if (obj instanceof NamingContext)
 125:       return (NamingContext) obj;
 126:     else if (obj._is_a(id()))
 127:       {
 128:         Delegate delegate = ((ObjectImpl) obj)._get_delegate();
 129:         return new _NamingContextStub(delegate);
 130:       }
 131:     else if (obj._is_a(NamingContextExtHelper.id()))
 132:       return NamingContextExtHelper.narrow(obj);
 133:     else
 134:       throw new BAD_PARAM();
 135:   }
 136:   
 137:   /**
 138:    * Narrow the given object to the NamingContext. No type-checking is performed
 139:    * to verify that the object actually supports the requested type. The
 140:    * {@link BAD_OPERATION} will be thrown if unsupported operations are invoked
 141:    * on the new returned reference, but no failure is expected at the time of
 142:    * the unchecked_narrow.
 143:    * 
 144:    * @param obj the object to cast.
 145:    * 
 146:    * @return the casted NamingContext.
 147:    * 
 148:    * @since 1.5 
 149:    * 
 150:    * @see OMG issue 4158.
 151:    */
 152:   public static NamingContext unchecked_narrow(org.omg.CORBA.Object obj)
 153:   {
 154:     if (obj == null)
 155:       return null;
 156:     else if (obj instanceof NamingContext)
 157:       return (NamingContext) obj;
 158:     else
 159:       {
 160:         // Do not call the _is_a(..).
 161:         Delegate delegate = ((ObjectImpl) obj)._get_delegate();
 162:         return new _NamingContextStub(delegate);
 163:       }    
 164:   }  
 165: 
 166:   /**
 167:    * Read the naming context from the given CDR input stream.
 168:    */
 169:   public static NamingContext read(InputStream istream)
 170:   {
 171:     return narrow(istream.read_Object(_NamingContextStub.class));
 172:   }
 173: 
 174:   /**
 175:    * Get the type code of the {@link NamingContext}.
 176:    */
 177:   public static TypeCode type()
 178:   {
 179:     if (typeCode == null)
 180:       typeCode = ORB.init().create_interface_tc(id(), "NamingContext");
 181:     return typeCode;
 182:   }
 183: 
 184:   /**
 185:    * Write the given naming context into the given CDR output stream.
 186:    */
 187:   public static void write(OutputStream ostream, NamingContext value)
 188:   {
 189:     ostream.write_Object(value);
 190:   }
 191: }