You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by cw...@apache.org on 2013/11/08 20:26:41 UTC

svn commit: r1540156 - in /uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent: ./ deploy/uima/ launcher/ metrics/collectors/ monitor/

Author: cwiklik
Date: Fri Nov  8 19:26:41 2013
New Revision: 1540156

URL: http://svn.apache.org/r1540156
Log:
UIMA-3420 fix method headers to keep javadocs happy

Modified:
    uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/NodeAgent.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/RogueProcessReaper.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/deploy/uima/ManagedUimaService.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/JvmArgsParser.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/ManagedProcess.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/metrics/collectors/NodeUsersCollector.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/monitor/RogueProcessDetector.java

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/NodeAgent.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/NodeAgent.java?rev=1540156&r1=1540155&r2=1540156&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/NodeAgent.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/NodeAgent.java Fri Nov  8 19:26:41 2013
@@ -848,12 +848,9 @@ public class NodeAgent extends AbstractD
   /**
    * Called when UIMA AS service wrapper sends an update when a process status changes.
    * 
-   * @param processSimpleDuccId
-   *          - unique DuccId of the UIMA AS process
-   * @param pid
-   *          - process PID
-   * @param state
-   *          - state of the UIMA AS process
+   * @param duccEvent
+   *          - Ducc event object
+   *
    * @throws Exception
    */
 

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/RogueProcessReaper.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/RogueProcessReaper.java?rev=1540156&r1=1540155&r2=1540156&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/RogueProcessReaper.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/RogueProcessReaper.java Fri Nov  8 19:26:41 2013
@@ -273,7 +273,6 @@ public class RogueProcessReaper {
    *          - process owner
    * @param pid
    *          - process id
-   * @return - true if the process has been killed, false otherwise
    * @throws Exception
    */
   public void kill(final String user, final String pid) throws Exception {

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/deploy/uima/ManagedUimaService.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/deploy/uima/ManagedUimaService.java?rev=1540156&r1=1540155&r2=1540156&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/deploy/uima/ManagedUimaService.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/deploy/uima/ManagedUimaService.java Fri Nov  8 19:26:41 2013
@@ -176,7 +176,6 @@ public class ManagedUimaService extends 
 	 * 
 	 * @param args
 	 *            - commandline args
-	 * @return
 	 * @throws Exception
 	 */
 	public String[] getServiceArgs(String[] args) throws Exception {

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/JvmArgsParser.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/JvmArgsParser.java?rev=1540156&r1=1540155&r2=1540156&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/JvmArgsParser.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/JvmArgsParser.java Fri Nov  8 19:26:41 2013
@@ -65,7 +65,7 @@ public class JvmArgsParser {
 	 * 
 	 * @param args - string containing a mix of -X and -D args
 	 * 
-	 * @return
+	 * @return List<String> - list of jvm args
 	 */
 	public static List<String> parse(String args) {
 		List<String> jvm_args = new ArrayList<String>();

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/ManagedProcess.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/ManagedProcess.java?rev=1540156&r1=1540155&r2=1540156&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/ManagedProcess.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/launcher/ManagedProcess.java Fri Nov  8 19:26:41 2013
@@ -245,7 +245,7 @@ public class ManagedProcess implements P
 	/**
 	 * Return current state of this object.
 	 * 
-	 * @return
+	 * @return Process - process object
 	 */
 	public Process getInstance() {
 		return this;
@@ -268,7 +268,7 @@ public class ManagedProcess implements P
 	}
 
 	/**
-	 * @param uimaLogPath
+	 * @param logPath
 	 *            the uimaLogPath to set
 	 */
 	public void setLogPath(String logPath) {
@@ -497,13 +497,10 @@ public class ManagedProcess implements P
 		return command;
 	}
 
+	
 	/**
-	 * @param command
-	 *            the command to set
-	 */
-	/**
-	 * @param command
-	 *            the command to set
+	 * @param commandToRun
+	 *            the command as List
 	 */
 	public void setCommand(List<String> commandToRun) {
 		this.command = commandToRun;
@@ -517,8 +514,8 @@ public class ManagedProcess implements P
 	}
 
 	/**
-	 * @param processCorrelationId
-	 *            the processCorrelationId to set
+	 * @param processId
+	 *            the processId to set
 	 */
 	public void setProcessId(String processId) {
 		this.processCorrelationId = processId;
@@ -532,7 +529,7 @@ public class ManagedProcess implements P
 	}
 
 	/**
-	 * @param jmxPort
+	 * @param port
 	 *            the jmxPort to set
 	 */
 	public void setPort(String port) {

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/metrics/collectors/NodeUsersCollector.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/metrics/collectors/NodeUsersCollector.java?rev=1540156&r1=1540155&r2=1540156&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/metrics/collectors/NodeUsersCollector.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/metrics/collectors/NodeUsersCollector.java Fri Nov  8 19:26:41 2013
@@ -60,7 +60,7 @@ public class NodeUsersCollector implemen
    * System owned (root, nfs, etc) processes should not be reported as rogue. 
    * 
    * @param userId
-   * @return
+   * @return  boolean - true if a given user should be excluded. False otherwise
    */
   public boolean excludeUser(String userId ) {
     String userFilter =
@@ -82,7 +82,7 @@ public class NodeUsersCollector implemen
    * This list contains process names the Agent should exclude while determining rogue processes.
    * 
    * @param process
-   * @return
+   * @return boolean - true if a given process should be excluded. False otherwise
    */
   public boolean excludeProcess(String process ) {
     String processFilter = 

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/monitor/RogueProcessDetector.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/monitor/RogueProcessDetector.java?rev=1540156&r1=1540155&r2=1540156&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/monitor/RogueProcessDetector.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-agent/src/main/java/org/apache/uima/ducc/agent/monitor/RogueProcessDetector.java Fri Nov  8 19:26:41 2013
@@ -82,7 +82,7 @@ public class RogueProcessDetector extend
    * Route builder to receive node agent inventory updates
    * @param delegate - processor where the node inventory is collected and filtered
    * @param endpoint - agent inventory topic
-   * @return
+   * @return RouteBuilder
    */
   public RouteBuilder routeBuilderForEndpoint(final Processor delegate, final String endpoint) {
     return new RouteBuilder() {