org.eclipse.linuxtools.lttng.ui/src/org/eclipse/linuxtools/lttng/ui/views/control/service/ILttngControlService.java

   1 /**********************************************************************
   2  * Copyright (c) 2012 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Bernd Hufmann - Initial API and implementation
  11  **********************************************************************/
  12 package org.eclipse.linuxtools.lttng.ui.views.control.service;
  13
  14 import java.util.List;
  15
  16 import org.eclipse.core.commands.ExecutionException;
  17 import org.eclipse.core.runtime.IProgressMonitor;
  18 import org.eclipse.linuxtools.lttng.ui.views.control.model.IBaseEventInfo;
  19 import org.eclipse.linuxtools.lttng.ui.views.control.model.ISessionInfo;
  20 import org.eclipse.linuxtools.lttng.ui.views.control.model.IUstProviderInfo;
  21
  22
  23 /** <b><u>ILttngControlService</u></b>
  24 * <p>
  25 * Interface for LTTng trace control command service.
  26 * </p>
  27 */
  28 public interface ILttngControlService {
  29     /**
  30      * Retrieves the existing sessions names from the node.
  31      * @return an array with session names.
  32      * @throws ExecutionException
  33      */
  34     public String[] getSessionNames() throws ExecutionException;
  35     /**
  36      * Retrieves the existing sessions names from the node.
  37      * @param monitor - a progress monitor
  38      * @return an array with session names.
  39      * @throws ExecutionException
  40      */
  41     public String[] getSessionNames(IProgressMonitor monitor) throws ExecutionException;
  42
  43     /**
  44      * Retrieves the session information with the given name the node.
  45      * @param sessionName - the session name
  46      * @return session information
  47      * @throws ExecutionException
  48      */
  49     public ISessionInfo getSession(String sessionName) throws ExecutionException;
  50
  51     /**
  52      * Retrieves the session information with the given name the node.
  53      * @param sessionName - the session name
  54      * @param monitor - a progress monitor
  55      * @return session information
  56      * @throws ExecutionException
  57      */
  58     public ISessionInfo getSession(String sessionName, IProgressMonitor monitor) throws ExecutionException;
  59
  60     /**
  61      * Retrieves the kernel provider information (i.e. the kernel events)
  62      * @return the list of existing kernel events.
  63      * @throws ExecutionException
  64      */
  65     public List<IBaseEventInfo> getKernelProvider() throws ExecutionException;
  66     /**
  67      * Retrieves the kernel provider information (i.e. the kernel events)
  68      * @param monitor - a progress monitor
  69      * @return the list of existing kernel events.
  70      * @throws ExecutionException
  71      */
  72     public List<IBaseEventInfo> getKernelProvider(IProgressMonitor monitor) throws ExecutionException;
  73
  74     /**
  75      * Retrieves the UST provider information from the node.
  76      * @return - the UST provider information.
  77      * @throws ExecutionException
  78      */
  79     public List<IUstProviderInfo> getUstProvider() throws ExecutionException;
  80     /**
  81      * Retrieves the UST provider information from the node.
  82      * @param monitor - a progress monitor
  83      * @return - the UST provider information.
  84      * @throws ExecutionException
  85      */
  86     public List<IUstProviderInfo> getUstProvider(IProgressMonitor monitor) throws ExecutionException;
  87 }