/*
 * 
 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * The contents of this file are subject to the Sun Community Source
 * License v3.0/Jini Technology Specific Attachment v 1.0 (the
 * "License"). You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 * http://wwws.sun.com/software/jini/licensing/SCSL3_JiniTSA1.html.
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Reference Code is Jini Technology Core Platform code, v2.0. The
 * Developer of the Reference Code is Sun Microsystems, Inc.
 * 
 * Contributor(s): Sun Microsystems, Inc.
 * 
 * The contents of this file comply with the Jini Technology Core
 * Platform Compatibility Kit, v2.0A.
 * 
 * Tester(s): Sun Microsystems, Inc.
 * 
 * Test Platform(s):
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Solaris(TM)SPARC/x86
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Linux (Intel x86)
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Windows (Intel Platform)
 * 
 */
package com.sun.jini.mercury;

import java.io.File;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.io.SyncFailedException;

/**
 * Class that implements the interface for a <tt>ControlLog</tt>. 
 * This class extends <tt>java.io.RandomAccessFile</tt> and relies on 
 * <code>LogStream</code>
 * interface for the actual reading/writing of control data. The only added
 * (convenience) method is <tt>sync</tt> which allows the user to 
 * force synchronization with the underlying device.
 *
 * @author Sun Microsystems, Inc.
 *
 * @since 1.1
 */

class ControlLog extends RandomAccessFile implements LogStream {

    /** Key associated with this stream. */
    private final StreamKey key;

    /**
     * Constructor that takes a <tt>File</tt> and <tt>StreamKey</tt> argument. 
     * The <tt>file</tt> argument is passed through to the superclass 
     * and is always opened in read/write mode. The <tt>key</tt> argument 
     * is assigned to the appropriate internal field. 
     *
     * @exception IOException if an I/O error occurs
     */
    ControlLog(File file, StreamKey key) throws IOException {
        super(file, "rw");
        this.key = key;
    }

    /**
     * Forces system buffers to synchronize with the underlying device.
     *
     * @exception IOException if an I/O error occurs
     *
     * @exception SyncFailedException if the buffers cannot be guaranteed to
     *                                have synchronized with physical media.
     */
    void sync() throws IOException, SyncFailedException {
        getFD().sync();
    }

    //
    // LogStream Methods
    //

    // javadoc inherited from supertype
    public Object getKey() {
        return key;
    }

    // Note: close() method is already implemented by superclass.
}
