/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * particular file as subject to the "Classpath" exception as provided

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 */

package com.sun.corba.se.impl.protocol.giopmsgheaders;

import org.omg.CORBA.INTERNAL;

import org.omg.CORBA.CompletionStatus;

import org.omg.CORBA.SystemException;

import com.sun.corba.se.spi.ior.IOR;

import com.sun.corba.se.spi.ior.IORFactories;

import com.sun.corba.se.spi.orb.ORB;

import com.sun.corba.se.spi.ior.iiop.GIOPVersion;

import com.sun.corba.se.impl.encoding.CDRInputStream;

import com.sun.corba.se.spi.logging.CORBALogDomains ;

import com.sun.corba.se.impl.logging.ORBUtilSystemException ;

/**

 * This implements the GIOP 1.1 LocateReply header.

 *

 * @author Ram Jeyaraman 05/14/2000

 */

public final class LocateReplyMessage_1_1 extends Message_1_1

        implements LocateReplyMessage {

    // Instance variables

    private ORB orb = null;

    private int request_id = (int) 0;

    private int reply_status = (int) 0;

    private IOR ior = null;

    // Constructors

    LocateReplyMessage_1_1(ORB orb) {

        this.orb = orb;

    }

    LocateReplyMessage_1_1(ORB orb, int _request_id,

            int _reply_status, IOR _ior) {

        super(Message.GIOPBigMagic, GIOPVersion.V1_1, FLAG_NO_FRAG_BIG_ENDIAN,

            Message.GIOPLocateReply, 0);

        this.orb = orb;

        request_id = _request_id;

        reply_status = _reply_status;

        ior = _ior;

    }

    // Accessor methods

    public int getRequestId() {

        return this.request_id;

    }

    public int getReplyStatus() {

        return this.reply_status;

    }

    public short getAddrDisposition() {

        return KeyAddr.value;

    }

    public SystemException getSystemException(String message) {

        return null; // 1.0 LocateReply body does not contain SystemException

    }

    public IOR getIOR() {

        return this.ior;

    }

    // IO methods

    public void read(org.omg.CORBA.portable.InputStream istream) {

        super.read(istream);

        this.request_id = istream.read_ulong();

        this.reply_status = istream.read_long();

        isValidReplyStatus(this.reply_status); // raises exception on error

        // The code below reads the reply body if status is OBJECT_FORWARD

        if (this.reply_status == OBJECT_FORWARD) {

            CDRInputStream cdr = (CDRInputStream) istream;

            this.ior = IORFactories.makeIOR( cdr ) ;

        }

    }

    // Note, this writes only the header information. SystemException or

    // IOR may be written afterwards into the reply mesg body.

    public void write(org.omg.CORBA.portable.OutputStream ostream) {

        super.write(ostream);

        ostream.write_ulong(this.request_id);

        ostream.write_long(this.reply_status);

    }

    // Static methods

    public static void isValidReplyStatus(int replyStatus) {

        switch (replyStatus) {

        case UNKNOWN_OBJECT :

        case OBJECT_HERE :

        case OBJECT_FORWARD :

            break;

        default :

            ORBUtilSystemException localWrapper = ORBUtilSystemException.get(

                CORBALogDomains.RPC_PROTOCOL ) ;

            throw localWrapper.illegalReplyStatus( CompletionStatus.COMPLETED_MAYBE);

        }

    }

    public void callback(MessageHandler handler)

        throws java.io.IOException

    {

        handler.handleInput(this);

    }

} // class LocateReplyMessage_1_1