001    /* ServerIdHelper.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.PortableInterceptor;
040    
041    import gnu.CORBA.OrbRestricted;
042    
043    import org.omg.CORBA.Any;
044    import org.omg.CORBA.ORB;
045    import org.omg.CORBA.TypeCode;
046    import org.omg.CORBA.portable.InputStream;
047    import org.omg.CORBA.portable.OutputStream;
048    
049    /**
050     * The Server Id is defined in OMG specification just as a narrow (not wide)
051     * string. As such, the Server Id needs no helper, but one is included in
052     * the API anyway.
053     *
054     * @since 1.5
055     *
056     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
057     */
058    public abstract class ServerIdHelper
059    {
060      /**
061       * Insert the Server Id into Any (uses {@link Any#insert_string}).
062       *
063       * @param a the Any to insert into.
064       * @param that the string to insert.
065       */
066      public static void insert(Any a, String that)
067      {
068        a.insert_string(that);
069      }
070    
071      /**
072       * Extract the Server Id from Any ((uses {@link Any#extract_string}).
073       *
074       * @param a the Any to extract from.
075       */
076      public static String extract(Any a)
077      {
078        return a.extract_string();
079      }
080    
081      /**
082       * Return an alias typecode.
083       */
084      public static TypeCode type()
085      {
086        ORB orb = OrbRestricted.Singleton;
087        return orb.create_alias_tc(id(), "ServerId", orb.create_string_tc(0));
088      }
089    
090      /**
091       * Return the Server Id repository id.
092       * @return "IDL:omg.org/PortableInterceptor/ServerId:1.0", always.
093       */
094      public static String id()
095      {
096        return "IDL:omg.org/PortableInterceptor/ServerId:1.0";
097      }
098    
099      /**
100       * Calls {@link InputStream#read_string()}.
101       *
102       * @param input the stream to read from.
103       */
104      public static String read(InputStream input)
105      {
106        return input.read_string();
107      }
108    
109      /**
110       * Calls {@link OutputStream#write_string(String)}.
111       *
112       * @param output the stream to write into.
113       * @param value the string (Server Id) value to write.
114       */
115      public static void write(OutputStream output, String value)
116      {
117        output.write_string(value);
118      }
119    }