Fix javadoc errors in order to comply with Maven OSS requirements

webgoat-container/src/main/java/org/owasp/webgoat/service/ApplicationService.java

@@ -37,8 +37,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
+ * <p>ApplicationService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class ApplicationService extends BaseService {
@@ -46,8 +48,8 @@ public class ApplicationService extends BaseService {
     /**
      * Returns global application info
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link org.owasp.webgoat.application.Application} object.
      */
     @RequestMapping(value = "/application.mvc", produces = "application/json")
     public @ResponseBody

webgoat-container/src/main/java/org/owasp/webgoat/service/BaseService.java

@@ -44,14 +44,23 @@ import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.ResponseStatus;
 
 /**
+ * <p>Abstract BaseService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @RequestMapping("/service")
 public abstract class BaseService {
 
     private static final Logger logger = LoggerFactory.getLogger(BaseService.class);
 
+    /**
+     * <p>handleException.</p>
+     *
+     * @param request a {@link javax.servlet.http.HttpServletRequest} object.
+     * @param ex a {@link java.lang.Exception} object.
+     * @return a {@link org.owasp.webgoat.service.ExceptionInfo} object.
+     */
     @ExceptionHandler(Exception.class)
     @ResponseStatus(value = HttpStatus.I_AM_A_TEAPOT)
     public @ResponseBody
@@ -66,6 +75,12 @@ public abstract class BaseService {
         return response;
     }
 
+    /**
+     * <p>getWebSession.</p>
+     *
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link org.owasp.webgoat.session.WebSession} object.
+     */
     public WebSession getWebSession(HttpSession session) {
         WebSession ws;
         Object o = session.getAttribute(WebSession.SESSION);
@@ -79,6 +94,12 @@ public abstract class BaseService {
         return ws;
     }
 
+    /**
+     * <p>getStringStackTrace.</p>
+     *
+     * @param t a {@link java.lang.Throwable} object.
+     * @return a {@link java.lang.String} object.
+     */
     public String getStringStackTrace(Throwable t){
         StringWriter sw = new StringWriter();
         PrintWriter pw = new PrintWriter(sw);

webgoat-container/src/main/java/org/owasp/webgoat/service/CookieService.java

@@ -42,8 +42,10 @@ import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.servlet.ModelAndView;
 
 /**
+ * <p>CookieService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class CookieService extends BaseService {
@@ -51,8 +53,8 @@ public class CookieService extends BaseService {
     /**
      * Returns cookies for last attack
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.util.List} object.
      */
     @RequestMapping(value = "/cookie.mvc", produces = "application/json")
     public @ResponseBody
@@ -65,8 +67,8 @@ public class CookieService extends BaseService {
     /**
      * Returns cookies and params for current lesson
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link org.springframework.web.servlet.ModelAndView} object.
      */
     @RequestMapping(value = "/cookies_widget.mvc", produces = "text/html")
     public ModelAndView showCookiesAndParamsAsHtml(HttpSession session) {

webgoat-container/src/main/java/org/owasp/webgoat/service/DummyService.java

@@ -34,12 +34,19 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
+ * <p>DummyService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class DummyService extends BaseService{
 
+    /**
+     * <p>firstNames.</p>
+     *
+     * @return a {@link java.util.List} object.
+     */
     @RequestMapping(value = "/first.mvc", produces = "application/json")
     public @ResponseBody
     List<String> firstNames() {

webgoat-container/src/main/java/org/owasp/webgoat/service/ExceptionInfo.java

@@ -1,54 +1,76 @@
-/***************************************************************************************************
- * 
- * 
- * This file is part of WebGoat, an Open Web Application Security Project utility. For details,
- * please see http://www.owasp.org/
- * 
- * Copyright (c) 2002 - 20014 Bruce Mayhew
- * 
- * 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., 59 Temple Place - Suite 330, Boston, MA
- * 02111-1307, USA.
- * 
- * Getting Source ==============
- * 
- * Source for this application is maintained at https://github.com/WebGoat/WebGoat, a repository for free software
- * projects.
- * 
- * For details, please see http://webgoat.github.io
- */
-package org.owasp.webgoat.service;
-
-/**
- *
- * @author rlawson
- */
-public class ExceptionInfo {
-
-    private String url;
-    private String message;
-
-    public String getUrl() {
-        return url;
-    }
-
-    public void setUrl(String url) {
-        this.url = url;
-    }
-
-    public String getMessage() {
-        return message;
-    }
-
-    public void setMessage(String message) {
-        this.message = message;
-    }
-}
+/***************************************************************************************************
+ * 
+ * 
+ * This file is part of WebGoat, an Open Web Application Security Project utility. For details,
+ * please see http://www.owasp.org/
+ * 
+ * Copyright (c) 2002 - 20014 Bruce Mayhew
+ * 
+ * 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., 59 Temple Place - Suite 330, Boston, MA
+ * 02111-1307, USA.
+ * 
+ * Getting Source ==============
+ * 
+ * Source for this application is maintained at https://github.com/WebGoat/WebGoat, a repository for free software
+ * projects.
+ * 
+ * For details, please see http://webgoat.github.io
+ */
+package org.owasp.webgoat.service;
+
+/**
+ * <p>ExceptionInfo class.</p>
+ *
+ * @author rlawson
+ * @version $Id: $Id
+ */
+public class ExceptionInfo {
+
+    private String url;
+    private String message;
+
+    /**
+     * <p>Getter for the field <code>url</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
+    public String getUrl() {
+        return url;
+    }
+
+    /**
+     * <p>Setter for the field <code>url</code>.</p>
+     *
+     * @param url a {@link java.lang.String} object.
+     */
+    public void setUrl(String url) {
+        this.url = url;
+    }
+
+    /**
+     * <p>Getter for the field <code>message</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
+    public String getMessage() {
+        return message;
+    }
+
+    /**
+     * <p>Setter for the field <code>message</code>.</p>
+     *
+     * @param message a {@link java.lang.String} object.
+     */
+    public void setMessage(String message) {
+        this.message = message;
+    }
+}

webgoat-container/src/main/java/org/owasp/webgoat/service/HintService.java

@@ -17,8 +17,10 @@ import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.servlet.ModelAndView;
 
 /**
+ * <p>HintService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class HintService extends BaseService {
@@ -26,8 +28,8 @@ public class HintService extends BaseService {
     /**
      * Returns hints for current lesson
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.util.List} object.
      */
     @RequestMapping(value = "/hint.mvc", produces = "application/json")
     public @ResponseBody
@@ -55,6 +57,12 @@ public class HintService extends BaseService {
         return listHints;
     }
 
+    /**
+     * <p>showHintsAsHtml.</p>
+     *
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link org.springframework.web.servlet.ModelAndView} object.
+     */
     @RequestMapping(value = "/hint_widget.mvc", produces = "text/html")
     public
             ModelAndView showHintsAsHtml(HttpSession session) {

webgoat-container/src/main/java/org/owasp/webgoat/service/LessonMenuService.java

@@ -47,8 +47,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
+ * <p>LessonMenuService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class LessonMenuService extends BaseService {
@@ -58,8 +60,8 @@ public class LessonMenuService extends BaseService {
     /**
      * Returns the lesson menu which is used to build the left nav
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.util.List} object.
      */
     @RequestMapping(value = "/lessonmenu.mvc", produces = "application/json")
     public @ResponseBody

webgoat-container/src/main/java/org/owasp/webgoat/service/LessonPlanService.java

@@ -42,8 +42,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
+ * <p>LessonPlanService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class LessonPlanService extends BaseService {
@@ -51,8 +53,8 @@ public class LessonPlanService extends BaseService {
     /**
      * Returns source for current attack
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.lang.String} object.
      */
     @RequestMapping(value = "/lessonplan.mvc", produces = "application/html")
     public @ResponseBody

webgoat-container/src/main/java/org/owasp/webgoat/service/LessonTitleService.java

@@ -10,13 +10,18 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 @Controller
+/**
+ * <p>LessonTitleService class.</p>
+ *
+ * @version $Id: $Id
+ */
 public class LessonTitleService extends BaseService {
 	
-	 /**
+    /**
      * Returns the title for the current attack
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.lang.String} object.
      */
     @RequestMapping(value = "/lessontitle.mvc", produces = "application/html")
     public @ResponseBody

webgoat-container/src/main/java/org/owasp/webgoat/service/ParameterService.java

@@ -43,8 +43,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
+ * <p>ParameterService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class ParameterService extends BaseService {
@@ -54,8 +56,8 @@ public class ParameterService extends BaseService {
     /**
      * Returns request parameters for last attack
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.util.List} object.
      */
     @RequestMapping(value = "/parameter.mvc", produces = "application/json")
     public @ResponseBody

webgoat-container/src/main/java/org/owasp/webgoat/service/RestartLessonService.java

@@ -34,8 +34,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
+ * <p>RestartLessonService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class RestartLessonService extends BaseService {
@@ -43,8 +45,8 @@ public class RestartLessonService extends BaseService {
     /**
      * Returns current lesson
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.lang.String} object.
      */
     @RequestMapping(value = "/restartlesson.mvc", produces = "text/text")
     public @ResponseBody

webgoat-container/src/main/java/org/owasp/webgoat/service/SessionService.java

@@ -17,8 +17,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
+ * <p>SessionService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class SessionService extends BaseService {
@@ -26,8 +28,9 @@ public class SessionService extends BaseService {
     /**
      * Returns hints for current lesson
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @param request a {@link javax.servlet.http.HttpServletRequest} object.
+     * @return a {@link java.lang.String} object.
      */
     @RequestMapping(value = "/session.mvc", produces = "application/json")
     public @ResponseBody

webgoat-container/src/main/java/org/owasp/webgoat/service/SolutionService.java

@@ -39,8 +39,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
+ * <p>SolutionService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class SolutionService extends BaseService {
@@ -48,8 +50,8 @@ public class SolutionService extends BaseService {
     /**
      * Returns solution for current attack
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.lang.String} object.
      */
     @RequestMapping(value = "/solution.mvc", produces = "text/html")
     public @ResponseBody
@@ -59,6 +61,12 @@ public class SolutionService extends BaseService {
         return source;
     }
 
+    /**
+     * <p>getSolution.</p>
+     *
+     * @param s a {@link org.owasp.webgoat.session.WebSession} object.
+     * @return a {@link java.lang.String} object.
+     */
     protected String getSolution(WebSession s) {
 
         String source = null;

webgoat-container/src/main/java/org/owasp/webgoat/service/SourceService.java

@@ -44,8 +44,10 @@ import static org.owasp.webgoat.LessonSource.END_SOURCE_SKIP;
 import static org.owasp.webgoat.LessonSource.START_SOURCE_SKIP;
 
 /**
+ * <p>SourceService class.</p>
  *
  * @author rlawson
+ * @version $Id: $Id
  */
 @Controller
 public class SourceService extends BaseService {
@@ -53,8 +55,8 @@ public class SourceService extends BaseService {
     /**
      * Returns source for current attack
      *
-     * @param session
-     * @return
+     * @param session a {@link javax.servlet.http.HttpSession} object.
+     * @return a {@link java.lang.String} object.
      */
     @RequestMapping(value = "/source.mvc", produces = "application/text")
     public @ResponseBody