timestamprequest.java

This a java ICMP JNI interface

//
// This file is part of the OpenNMS(R) Application.
//
// OpenNMS(R) is Copyright (C) 2002-2003 The OpenNMS Group, Inc.  All rights reserved.
// OpenNMS(R) is a derivative work, containing both original code, included code and modified
// code that was published under the GNU General Public License. Copyrights for modified 
// and included code are below.
//
// OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
//
// Modifications:
//
// 2003 Mar 05: Changes to support response times and more platforms.
//
// Original code base Copyright (C) 1999-2001 Oculan Corp.  All rights reserved.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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 for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// For more information contact:
//      OpenNMS Licensing       <[e-mail]>
//      http://www.opennms.org/
//      http://www.opennms.com/
//
// Tab Size = 8
//

package org.opennms.protocols.icmp;

import java.util.Date;

import org.opennms.protocols.ip.OC16ChecksumProducer;

/**
 * This is the implementation of an ICMP timestamp reqeust object. The object
 * can be stored in a buffer to send or loaded from a received buffer. The class
 * is marked final since it is not intended to be extended.
 * 
 * @version 0.1
 * @author Brian Weaver <[e-mail]>
 * 
 */
public final class TimestampRequest extends ICMPHeader {
    private int m_origStamp;

    /**
     * Creates a new ICMP Timestamp Request object.
     * 
     */
    public TimestampRequest() {
        super(ICMPHeader.TYPE_TIMESTAMP_REQUEST, (byte) 0);
        m_origStamp = (int) ((new Date()).getTime() & 0xffffffff);
    }

    /**
     * Creates a new ICMP timestamp request from the spcified data at the
     * specific offset.
     * 
     * @param buf
     *            The buffer containing the data.
     * @param offset
     *            The start of the icmp data.
     * 
     * @exception java.lang.IndexOutOfBoundsException
     *                Thrown if there is not sufficent data in the buffer.
     * @exception java.lang.IllegalArgumentException
     *                Thrown if the ICMP type is not an Timestamp Request.
     */
    public TimestampRequest(byte[] buf, int offset) {
        super();
        loadFromBuffer(buf, offset);
    }

    /**
     * Computes the ones compliment 16-bit checksum for the ICMP message.
     * 
     */
    public final void computeChecksum() {
        OC16ChecksumProducer summer = new OC16ChecksumProducer();
        super.computeChecksum(summer);

        summer.add(m_origStamp);
        summer.add((int) 0);
        summer.add((int) 0);
        setChecksum(summer.getChecksum());
    }

    /**
     * Writes the ICMP address mask request out to the specified buffer at the
     * starting offset. If the buffer does not have sufficent data to store the
     * information then an IndexOutOfBoundsException is thrown.
     * 
     * @param buf
     *            The storage buffer.
     * @param offset
     *            The location to start in buf.
     * 
     * @return The new offset after storing to the buffer.
     * 
     * @exception java.lang.IndexOutOfBoundsException
     *                Thrown if the buffer does not have enough storage space.
     * 
     */
    public final int storeToBuffer(byte[] buf, int offset) {
        if (buf.length < (offset + 20))
            throw new IndexOutOfBoundsException("Array index overflow in buffer build");

        computeChecksum();
        offset = super.storeToBuffer(buf, offset);

        //
        // store the current timestamp
        //
        buf[offset++] = (byte) ((m_origStamp >> 24) & 0xff);
        buf[offset++] = (byte) ((m_origStamp >> 16) & 0xff);
        buf[offset++] = (byte) ((m_origStamp >> 8) & 0xff);
        buf[offset++] = (byte) (m_origStamp & 0xff);

        //
        // add in the 32-bit zero mask
        //
        for (int x = 0; x < 8; x++)
            buf[offset++] = 0;

        return offset;
    }

    /**
     * Reads the ICMP Address Mask Reqeust from the specified buffer and sets
     * the internal fields equal to the data. If the buffer does not have
     * sufficent data to restore the header then an IndexOutOfBoundsException is
     * thrown by the method. If the buffer does not contain an address mask
     * reqeust then an IllegalArgumentException is thrown.
     * 
     * @param buf
     *            The buffer to read the data from.
     * @param offset
     *            The offset to start reading data.
     * 
     * @return The new offset after reading the data.
     * 
     * @exception java.lang.IndexOutOfBoundsException
     *                Thrown if there is not sufficent data in the buffer.
     * @exception java.lang.IllegalArgumentException
     *                Thrown if the ICMP type is not an Timestamp Request.
     */
    public final int loadFromBuffer(byte[] buf, int offset) {
        if (buf.length < (offset + 20))
            throw new IndexOutOfBoundsException("Insufficient data to load ICMP header");

        offset = super.loadFromBuffer(buf, offset);

        if (getType() != TYPE_TIMESTAMP_REQUEST)
            throw new IllegalArgumentException("The buffer did not contain an Timestamp Request");

        m_origStamp = byteToInt(buf[offset++]) << 24 | byteToInt(buf[offset++]) << 16 | byteToInt(buf[offset++]) << 8 | byteToInt(buf[offset++]);

        offset += 8;

        return offset;
    }

    /**
     * Sets the originate timestamp to the current date in millisecond
     * resolution.
     * 
     * @see java.util.Date#getTime
     * 
     */
    public final void setOriginateTS() {
        m_origStamp = (int) ((new Date()).getTime() & 0xffffffff);
    }

    /**
     * Sets the originate timestamp to the passed value.
     * 
     * @param ts
     *            The timestamp in milliseconds
     * 
     */
    public final void setOriginateTS(int ts) {
        m_origStamp = ts;
    }

    /**
     * Retreives the current timestamp of the reqeust object.
     * 
     * @return The 32-bit timestamp in milliseconds.
     * 
     */
    public final int getOriginateTS() {
        return m_origStamp;
    }

    /**
     * Converts the object to an array of bytes.
     * 
     */
    public final byte[] toBytes() {
        byte[] b = new byte[20];
        storeToBuffer(b, 0);
        return b;
    }
}