Internalize lttng.ui Activator

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.jni / src / org / eclipse / linuxtools / lttng / jni_v2_3 / JniTrace_v2_3.java

package org.eclipse.linuxtools.lttng.jni_v2_3;
/*******************************************************************************
 * Copyright (c) 2009, 2011 Ericsson, MontaVista Software
 * 
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *   William Bourque (wbourque@gmail.com) - Initial API and implementation
 *   Yufen Kuo       (ykuo@mvista.com) - add support to allow user specify trace library path
 *   Yufen Kuo       (ykuo@mvista.com) - bug 340341: handle gracefully when native library failed to initialize
 *******************************************************************************/

import org.eclipse.linuxtools.lttng.jni.JniTrace;
import org.eclipse.linuxtools.lttng.jni.JniTracefile;
import org.eclipse.linuxtools.lttng.jni.common.Jni_C_Pointer_And_Library_Id;
import org.eclipse.linuxtools.lttng.jni.exception.JniException;

/**
 * <b><u>JniTrace_v2_3</u></b>
 * <p>
 * JniTrace version to support Lttng traceformat of version 2.3.<br>
 * This class extend abstract class JniTrace with (possibly) version specific implementation.<br>
 *  
 * It also make sure the correct library is loaded by liblttvlibraryloader.so 
 * <p>
 */
public class JniTrace_v2_3 extends JniTrace {
	
	// This is the dynamic library name that is passed to the library loader (liblttvlibraryloader.so) to load.
	// It needs to be a complete name, like "libXYZ.so", unlike java that would take "XYZ". It could also take a complete path.
	//	The library need to be accessible, i.e. LD_LIBRARY_PATH need to be set correctly. 
	private static final String LIBRARY_NAME = "liblttvtraceread-2.3.so"; //$NON-NLS-1$
	
	/*
	 * Forbid access to the default constructor
	 */
	protected JniTrace_v2_3() {
		super();
    }
    
	
	public JniTrace_v2_3(String newpath) throws JniException {
		super(newpath);
	}
	
    public JniTrace_v2_3(String newpath, boolean newPrintDebug) throws JniException {
    	super(newpath, newPrintDebug);
    }
    
    
    public JniTrace_v2_3(JniTrace_v2_3 oldTrace) {
    	super(oldTrace);
    }        
    
    public JniTrace_v2_3(Jni_C_Pointer_And_Library_Id newPtr, boolean newPrintDebug) throws JniException {
    	super(newPtr, newPrintDebug);
    }   

    /**
     * Get the trace library name
     * <p>
     * 
     * Get the version specific native trace library name
     * 
     * @return The native trace library name
     */
    @Override
    public String getTraceLibName() {
        return LIBRARY_NAME;
    }
    
    /**
     * Allocate (call constructor for) a new JniTracefile.<p>
     * 
     * This method is made to bypass limitation related to abstract class, see comment in JniTrace
     * 
     * @return JniTracefile 	a newly allocated JniTracefile
     * 
     * @see org.eclipse.linuxtools.lttng.jni.JniTrace
     */
    @Override
	public JniTracefile allocateNewJniTracefile(Jni_C_Pointer_And_Library_Id newPtr, JniTrace newParentTrace) throws JniException {
    	return new JniTracefile_v2_3(newPtr, newParentTrace);
    }

}