#2 - Support @roles ...

Author: rbygrave

src/main/java/io/dinject/javalin/generator/BeanReader.java

@@ -11,22 +11,26 @@
 import java.util.Set;
 import java.util.TreeSet;
 
+import static io.dinject.javalin.generator.Constants.JAVALIN_ROLES;
+
 /**
  * Reads the type information for the Controller (bean).
  */
 class BeanReader {
 
   private final TypeElement beanType;
 
-  private final ProcessingContext ctx;
+  private final List<String> roles;
 
   private final List<MethodReader> methods = new ArrayList<>();
 
+  private final Set<String> staticImportTypes = new TreeSet<>();
+
   private final Set<String> importTypes = new TreeSet<>();
 
-  BeanReader(TypeElement beanType, ProcessingContext ctx) {
+  BeanReader(TypeElement beanType) {
     this.beanType = beanType;
-    this.ctx = ctx;
+    this.roles = Util.findRoles(beanType);
 
     importTypes.add(Constants.GENERATED);
     importTypes.add(Constants.SINGLETON);
@@ -40,12 +44,16 @@ TypeElement getBeanType() {
   }
 
   void read() {
+    if (!roles.isEmpty()) {
+      addStaticImportType(JAVALIN_ROLES);
+      for (String role : roles) {
+        addStaticImportType(role);
+      }
+    }
+
     for (Element element : beanType.getEnclosedElements()) {
-      ElementKind kind = element.getKind();
-      switch (kind) {
-        case METHOD:
-          readMethod(element);
-          break;
+      if (element.getKind() == ElementKind.METHOD) {
+        readMethod(element);
       }
     }
   }
@@ -59,15 +67,14 @@ private void readMethod(Element element) {
     methods.add(methodReader);
   }
 
+  List<String> getRoles() {
+    return roles;
+  }
 
   List<MethodReader> getMethods() {
     return methods;
   }
 
-  ProcessingContext getContext() {
-    return ctx;
-  }
-
   String getPath() {
     Path path = beanType.getAnnotation(Path.class);
     if (path == null) {
@@ -80,7 +87,16 @@ void addImportType(String rawType) {
     importTypes.add(rawType);
   }
 
+  void addStaticImportType(String rawType) {
+    staticImportTypes.add(rawType);
+  }
+
+  Set<String> getStaticImportTypes() {
+    return staticImportTypes;
+  }
+
   Set<String> getImportTypes() {
     return importTypes;
   }
+
 }

src/main/java/io/dinject/javalin/generator/Constants.java

@@ -2,7 +2,9 @@
 
 class Constants {
 
-  static final String IO_JAVALIN_CONTEXT = "io.javalin.Context";
+  static final String JAVALIN_CONTEXT = "io.javalin.Context";
+
+  static final String JAVALIN_ROLES = "io.javalin.security.SecurityUtil.roles";
 
   static final String SINGLETON = "javax.inject.Singleton";
   static final String GENERATED = "javax.annotation.Generated";

src/main/java/io/dinject/javalin/generator/ControllerRouteWriter.java

@@ -54,6 +54,10 @@ private void writeAddRoutes() {
   private void writeImports() {
 
     writer.append(Constants.IMPORT_PATH_TYPE_CONVERT).eol();
+    for (String type : reader.getStaticImportTypes()) {
+      writer.append("import static %s;", type).eol();
+    }
+    writer.eol();
     for (String type : reader.getImportTypes()) {
       writer.append("import %s;", type).eol();
     }

src/main/java/io/dinject/javalin/generator/MethodParam.java

@@ -19,7 +19,7 @@ class MethodParam {
   }
 
   private boolean isJavalinContext() {
-    return Constants.IO_JAVALIN_CONTEXT.equals(rawType);
+    return Constants.JAVALIN_CONTEXT.equals(rawType);
   }
 
   void buildCtxGet(Append writer, Set<String> pathParams) {

src/main/java/io/dinject/javalin/generator/MethodReader.java

@@ -12,6 +12,8 @@
 import java.util.List;
 import java.util.Set;
 
+import static io.dinject.javalin.generator.Constants.JAVALIN_ROLES;
+
 class MethodReader {
 
   private final BeanReader bean;
@@ -24,14 +26,27 @@ class MethodReader {
   private WebMethod webMethod;
   private String webMethodPath;
 
+  /**
+   * Holds enum Roles that are required for the method.
+   */
+  private final List<String> methodRoles;
+
   MethodReader(BeanReader bean, ExecutableElement element) {
     this.bean = bean;
     this.beanPath = bean.getPath();
     this.element = element;
     this.isVoid = element.getReturnType().toString().equals("void");
+    this.methodRoles = Util.findRoles(element);
   }
 
   void read() {
+    if (!methodRoles.isEmpty()) {
+      bean.addStaticImportType(JAVALIN_ROLES);
+      for (String role : methodRoles) {
+        bean.addStaticImportType(role);
+      }
+    }
+
     for (VariableElement p : element.getParameters()) {
       MethodParam param = new MethodParam(p);
       params.add(param);
@@ -71,11 +86,28 @@ void addRoute(Append writer) {
       }
       writer.append(";").eol();
       writer.append("      ctx.status(%s);", httpStatusCode()).eol();
-      writer.append("    });");
+      writer.append("    }");
+
+      List<String> roles = roles();
+      if (!roles.isEmpty()) {
+        writer.append(", roles(");
+        for (int i = 0; i < roles.size(); i++) {
+          if (i > 0) {
+            writer.append(", ");
+          }
+          writer.append(Util.shortName(roles.get(i)));
+        }
+        writer.append(")");
+      }
+      writer.append(");");
       writer.eol().eol();
     }
   }
 
+  private List<String> roles() {
+    return methodRoles.isEmpty() ? bean.getRoles() : methodRoles;
+  }
+
   private int httpStatusCode() {
     return webMethod.statusCode();
   }

src/main/java/io/dinject/javalin/generator/Processor.java

@@ -47,8 +47,7 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
 
   private void writeControllerAdapter(Element controller) {
     if (controller instanceof TypeElement) {
-      TypeElement te = (TypeElement) controller;
-      BeanReader reader = new BeanReader(te, processingContext);
+      BeanReader reader = new BeanReader((TypeElement) controller);
       reader.read();
       try {
         ControllerRouteWriter writer = new ControllerRouteWriter(reader, processingContext);

src/main/java/io/dinject/javalin/generator/Util.java

@@ -1,6 +1,12 @@
 package io.dinject.javalin.generator;
 
+import javax.lang.model.element.AnnotationMirror;
+import javax.lang.model.element.AnnotationValue;
+import javax.lang.model.element.Element;
+import javax.lang.model.type.DeclaredType;
+import java.util.ArrayList;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Set;
 
 class Util {
@@ -62,4 +68,39 @@ static String snakeCase(String name) {
     }
     return sb.toString();
   }
+
+  /**
+   * Find and return the list of roles on the given element.
+   * <p>
+   * This assumes the application uses either <code>@Role</code> annotation
+   * or <code>@PermittedRoles</code> annotation.
+   * </p>
+   *
+   * @param element The bean or method
+   */
+  static List<String> findRoles(Element element) {
+
+    List<String> roles = new ArrayList<>();
+
+    for (AnnotationMirror annotationMirror : element.getAnnotationMirrors()) {
+      DeclaredType annotationType = annotationMirror.getAnnotationType();
+      if (isRolesAnnotation(annotationType)) {
+        for (AnnotationValue value : annotationMirror.getElementValues().values()) {
+          String raw = value.toString();
+          if (raw.startsWith("{")) {
+            raw = raw.substring(1, raw.length() - 1);
+          }
+          for (String singleRole : raw.split(",")) {
+            roles.add(singleRole.trim());
+          }
+        }
+      }
+    }
+    return roles;
+  }
+
+  private static boolean isRolesAnnotation(DeclaredType annotationType) {
+    String name = annotationType.asElement().getSimpleName().toString();
+    return name.endsWith("Roles") || name.endsWith("PermittedRoles");
+  }
 }