Profiler.java

package org.sigmah.client.util.profiler;

/*
 * #%L
 * Sigmah
 * %%
 * Copyright (C) 2010 - 2016 URD
 * %%
 * 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 3 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, see
 * <http://www.gnu.org/licenses/gpl-3.0.html>.
 * #L%
 */

import com.google.gwt.core.client.JavaScriptObject;
import org.sigmah.client.security.AuthenticationProvider;
import org.sigmah.offline.event.JavaScriptEvent;
import org.sigmah.offline.indexeddb.IndexedDB;
import org.sigmah.offline.indexeddb.NativeOpenDatabaseRequest;
import org.sigmah.offline.status.ApplicationState;
import org.sigmah.offline.status.ApplicationStateManager;

/**
 * JavaScript profiler. Measure performances of the application.
 * 
 * @author Raphaël Calabro (raphael.calabro@netapsys.fr)
 */
public class Profiler implements ProfilerStrategy {
	
	/**
	 * Shared instance.
	 */
	public static final Profiler INSTANCE = new Profiler();
	
	public static final String DATABASE_NAME = "profiler";
	
	/**
	 * Current strategy.
	 */
	private ProfilerStrategy strategy = new InactiveProfilerStrategy();
	
	private final ExecutionAsyncDAO executionAsyncDAO = new ExecutionAsyncDAO();
	private AuthenticationProvider authenticationProvider;
	private ApplicationStateManager applicationStateManager;
	
	/**
	 * Activate or deactivate profiling.
	 * 
	 * @param active
	 *			<code>true</code> to active the profiler, 
	 *			<code>false</code> to deactivate it.
	 */
	public void setActive(boolean active) {
		if (active) {
			strategy = new ActiveProfilerStrategy();
		} else {
			strategy = new InactiveProfilerStrategy();
		}
	}
	/**
	 * Check if the profiler is active or not.
	 * @return <code>true</code> if the profiler is active, 
	 * <code>false</code> otherwise.
	 */
	public boolean isActive() {
		return strategy instanceof ActiveProfilerStrategy;
	}
	/**
	 * Removes the database used by the profiler.
	 */
	public void deleteDatabase() {
		final IndexedDB indexedDB = new IndexedDB();
		final NativeOpenDatabaseRequest<ProfilerStore> request = indexedDB.deleteDatabase(DATABASE_NAME, ProfilerStore.class);

		request.addSuccessHandler(new JavaScriptEvent() {

			@Override
			public void onEvent(JavaScriptObject event) {
				// Success.
			}

		});
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void startScenario(Scenario scenario) {
		strategy.startScenario(scenario);
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void pauseScenario(Scenario scenario) {
		strategy.pauseScenario(scenario);
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void resumeScenario(Scenario scenario) {
		strategy.resumeScenario(scenario);
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void markCheckpoint(Scenario scenario, String checkpoint) {
		strategy.markCheckpoint(scenario, checkpoint);
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public Execution endScenario(Scenario scenario) {
		final Execution execution = strategy.endScenario(scenario);
		if (execution != null) {
			execution.setUserEmailAddress(authenticationProvider.get().getUserEmail());
			execution.setOnline(applicationStateManager.getLastState() == ApplicationState.ONLINE);
			executionAsyncDAO.saveOrUpdate(execution);
		}
		return execution;
	}
	
	// ---
	// GETTERS & SETTERS
	// ---
	
	public ApplicationStateManager getApplicationStateManager() {
		return applicationStateManager;
	}

	public void setApplicationStateManager(ApplicationStateManager applicationStateManager) {
		this.applicationStateManager = applicationStateManager;
	}

	public AuthenticationProvider getAuthenticationProvider() {
		return authenticationProvider;
	}

	public void setAuthenticationProvider(AuthenticationProvider authenticationProvider) {
		this.authenticationProvider = authenticationProvider;
	}
	
}