NextValuesResponse.java

/*
 * (C) Copyright IBM Corp. 2010
 *
 * LICENSE: Eclipse Public License v1.0
 * http://www.eclipse.org/legal/epl-v10.html
 */


package com.ibm.gaiandb.udpdriver.common.protocol;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.net.InetAddress;

/**
 * NextValuesResponse protocol message.
 * 
 * The binary format is :
 * |messageHeader|responseWithValuesBinaryFormat|
 * 
 * @author lengelle
 *
 */
public class NextValuesResponse extends ResponseWithValues
{
    
	//	Use PROPRIETARY notice if class contains a main() method, otherwise use COPYRIGHT notice.
	public static final String COPYRIGHT_NOTICE = "(c) Copyright IBM Corp. 2010";
	
	/**
	 * Creates a new NextValuesResponse
	 */
	protected NextValuesResponse()
	{
		super();
	}
	
    /* (non-Javadoc)
     * @see com.ibm.gaiandb.udpdriver.common.protocol.ResponseWithValues#initializeWithData(byte[], java.net.InetAddress, int)
     */
    public void initializeWithData( byte[] data, InetAddress emittingAdress, int emittingPort ) throws UDPProtocolException
    {
    	super.initializeWithData( data, emittingAdress, emittingPort );
    	
        try
        {
        	deserializeData();
        }
        catch( Exception e )
        {
        	throw new UDPProtocolException( "NextValuesResponse - constructor failed.", e );
        }
    }
	
	
	/* (non-Javadoc)
	 * @see com.ibm.gaiandb.udpdriver.common.protocol.ResponseWithValues#clean()
	 */
	public void clean()
	{
		super.clean();
	}
    
    
    /* (non-Javadoc)
     * @see com.ibm.gaiandb.udpdriver.common.protocol.Message#getType()
     */
    public int getType()
    {
        return Message.NEXT_VALUES_RESPONSE;
    }
    
    
    /* (non-Javadoc)
     * @see com.ibm.gaiandb.udpdriver.common.protocol.Message#deserializeData()
     */
    protected void deserializeData() throws UDPProtocolException
    {
    	try
    	{
        	ByteArrayInputStream bais = new ByteArrayInputStream( binaryData );
        	DataInputStream dis = new DataInputStream( bais );
        	
        	dis.readByte(); // the message type
        	queryID = dis.readUTF();
        	sequenceNumber = dis.readInt();
        	
        	deserializedValuesHelper( dis );
        	
        	dis.close();
        	bais.close();
    	}
    	catch( Exception e )
    	{
    		throw new UDPProtocolException( "NextValuesResponse deserializeData() failed. ", e );
    	}
    }
    
    
    /* (non-Javadoc)
     * @see com.ibm.gaiandb.udpdriver.common.protocol.Message#serializeMessage()
     */
    public byte[] serializeMessage() throws UDPProtocolException
    {
    	try
    	{
        	ByteArrayOutputStream baos = new ByteArrayOutputStream( BYTE_ARRAY_INITIAL_SIZE );
        	DataOutputStream daos = new DataOutputStream( baos );
        	
        	if ( queryID==null || sequenceNumber==-1 )
        	{
        		throw new UDPProtocolException( "The fields 'queryID' or 'sequenceNumber' are not initialized. " );
        	}
        	
        	daos.writeByte( getType() );
        	daos.writeUTF( queryID );
        	daos.writeInt( sequenceNumber );
        	
        	serializeValuesHelper( daos );
        	
        	daos.close();
        	byte[] serialized = baos.toByteArray();
        	baos.close();
        	
        	return serialized;
    	}
    	catch( Exception e )
    	{
    		throw new UDPProtocolException( "NextValuesResponse - serializeMessage() failed. ", e );
    	}
    }
    
    
    /* (non-Javadoc)
     * @see com.ibm.gaiandb.udpdriver.common.protocol.ResponseWithValues#estimateHeaderSize()
     */
    public int estimateHeaderSize() throws UDPProtocolException
    {
    	// Type(Byte)|QueryID|SequenceNumber|ResponseWithValuesHeader
    	return 1+queryID.length()+4+estimateHeaderSizeHelper();
    }

}