Source for gnu.CORBA.GIOP.CloseMessage

   1: /* CloseMessage.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 gnu.CORBA.GIOP;
  40: 
  41: import gnu.CORBA.Minor;
  42: 
  43: import org.omg.CORBA.MARSHAL;
  44: 
  45: import java.io.IOException;
  46: import java.io.OutputStream;
  47: 
  48: /**
  49:  * The explicit command to close the connection.
  50:  *
  51:  *
  52:  * The close message consists from the message header only and
  53:  * is the same for GIOP 1.0, 1.1, 1.2 and 1.3. The CloseMessage
  54:  * uses the default value from the {@link MessageHeader}.
  55:  *
  56:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  57:  */
  58: public class CloseMessage
  59:   extends MessageHeader
  60: {
  61:   /**
  62:    * Use serialVersionUID for interoperability.
  63:    */
  64:   private static final long serialVersionUID = 1;
  65: 
  66:   /**
  67:    * The singleton close message is typically enough, despite new
  68:    * instances may be instantiated if the specific version field
  69:    * value is mandatory.
  70:    */
  71:   private static final CloseMessage Singleton = new CloseMessage();
  72: 
  73:   /**
  74:    * Create a new error message, setting the message field
  75:    * to the {@link MESSAGE_CLOSE} and the version number to
  76:    * the given major and minor values.
  77:    */
  78:   public CloseMessage()
  79:   {
  80:     message_type = CLOSE_CONNECTION;
  81:   }
  82: 
  83:   /**
  84:    * Send the close message to the given output stream. The method,
  85:    * however, does not close the socket itself, this must be done
  86:    * explicitly in the calling code.
  87:    *
  88:    * @param socketStream a stream, where the close message is
  89:    * written.
  90:    */
  91:   public static void close(OutputStream socketStream)
  92:   {
  93:     try
  94:       {
  95:         Singleton.write(socketStream);
  96:         socketStream.flush();
  97:       }
  98:     catch (IOException ex)
  99:       {
 100:         MARSHAL m = new MARSHAL("Unable to flush the stream");
 101:         m.minor = Minor.Header;
 102:         m.initCause(ex);
 103:         throw m;
 104:       }
 105:   }
 106: }