1 /* ReplyHeader.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.CDR.AbstractCdrInput; 42 import gnu.CORBA.CDR.AbstractCdrOutput; 43 44 /** 45 * The header of the standard reply. 46 * 47 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org) 48 */ 49 public abstract class ReplyHeader 50 extends ContextHandler 51 { 52 /** 53 * Reply status, if no exception occured. 54 */ 55 public static final int NO_EXCEPTION = 0; 56 57 /** 58 * Reply status, user exception. 59 */ 60 public static final int USER_EXCEPTION = 1; 61 62 /** 63 * Reply status, system exception. 64 */ 65 public static final int SYSTEM_EXCEPTION = 2; 66 67 /** 68 * Reply status, if the client ORB must re - send the request to another 69 * destination. The body contains IOR. 70 */ 71 public static final int LOCATION_FORWARD = 3; 72 73 /** 74 * Reply status, indicating that the target has permanently changed the 75 * address to the supplied IOR. 76 */ 77 public static final int LOCATION_FORWARD_PERM = 4; 78 79 /** 80 * Reply status, indicating, that the ORB requires to resend the object 81 * address in the required addressing mode, contained as the reply body. 82 */ 83 public static final int NEEDS_ADDRESSING_MODE = 5; 84 85 /** 86 * The status of this reply, holds one of the reply status constants. 87 */ 88 public int reply_status; 89 90 /** 91 * The Id of request into response of which this reply has been sent. 92 */ 93 public int request_id; 94 95 /** 96 * Return the message status as a string. 97 */ getStatusString()98 public String getStatusString() 99 { 100 switch (reply_status) 101 { 102 case NO_EXCEPTION: 103 return "ok"; 104 105 case USER_EXCEPTION: 106 return "user exception"; 107 108 case SYSTEM_EXCEPTION: 109 return "system exception"; 110 111 case LOCATION_FORWARD: 112 return "moved"; 113 114 default: 115 return null; 116 } 117 } 118 119 /** 120 * Reads the header from the stream. 121 * 122 * @param in a stream to read from. 123 */ read(AbstractCdrInput in)124 public abstract void read(AbstractCdrInput in); 125 126 /** 127 * Returns a short string representation. 128 * 129 * @return a string representation. 130 */ toString()131 public String toString() 132 { 133 String status = getStatusString(); 134 if (status == null) 135 status = "status " + reply_status; 136 return request_id + ", " + status; 137 } 138 139 /** 140 * Writes the header to the stream. 141 * 142 * @param out a stream to write into. 143 */ write(AbstractCdrOutput out)144 public abstract void write(AbstractCdrOutput out); 145 } 146