Add Javadoc and related settings

[lttng-ust-java-tests.git] / src / test / java / org / lttng / ust / agent / utils / MiscTestUtils.java

diff --git a/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java b/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java
index 0dd73a1ecd2dc2257d59108a6292ef217189fcbe..3aac32c00d1627641f9fa59dd7a6012e1d22d236 100644 (file)
--- a/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java
+++ b/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java
@@ -1,3 +1,21 @@
+/*
+ * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
 package org.lttng.ust.agent.utils;
 
 import java.io.IOException;
@@ -73,6 +91,12 @@ public final class MiscTestUtils {
         }
     }
 
+    /**
+     * Check if there is a user session daemon currently running on the system.
+     * It needs to be of the same user as the application running this program.
+     *
+     * @return If there is a user session daemon currently running
+     */
     public static boolean checkForUserSessiond() {
         String userName = System.getProperty("user.name");
 
@@ -86,6 +110,12 @@ public final class MiscTestUtils {
                 .anyMatch(s -> s.startsWith(shortUserName));
     }
 
+    /**
+     * Check if there is a root user session daemon daemon currently running on
+     * the system.
+     *
+     * @return If there is a root session daemon currently running
+     */
     public static boolean checkForRootSessiond() {
         List<String> command = Arrays.asList("ps", "-e", "u");
         List<String> output = getOutputFromCommand(false, command);