org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/dialogs/ICreateSessionDialog.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.ui.views.control.dialogs;
  13
  14 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceSessionGroup;
  15
  16 /**
  17  * <p>
  18  * Interface for create session dialog.
  19  * </p>
  20  *
  21  * @author Bernd Hufmann
  22  */
  23 public interface ICreateSessionDialog {
  24
  25     // ------------------------------------------------------------------------
  26     // Accessors
  27     // ------------------------------------------------------------------------
  28     /**
  29      * @return the session name.
  30      */
  31     public String getSessionName();
  32
  33     /**
  34      * @return the session path (null for default path)
  35      */
  36     public String getSessionPath();
  37
  38     /**
  39      * @return true for default location else false
  40      */
  41     public boolean isDefaultSessionPath();
  42
  43     /**
  44      * Initializes the dialog box.
  45      * @param group - the session group
  46      */
  47     public void initialize(TraceSessionGroup group);
  48
  49     /**
  50      * @return true if traces is to be streamed else false.
  51      */
  52     public boolean isStreamedTrace();
  53
  54     /**
  55      * Get the network URL in case control and data is configured together otherwise null
  56      * If it returns a non-null value, getControlUrl() and getDataUrl() have to return null.
  57      * @return The network URL or null.
  58      */
  59     public String getNetworkUrl();
  60
  61     /**
  62      * Get the control URL in case control and data is configured separately.
  63      * If it returns a non-null value, getDataUrl() has to return a valid value too
  64      * and getNetworkUrl() has to return null.
  65      *
  66      * @return The control URL or null.
  67      */
  68     public String getControlUrl();
  69
  70     /**
  71      * Get the data URL in case control and data is configured separately.
  72      * If it returns a non-null value, getControlUrl() has to return a valid value too
  73      * and getNetworkUrl() has to return null.
  74      *
  75      * @return The data URL or null.
  76      */
  77     public String getDataUrl();
  78
  79     /**
  80      * @return for not activating a consumer for this session
  81      */
  82     public boolean isNoConsumer();
  83
  84     /**
  85      * @return for disabling a consumer for this session
  86      */
  87     public boolean isDisableConsumer();
  88
  89     // ------------------------------------------------------------------------
  90     // Operations
  91     // ------------------------------------------------------------------------
  92     /**
  93      * @return the open return value
  94      */
  95     int open();
  96 }