Merge branch '15-create-security-and-transaction-annotations' into...

Merge branch '15-create-security-and-transaction-annotations' into '8-integrate-the-necessary-parts-of-the-kypo2-training'

Resolve "Create security and transaction annotations"

See merge request muni-kypo/muni-kypolab/kypo-adaptive-training!8

src/main/java/cz/muni/ics/kypo/training/adaptive/annotations/security/IsAdmin.java

+package cz.muni.ics.kypo.training.adaptive.annotations.security;
+
+import org.springframework.security.access.prepost.PreAuthorize;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The custom annotation <i>@IsAdmin<i/>. All methods annotated with this annotation expect the user has a role <strong>ROLE_TRAINING_ADMINISTRATOR<strong/>.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@PreAuthorize("hasAuthority(T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_ADMINISTRATOR)")
+public @interface IsAdmin {}

src/main/java/cz/muni/ics/kypo/training/adaptive/annotations/security/IsDesignerOrAdmin.java

+package cz.muni.ics.kypo.training.adaptive.annotations.security;
+
+import org.springframework.security.access.prepost.PreAuthorize;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The custom annotation <i>@IsDesignerOrAdmin<i/>. All methods annotated with this annotation expect the user has a role <strong>ROLE_TRAINING_ADMINISTRATOR<strong/>
+ * or <strong>ROLE_TRAINING_DESIGNER<strong/>.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@PreAuthorize("hasAnyAuthority(T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_ADMINISTRATOR, " +
+        "T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_DESIGNER)")
+public @interface IsDesignerOrAdmin {}

src/main/java/cz/muni/ics/kypo/training/adaptive/annotations/security/IsDesignerOrOrganizerOrAdmin.java

+package cz.muni.ics.kypo.training.adaptive.annotations.security;
+
+
+import org.springframework.security.access.prepost.PreAuthorize;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The custom annotation <i>@IsDesignerOrOrganizerOrAdmin<i/>. All methods annotated with this annotation expect the user has a role <strong>ROLE_TRAINING_ADMINISTRATOR<strong/>
+ * or <strong>ROLE_TRAINING_ORGANIZER<strong/> or <strong>ROLE_TRAINING_DESIGNER<strong/>.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@PreAuthorize("hasAnyAuthority(T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_ADMINISTRATOR, " +
+        "T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_DESIGNER, " +
+        "T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_ORGANIZER)")
+public @interface IsDesignerOrOrganizerOrAdmin {}

src/main/java/cz/muni/ics/kypo/training/adaptive/annotations/security/IsOrganizerOrAdmin.java

+package cz.muni.ics.kypo.training.adaptive.annotations.security;
+
+
+import org.springframework.security.access.prepost.PreAuthorize;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The custom annotation <i>@IsOrganizerOrAdmin<i/>. All methods annotated with this annotation expect the user has a role <strong>ROLE_TRAINING_ADMINISTRATOR<strong/>
+ * or <strong>ROLE_TRAINING_ORGANIZER<strong/>.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@PreAuthorize("hasAnyAuthority(T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_ADMINISTRATOR, " +
+        "T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_ORGANIZER)")
+public @interface IsOrganizerOrAdmin {}

src/main/java/cz/muni/ics/kypo/training/adaptive/annotations/security/IsTrainee.java

+package cz.muni.ics.kypo.training.adaptive.annotations.security;
+
+import org.springframework.security.access.prepost.PreAuthorize;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The custom annotation <i>@IsTrainee<i/>. All methods annotated with this annotation expect the user has a role <strong>ROLE_TRAINING_TRAINEE<strong/>.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@PreAuthorize("hasAuthority(T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_TRAINEE)")
+public @interface IsTrainee {}

src/main/java/cz/muni/ics/kypo/training/adaptive/annotations/security/IsTraineeOrAdmin.java

+package cz.muni.ics.kypo.training.adaptive.annotations.security;
+
+import org.springframework.security.access.prepost.PreAuthorize;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The custom annotation <i>@IsTraineeOrAdmin<i/>. All methods annotated with this annotation expect the user has a role <strong>ROLE_TRAINING_ADMINISTRATOR<strong/>
+ * or <strong>ROLE_TRAINING_TRAINEE<strong/>.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@PreAuthorize("hasAnyAuthority(T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_TRAINEE, " +
+        "T(cz.muni.ics.kypo.training.adaptive.enums.RoleTypeSecurity).ROLE_TRAINING_ADMINISTRATOR)")
+public @interface IsTraineeOrAdmin {}

src/main/java/cz/muni/ics/kypo/training/adaptive/annotations/transactions/TransactionalRO.java

+package cz.muni.ics.kypo.training.adaptive.annotations.transactions;
+
+import org.springframework.core.annotation.AliasFor;
+import org.springframework.transaction.annotation.Isolation;
+import org.springframework.transaction.annotation.Propagation;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.lang.annotation.*;
+
+/**
+ * Extending of the class {@link Transactional} which has <i>read-only</i> set to true.
+ *
+ */
+@Transactional(rollbackFor = Exception.class, readOnly = true)
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@Documented
+public @interface TransactionalRO {
+
+    /**
+     * Value string.
+     *
+     * @return the string
+     */
+    @AliasFor("transactionManager")
+    String value() default "";
+
+    /**
+     * Transaction manager string.
+     *
+     * @return the string
+     */
+    @AliasFor("value")
+    String transactionManager() default "";
+
+    /**
+     * Propagation propagation.
+     *
+     * @return the propagation
+     */
+    Propagation propagation() default Propagation.REQUIRED;
+
+    /**
+     * Isolation isolation.
+     *
+     * @return the isolation
+     */
+    Isolation isolation() default Isolation.DEFAULT;
+
+    /**
+     * Timeout int.
+     *
+     * @return the int
+     */
+    int timeout() default -1;
+}

src/main/java/cz/muni/ics/kypo/training/adaptive/annotations/transactions/TransactionalWO.java

+package cz.muni.ics.kypo.training.adaptive.annotations.transactions;
+
+import org.springframework.core.annotation.AliasFor;
+import org.springframework.transaction.annotation.Isolation;
+import org.springframework.transaction.annotation.Propagation;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.lang.annotation.*;
+
+/**
+ * Extending of the class {@link Transactional} which has <i>read-only</i> set to false.
+ *
+ */
+@Transactional(rollbackFor = Exception.class)
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@Documented
+public @interface TransactionalWO {
+
+    /**
+     * Value string.
+     *
+     * @return the string
+     */
+    @AliasFor("transactionManager")
+    String value() default "";
+
+    /**
+     * Transaction manager string.
+     *
+     * @return the string
+     */
+    @AliasFor("value")
+    String transactionManager() default "";
+
+    /**
+     * Propagation propagation.
+     *
+     * @return the propagation
+     */
+    Propagation propagation() default Propagation.REQUIRED;
+
+    /**
+     * Isolation isolation.
+     *
+     * @return the isolation
+     */
+    Isolation isolation() default Isolation.DEFAULT;
+
+    /**
+     * Timeout int.
+     *
+     * @return the int
+     */
+    int timeout() default -1;
+}

src/main/java/cz/muni/ics/kypo/training/adaptive/config/ValidationMessagesConfig.java

+package cz.muni.ics.kypo.training.adaptive.config;
+
+import org.springframework.context.MessageSource;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Primary;
+import org.springframework.context.support.ReloadableResourceBundleMessageSource;
+import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
+
+import java.util.Arrays;
+import java.util.Comparator;
+import java.util.Locale;
+
+/**
+ * The type Validation messages config.
+ */
+@Configuration
+public class ValidationMessagesConfig {
+
+    /**
+     * Message source validation message source.
+     *
+     * @return the message source
+     */
+    @Bean
+    public MessageSource messageSourceValidation() {
+        final ReloadableResourceBundleMessageSource source = new ReloadableResourceBundleMessageSource();
+        source.setBasename("classpath:locale/ValidationMessages");
+        source.setUseCodeAsDefaultMessage(true);
+        source.setDefaultEncoding("UTF-8");
+        source.setCacheSeconds(0);
+        return source;
+    }
+
+    /**
+     * Gets validator.
+     *
+     * @return the validator
+     */
+    @Bean
+    @Primary
+    public LocalValidatorFactoryBean getValidator() {
+        LocalValidatorFactoryBean bean = new LocalValidatorFactoryBean();
+        bean.setValidationMessageSource(messageSourceValidation());
+        return bean;
+    }
+
+    /**
+     * Prints available locales. It is useful to set up appropriate ValidationMessages.properties file name,
+     * e.g. messages_en_US.properties
+     * <p>
+     * en_US
+     * <p>
+     * en -> language; US -> country
+     *
+     * @param args the input arguments
+     */
+    public static void main(String[] args) {
+        Locale[] locales = Locale.getAvailableLocales();
+        Arrays.sort(locales, Comparator.comparing(Locale::toString));
+        for (Locale l : locales) {
+            System.out.println(l.toString());
+        }
+    }
+
+}

src/main/java/cz/muni/ics/kypo/training/adaptive/enums/RoleTypeSecurity.java

+package cz.muni.ics.kypo.training.adaptive.enums;
+
+/**
+ * The enumeration of Role types used for security.
+ *
+ */
+public enum RoleTypeSecurity {
+    /**
+     * Role of training administrator.
+     */
+    ROLE_TRAINING_ADMINISTRATOR,
+    /**
+     * Role of training designer permits user to work with training definitions.
+     */
+    ROLE_TRAINING_DESIGNER,
+    /**
+     * Role of training organizer permits user to work with training instances.
+     */
+    ROLE_TRAINING_ORGANIZER,
+    /**
+     * Role of training trainee permits user to work with training runs.
+     */
+    ROLE_TRAINING_TRAINEE
+}