Merge pull request #76 from coderPaddyS/Adriano/finish

Finish javadocs

Author: coderPaddyS

backend/pom.xml

@@ -168,4 +168,4 @@
 		</plugins>
 	</build>
 
-</project>
+</project>

backend/src/main/java/de/itermori/pse/kitroomfinder/backend/BackendApplication.java

@@ -5,11 +5,22 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
 
+/**
+ * The main class.
+ *
+ * @author Lukas Zetto
+ * @author Adriano Castro
+ * @version 1.0
+ */
 @EnableEncryptableProperties
 @EnableJpaRepositories(basePackages = "de.itermori.pse.kitroomfinder.backend.repositories")
 @SpringBootApplication()
 public class BackendApplication {
 
+	/**
+	 * The main method.
+	 * @param args	The arguments.
+	 */
 	public static void main(String[] args) {
 		SpringApplication.run(BackendApplication.class, args);
 	}

backend/src/main/java/de/itermori/pse/kitroomfinder/backend/ErrorHandling.java

@@ -9,8 +9,21 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+/**
+ * Handles GraphQL errors.
+ *
+ * @author Lukas Zetto
+ * @version 1.0
+ */
 @Component
 public class ErrorHandling implements GraphQLErrorHandler {
+
+    /**
+     * Processes GraphQL errors.
+     *
+     * @param errors    The GraphQL errors.
+     * @return          The processed errors.
+     */
     @Override
     public List<GraphQLError> processErrors(List<GraphQLError> errors) {
         if (errors == null || errors.isEmpty()) {
@@ -28,4 +41,5 @@ private GraphQLError unwrapError(GraphQLError error) {
         } else
             return error;
     }
+
 }

backend/src/main/java/de/itermori/pse/kitroomfinder/backend/exceptions/BadTokenException.java

@@ -1,9 +1,19 @@
 package de.itermori.pse.kitroomfinder.backend.exceptions;
 
+/**
+ * Exception class for handling bad tokens.
+ *
+ * @author Lukas Zetto
+ * @version 1.0
+ */
 public class BadTokenException extends RuntimeException {
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public String getMessage() {
         return "invalid Token";
     }
+
 }

backend/src/main/java/de/itermori/pse/kitroomfinder/backend/exceptions/NoSuchAliasSuggestionException.java

@@ -1,7 +1,16 @@
 package de.itermori.pse.kitroomfinder.backend.exceptions;
 
+/**
+ * Exception class for handling case when no alias suggestion with provided name exists.
+ *
+ * @author Adriano Castro
+ * @version 1.0
+ */
 public class NoSuchAliasSuggestionException extends RuntimeException {
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public String getMessage() {
         return "No such alias suggestion exists in the database";

backend/src/main/java/de/itermori/pse/kitroomfinder/backend/exceptions/UserNotFoundException.java

@@ -1,7 +1,16 @@
 package de.itermori.pse.kitroomfinder.backend.exceptions;
 
+/**
+ * Exception class for handling case when provided user is not registered yet.
+ *
+ * @author Lukas Zetto
+ * @version 1.0
+ */
 public class UserNotFoundException extends RuntimeException{
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public String getMessage() {
         return "User not registered yet";

backend/src/main/java/de/itermori/pse/kitroomfinder/backend/security/JWTFilter.java

@@ -18,6 +18,12 @@
 
 import static java.util.function.Predicate.not;
 
+/**
+ * Filter that manages the authentication and authorization.
+ *
+ * @author Lukas Zetto
+ * @version 1.0
+ */
 @Component
 public class JWTFilter extends OncePerRequestFilter {
     private static final String AUTHORIZATION_HEADER = "Authorization";
@@ -51,5 +57,5 @@ private Optional<String> getToken(HttpServletRequest request) {
                 .filter(Matcher::find)
                 .map(matcher -> matcher.group(1));
     }
-}
 
+}

backend/src/main/java/de/itermori/pse/kitroomfinder/backend/security/JWTPreAuthenticationToken.java

@@ -1,40 +1,56 @@
 package de.itermori.pse.kitroomfinder.backend.security;
 
 import de.itermori.pse.kitroomfinder.backend.models.User;
-import javassist.Loader;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 import lombok.Builder;
 import lombok.Getter;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.authority.SimpleGrantedAuthority;
 import org.springframework.security.web.authentication.WebAuthenticationDetails;
 import org.springframework.security.web.authentication.preauth.PreAuthenticatedAuthenticationToken;
 
-import java.util.Set;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
+/**
+ * Token that carries the authorities of the authenticated user.
+ *
+ * @author Lukas Zetto
+ * @version 1.0
+ */
 @Getter
 public class JWTPreAuthenticationToken extends PreAuthenticatedAuthenticationToken {
+
     private static final long serialVersionUID = 34737835684569L;
 
+    /**
+     * Constructor: Demands for the initialization a {@link User} and a {@link WebAuthenticationDetails}.
+     *
+     * @param principal The user.
+     * @param details   The web authentication details.
+     */
     @Builder
     public JWTPreAuthenticationToken(User principal, WebAuthenticationDetails details) {
         super(principal, null, parseAuthorities(principal.getAuthorities()));
         super.setDetails(details);
     }
 
+    /**
+     *
+     * {@inheritDoc}
+     */
     @Override
     public Object getCredentials() {
         return null;
     }
 
     private static Set<GrantedAuthority> parseAuthorities(String authorities) {
         return Stream.of(authorities.split(","))
-                .map(authority -> buildSimpleGrantedAuthority(authority))
+                .map(JWTPreAuthenticationToken::buildSimpleGrantedAuthority)
                 .collect(Collectors.toSet());
     }
 
     private static SimpleGrantedAuthority buildSimpleGrantedAuthority(String authority) {
         return new SimpleGrantedAuthority(authority);
     }
+
 }

backend/src/main/java/de/itermori/pse/kitroomfinder/backend/security/WebSecurityConfig.java

@@ -1,6 +1,5 @@
 package de.itermori.pse.kitroomfinder.backend.security;
 
-import java.util.Arrays;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -13,21 +12,28 @@
 import org.springframework.security.config.http.SessionCreationPolicy;
 import org.springframework.security.web.authentication.preauth.RequestHeaderAuthenticationFilter;
 import org.springframework.web.cors.CorsConfiguration;
-import org.springframework.web.cors.CorsConfigurationSource;
 import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
 import org.springframework.web.filter.CorsFilter;
 
-import static org.springframework.security.config.Customizer.withDefaults;
-
+/**
+ * Configuration class which defines the standard rights
+ * for the methods in the resolver package and for the filter.
+ *
+ * @author Lukas Zetto
+ * @version 1.0
+ */
 @Configuration
 @EnableWebSecurity
 @EnableGlobalMethodSecurity(prePostEnabled = true)
 @RequiredArgsConstructor
 @EnableConfigurationProperties()
 public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
-    private final JWTFilter jwtFilter;
 
+    private final JWTFilter jwtFilter;
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected void configure(HttpSecurity http) throws Exception {
         http
@@ -39,6 +45,10 @@ protected void configure(HttpSecurity http) throws Exception {
                 .addFilterBefore(jwtFilter, RequestHeaderAuthenticationFilter.class);
     }
 
+    /**
+     * Configures CORS.
+     * @return  The CORS filter.
+     */
     @Bean
     public CorsFilter corsConfigurationSource() {
         CorsConfiguration configuration = new CorsConfiguration();
@@ -49,4 +59,5 @@ public CorsFilter corsConfigurationSource() {
         source.registerCorsConfiguration("/**", configuration);
         return new CorsFilter(source);
     }
+
 }

backend/src/test/java/de/itermori/pse/kitroomfinder/backend/BackendApplicationTests.java

@@ -5,19 +5,23 @@
 import com.graphql.spring.boot.test.GraphQLResponse;
 import com.graphql.spring.boot.test.GraphQLTestTemplate;
 import io.micrometer.core.instrument.util.IOUtils;
-import org.json.JSONException;
-import org.skyscreamer.jsonassert.JSONAssert;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.core.io.ClassPathResource;
-
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.Calendar;
 import java.util.Date;
+import org.json.JSONException;
+import org.skyscreamer.jsonassert.JSONAssert;
+import org.springframework.core.io.ClassPathResource;
 
 import static java.lang.String.format;
 import static org.assertj.core.api.Assertions.assertThat;
 
+/**
+ * Utility class that provides utility methods for the test classes.
+ *
+ * @author Lukas Zetto
+ * @version 1.0
+ */
 public class UtilTests {
 
     static final String GRAPHQL_QUERY_REQUEST_PATH = "graphql/resolver/query/request/%s.graphql";
@@ -32,11 +36,30 @@ private static String read(String location) throws IOException {
                 StandardCharsets.UTF_8);
     }
 
-    public static void validate(GraphQLTestTemplate graphQLTestTemplate, String testname) throws IOException, JSONException {
+    /**
+     * Validates a GraphQL query.
+     *
+     * @param graphQLTestTemplate   The GraphQL test template.
+     * @param testname              The name of the GraphQL query.
+     * @throws IOException          When the validation of the GraphQL query fails.
+     * @throws JSONException        When the validation of the GraphQL query fails.
+     */
+    public static void validate(GraphQLTestTemplate graphQLTestTemplate, String testname)
+            throws IOException, JSONException {
         compare(graphQLTestTemplate, testname);
     }
 
-    public static void validate(GraphQLTestTemplate graphQLTestTemplate, String testname, String user) throws IOException, JSONException {
+    /**
+     * Validates a GraphQL query.
+     *
+     * @param graphQLTestTemplate   The GraphQL test template.
+     * @param testname              The name of the GraphQL query.
+     * @param user                  The name of the user.
+     * @throws IOException          When the validation of the GraphQL query fails.
+     * @throws JSONException        When the validation of the GraphQL query fails.
+     */
+    public static void validate(GraphQLTestTemplate graphQLTestTemplate, String testname, String user)
+            throws IOException, JSONException {
         String token = JWT
                 .create()
                 .withIssuer("my-graphql-api")
@@ -48,10 +71,10 @@ public static void validate(GraphQLTestTemplate graphQLTestTemplate, String test
         compare(graphQLTestTemplate, testname);
     }
 
-    private static void compare(GraphQLTestTemplate graphQLTestTemplate, String testname) throws IOException, JSONException {
+    private static void compare(GraphQLTestTemplate graphQLTestTemplate, String testname)
+            throws IOException, JSONException {
         String expectedResultBody = read(format(GRAPHQL_QUERY_RESPONSE_PATH, testname));
         GraphQLResponse response = graphQLTestTemplate.postForResource(format(GRAPHQL_QUERY_REQUEST_PATH, testname));
-        String test = response.getRawResponse().getBody();
         assertThat(response.isOk()).isTrue();
         JSONAssert.assertEquals(expectedResultBody, response.getRawResponse().getBody(), true);
     }