org.eclipse.linuxtools.lttng2.core/src/org/eclipse/linuxtools/internal/lttng2/core/control/model/ISessionInfo.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.internal.lttng2.core.control.model;
  13
  14 import java.util.List;
  15
  16 /**
  17  * <p>
  18  * Interface for retrieval of trace session information.
  19  * </p>
  20  *
  21  * @author Bernd Hufmann
  22  */
  23 public interface ISessionInfo extends ITraceInfo {
  24
  25     /**
  26      * @return the session state state (active or inactive).
  27      */
  28     public TraceSessionState getSessionState();
  29     /**
  30      * Sets the session state  to the given value.
  31      * @param state - state to set.
  32      */
  33     public void setSessionState(TraceSessionState state);
  34
  35     /**
  36      * Sets the event state to the value specified by the given name.
  37      * @param stateName - state to set.
  38      */
  39     public void setSessionState(String stateName);
  40
  41     /**
  42      * @return path string where session is located.
  43      */
  44     public String getSessionPath();
  45
  46     /**
  47      * Sets the path string (where session is located) to the given value.
  48      * @param path - session path to set.
  49      */
  50     public void setSessionPath(String path);
  51
  52     /**
  53      * @return all domain information as array.
  54      */
  55     public IDomainInfo[] getDomains();
  56
  57     /**
  58      * Sets all domain information specified by given list.
  59      * @param domains - all domain information to set.
  60      */
  61     public void setDomains(List<IDomainInfo> domains);
  62
  63     /**
  64      * Adds a single domain information.
  65      * @param domainInfo domain information to add.
  66      */
  67     public void addDomain(IDomainInfo domainInfo);
  68
  69     /**
  70      * Returns if session is streamed over network
  71      * @return <code>true</code> if streamed over network else <code>false</code>
  72      */
  73     public boolean isStreamedTrace();
  74
  75     /**
  76      * Sets whether the trace is streamed or not
  77      * @param isStreamedTrace <code>true</code> if streamed over network else <code>false</code>
  78      */
  79     public void setStreamedTrace(boolean isStreamedTrace);
  80 }