Address lint warnings.

Author: ludoch

appengine-java21/springboot-helloworld/src/main/java/com/example/appengine/demos/springboot/AppEngineConfig.java

@@ -25,11 +25,14 @@
 /**
  * Declare App Engine services as Spring beans to inject them around.
  * 
- * @author michaeltecourt
  */
 @Configuration
-public class AppEngineConfig {
+public final class AppEngineConfig {
 
+    /**
+     * Bean for DatastoreService.
+     * @return an Appengine DatastoreService service.
+     */
     @Bean
     @ConditionalOnMissingBean
     public DatastoreService datastoreService() {

appengine-java21/springboot-helloworld/src/main/java/com/example/appengine/demos/springboot/HelloworldController.java

@@ -40,13 +40,21 @@
 import lombok.NonNull;
 import lombok.extern.slf4j.Slf4j;
 
+/**
+ *
+ * @author ludo
+ */
 @Controller
 @Slf4j
 public class HelloworldController {
 
     /** Do something with the app engine datastore... */
     private final DatastoreService datastoreService;
 
+    /**
+     *
+     * @param datastoreService
+     */
     @Autowired
     public HelloworldController(DatastoreService datastoreService) {
         this.datastoreService = Objects.requireNonNull(datastoreService);
@@ -75,9 +83,14 @@ public AliensResponse aliens() {
         return AliensResponse.of(Arrays.asList(Alien.of("E.T.", "Home"), Alien.of("Marvin the Martian", "Mars")));
     }
 
+    /**
+     * /admin endpoint handler
+     * @param request Servlet request
+     * @return
+     */
     @RequestMapping(value = "/admin", method = RequestMethod.GET)
     @ResponseBody
-    public AliensResponse admin(HttpServletRequest request) {
+    public AliensResponse admin(final HttpServletRequest request) {
         LOGGER.info("Returning the admin info...");
         Principal userPrincipal = request.getUserPrincipal();
         return AliensResponse.of(
@@ -87,7 +100,7 @@ public AliensResponse admin(HttpServletRequest request) {
 
     @Data
     @AllArgsConstructor(staticName = "of")
-    public static class AliensResponse {
+    static class AliensResponse {
         @NonNull
         private final List<Alien> aliens;
     }
@@ -96,7 +109,7 @@ public static class AliensResponse {
     @AllArgsConstructor(staticName = "of")
     // Only used by Jackson through reflection
     @NoArgsConstructor(access = AccessLevel.PRIVATE, force = true)
-    public static class Alien {
+    static class Alien {
         @NonNull
         @NotEmpty
         private final String name;

appengine-java21/springboot-helloworld/src/main/java/com/example/appengine/demos/springboot/ServletInitializer.java

@@ -19,10 +19,15 @@
 import org.springframework.boot.builder.SpringApplicationBuilder;
 import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
 
+/**
+ *
+ * Initialize the SpringBoot application.
+ * 
+ */
 public class ServletInitializer extends SpringBootServletInitializer {
 
   @Override
-  protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
+  protected SpringApplicationBuilder configure(final SpringApplicationBuilder application) {
     return application.sources(SpringBootExampleApplication.class);
   }
 

appengine-java21/springboot-helloworld/src/main/java/com/example/appengine/demos/springboot/SpringBootExampleApplication.java

@@ -19,10 +19,19 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
+/**
+ *
+ * Main class for the application.
+ */
 @SpringBootApplication
 public class SpringBootExampleApplication {
 
-  public static void main(String[] args) {
+    /**
+     *
+     * Main.
+     * @param args for main.
+     */
+    public static void main(final String[] args) {
     SpringApplication.run(SpringBootExampleApplication.class, args);
   }
 }

appengine-java21/springboot-helloworld/src/main/java/com/example/appengine/demos/springboot/WebAppConfiguration.java

@@ -27,11 +27,22 @@
 import jakarta.servlet.ServletContextEvent;
 import jakarta.servlet.ServletContextListener;
 
+/**
+ *
+ * Secure the /admin endpoints.
+ */
 @Configuration
 @EnableWebSecurity
 public class WebAppConfiguration {
+
+    /**
+     * Security filter
+     * @param http the filter HttpSecurity.
+     * @return the next SecurityFilterChain
+     * @throws Exception
+     */
     @Bean
-    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
+    public SecurityFilterChain securityFilterChain(final HttpSecurity http) throws Exception {
         http.authorizeHttpRequests((auth) -> auth
             .requestMatchers(new AntPathRequestMatcher("/admin/**")).hasRole("ADMIN")
             .anyRequest().permitAll()
@@ -44,6 +55,11 @@ public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Excepti
         return http.build();
     }
 
+    /**
+     *
+     * initializer of the configuration.
+     * @return the initializer
+     */
     @Bean
     public ServletContextInitializer initializer() {
         return servletContext -> {

appengine-java21/springboot-helloworld/src/test/java/com/example/appengine/demos/springboot/SpringBootExampleApplicationTests.java

@@ -35,7 +35,7 @@
 @RunWith(SpringRunner.class)
 @SpringBootTest(classes = SpringBootExampleApplication.class, webEnvironment = WebEnvironment.RANDOM_PORT)
 
-public class SpringBootExampleApplicationTests {
+class SpringBootExampleApplicationTests {
 
 
 
@@ -45,6 +45,10 @@ public class SpringBootExampleApplicationTests {
     @Autowired
     private AbstractServletWebServerFactory container;
 
+    /**
+     * 
+     * Make sure Jetty is used instead of Tomcat for SpringBoot.
+     */
     @Test
     public void applicationShouldStartWithEmbeddedJetty() {
         Assertions.assertThat(container).isInstanceOf(JettyServletWebServerFactory.class);