Minor Javadoc changes and fixes

Author: sapessi

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/LambdaContainerHandler.java

@@ -136,7 +136,7 @@ public ResponseType proxy(RequestType request, Context context) {
 
     /**
      * Returns the current container configuration object.
-     * @return
+     * @return The container configuration object
      */
     public static ContainerConfig getContainerConfig() {
         return config;

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/RequestReader.java

@@ -65,6 +65,7 @@ public abstract class RequestReader<RequestType, ContainerRequestType> {
      * @param request The incoming request object
      * @param securityContext A jax-rs SecurityContext object (@see com.amazonaws.serverless.proxy.internal.SecurityContextWriter)
      * @param lambdaContext The AWS Lambda context for the request
+     * @param config The container configuration object. This is passed in by the LambdaContainerHandler.
      * @return A valid request object for the underlying container
      * @throws InvalidRequestEventException This exception is thrown if anything goes wrong during the creation of the request object
      */

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/model/ApiGatewayAuthorizerContext.java

@@ -21,13 +21,11 @@
 
 /**
  * Context object used for custom authorizers and Cognito User Pool authorizers.
- * <p>
- *     Custom authorizers  populate the <code>principalId</code> field. All other custom values
- *     returned by the authorizer are accessible via the <code>getContextValue</code> method.
- * </p>
- * <p>
- *     Cognito User Pool authorizers populate the <pre>claims</pre> object.
- * </p>
+ *
+ * Custom authorizers  populate the <code>principalId</code> field. All other custom values
+ * returned by the authorizer are accessible via the <code>getContextValue</code> method.
+ *
+ * Cognito User Pool authorizers populate the <code>claims</code> object.
  */
 public class ApiGatewayAuthorizerContext {
 

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/AwsHttpServletRequest.java

@@ -259,7 +259,7 @@ protected Cookie[] parseCookieHeaderValue(String headerValue) {
     /**
      * Given a map of key/values query string parameters from API Gateway, creates a query string as it would have
      * been in the original url.
-     * @param parameters A Map<String, String> of query string parameters
+     * @param parameters A Map&lt;String, String&gt; of query string parameters
      * @return The generated query string for the URI
      */
     protected String generateQueryString(Map<String, String> parameters) {

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/AwsLambdaServletContainerHandler.java

@@ -21,8 +21,6 @@
 
 import javax.servlet.ServletContext;
 import javax.servlet.ServletException;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
@@ -33,10 +31,10 @@
  * implementations that want to support the servlet 3.1 specs.
  *
  * Because Lambda only allows one event per container at a time, this object also acts as the <code>RequestDispatcher</code>
- * @param <RequestType>
- * @param <ResponseType>
- * @param <ContainerRequestType>
- * @param <ContainerResponseType>
+ * @param <RequestType> The expected request object. This is the model class that the event JSON is de-serialized to
+ * @param <ResponseType> The expected Lambda function response object. Responses from the container will be written to this model object
+ * @param <ContainerRequestType> The request type for the wrapped Java container
+ * @param <ContainerResponseType> The response or response writer type for the wrapped Java container
  */
 public abstract class AwsLambdaServletContainerHandler<RequestType, ResponseType,
                                                         ContainerRequestType extends HttpServletRequest,
@@ -174,6 +172,8 @@ protected void setServletContext(final ServletContext context) {
      * Applies the filter chain in the request lifecycle
      * @param request The Request object. This must be an implementation of HttpServletRequest
      * @param response The response object. This must be an implementation of HttpServletResponse
+     * @throws IOException
+     * @throws ServletException
      */
     protected void doFilter(ContainerRequestType request, ContainerResponseType response) throws IOException, ServletException {
         FilterChainHolder chain = filterChainManager.getFilterChain(request);

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/FilterHolder.java

@@ -130,7 +130,7 @@ public Registration getRegistration() {
 
     /**
      * The name associated with the filter
-     * @return
+     * @return The name for the filter
      */
     public String getFilterName() {
         return filterName;
@@ -144,7 +144,7 @@ public void setFilterName(String filterName) {
 
     /**
      * The map of initialization parameters passed to the filter
-     * @return
+     * @return The Map of initialization parameters used for the filter
      */
     public Map<String, String> getInitParameters() {
         return initParameters;
@@ -153,7 +153,7 @@ public Map<String, String> getInitParameters() {
 
     /**
      * The servlet context that initialized the filter
-     * @return
+     * @return The servlet context the filter was initialized on
      */
     public ServletContext getServletContext() {
         return servletContext;

aws-serverless-java-container-jersey/src/main/java/com/amazonaws/serverless/proxy/jersey/JerseyAwsProxyRequestReader.java

@@ -59,6 +59,7 @@ public class JerseyAwsProxyRequestReader extends RequestReader<AwsProxyRequest,
      * @param request The incoming request object
      * @param securityContext A jax-rs SecurityContext object (@see com.amazonaws.serverless.proxy.internal.SecurityContextWriter)
      * @param lambdaContext The AWS Lambda context for the request
+     * @param config The container config object, this is passed in by the LambdaContainerHandler
      * @return A populated ContainerRequest object
      * @throws InvalidRequestEventException When the method fails to parse the incoming request
      */

aws-serverless-java-container-jersey/src/main/java/com/amazonaws/serverless/proxy/jersey/JerseyLambdaContainerHandler.java

@@ -100,7 +100,11 @@ public static JerseyLambdaContainerHandler<AwsProxyRequest, AwsProxyResponse> ge
     /**
      * Private constructor for a LambdaContainer. Sets the application object, sets the ApplicationHandler,
      * and initializes the application using the <code>onStartup</code> method.
-     * @param jaxRsApplication A Jersey application instance.
+     * @param requestReader A request reader instance
+     * @param responseWriter A response writer instance
+     * @param securityContextWriter A security context writer object
+     * @param exceptionHandler An exception handler
+     * @param jaxRsApplication The JaxRs application
      */
     public JerseyLambdaContainerHandler(RequestReader<RequestType, ContainerRequest> requestReader,
                                         ResponseWriter<JerseyResponseWriter, ResponseType> responseWriter,