Merge pull request lukas-krecan#25 from lukas-krecan/composedannotation

lukas-krecan · web-flow · commit 9f10c20a8323 · 2017-06-23T21:36:41.000+02:00
Support for composed annotations
diff --git a/shedlock-core/src/main/java/net/javacrumbs/shedlock/core/LockConfiguration.java b/shedlock-core/src/main/java/net/javacrumbs/shedlock/core/LockConfiguration.java
@@ -48,6 +48,9 @@ public LockConfiguration(String name, Instant lockUntil, Instant lockAtLeastUnti
         if (lockAtMostUntil.isBefore(Instant.now())) {
             throw new IllegalArgumentException("lockAtMost is in the past for lock '" + name + "'.");
         }
+        if (name.isEmpty()) {
+            throw new IllegalArgumentException("lock name can not be empty");
+        }
     }
 
     public String getName() {
diff --git a/shedlock-core/src/main/java/net/javacrumbs/shedlock/core/SchedulerLock.java b/shedlock-core/src/main/java/net/javacrumbs/shedlock/core/SchedulerLock.java
@@ -20,13 +20,13 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-@Target({ElementType.METHOD})
+@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface SchedulerLock {
     /**
      * Lock name.
      */
-    String name();
+    String name() default "";
 
     /**
      * How long (in ms) the lock should be kept in case the machine which obtained the lock died before releasing it.
diff --git a/shedlock-spring/src/main/java/net/javacrumbs/shedlock/spring/SpringLockConfigurationExtractor.java b/shedlock-spring/src/main/java/net/javacrumbs/shedlock/spring/SpringLockConfigurationExtractor.java
@@ -21,7 +21,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.aop.support.AopUtils;
-import org.springframework.core.annotation.AnnotationUtils;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.scheduling.support.ScheduledMethodRunnable;
 import org.springframework.util.StringUtils;
 import org.springframework.util.StringValueResolver;
@@ -101,7 +101,7 @@ public Optional<LockConfiguration> getLockConfiguration(Runnable task) {
 
     SchedulerLock findAnnotation(ScheduledMethodRunnable task) {
         Method method = task.getMethod();
-        SchedulerLock annotation = AnnotationUtils.findAnnotation(method, SchedulerLock.class);
+        SchedulerLock annotation = findAnnotation(method);
         if (annotation != null) {
             return annotation;
         } else {
@@ -111,7 +111,7 @@ SchedulerLock findAnnotation(ScheduledMethodRunnable task) {
                 try {
                     Method methodOnTarget = targetClass
                         .getMethod(method.getName(), method.getParameterTypes());
-                    return AnnotationUtils.findAnnotation(methodOnTarget, SchedulerLock.class);
+                    return findAnnotation(methodOnTarget);
                 } catch (NoSuchMethodException e) {
                     return null;
                 }
@@ -121,6 +121,10 @@ SchedulerLock findAnnotation(ScheduledMethodRunnable task) {
         }
     }
 
+    private SchedulerLock findAnnotation(Method method) {
+        return AnnotatedElementUtils.getMergedAnnotation(method, SchedulerLock.class);
+    }
+
     TemporalAmount getLockAtMostFor(SchedulerLock annotation) {
         return getValue(
             annotation.lockAtMostFor(),
diff --git a/shedlock-spring/src/test/java/net/javacrumbs/shedlock/spring/SpringLockConfigurationExtractorTest.java b/shedlock-spring/src/test/java/net/javacrumbs/shedlock/spring/SpringLockConfigurationExtractorTest.java
@@ -22,14 +22,21 @@
 import net.javacrumbs.shedlock.spring.proxytest.SubclassProxyConfig;
 import org.junit.Test;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.core.annotation.AliasFor;
+import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.scheduling.support.ScheduledMethodRunnable;
 import org.springframework.util.StringValueResolver;
 
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
 import java.time.Duration;
 import java.time.temporal.ChronoUnit;
 import java.time.temporal.TemporalAmount;
 import java.util.Optional;
 
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
 import static java.time.Instant.now;
 import static java.time.temporal.ChronoUnit.MILLIS;
 import static java.time.temporal.ChronoUnit.SECONDS;
@@ -104,6 +111,14 @@ public void shouldGetPositiveGracePeriodFromAnnotationWithString() throws NoSuch
         assertThat(gracePeriod).isEqualTo(Duration.of(10, MILLIS));
     }
 
+    @Test
+    public void shouldExtractComposedAnnotation() throws NoSuchMethodException {
+        SchedulerLock annotation = getAnnotation("composedAnnotation");
+        TemporalAmount atMostFor = extractor.getLockAtMostFor(annotation);
+        assertThat(annotation.name()).isEqualTo("lockName1");
+        assertThat(atMostFor).isEqualTo(Duration.of(20, MILLIS));
+    }
+
     @Test
     public void shouldFindAnnotationOnDynamicProxy() throws NoSuchMethodException {
         doTestfindAnnotationOnProxy(DynamicProxyConfig.class);
@@ -158,4 +173,25 @@ public void annotatedMethodWithPositiveGracePeriod() {
     public void annotatedMethodWithPositiveGracePeriodWithString() {
 
     }
+
+    @ScheduledLocked(name = "lockName1")
+    public void composedAnnotation() {
+
+    }
+
+    @Target(METHOD)
+    @Retention(RUNTIME)
+    @Documented
+    @Scheduled
+    @SchedulerLock
+    public @interface ScheduledLocked {
+        @AliasFor(annotation = Scheduled.class, attribute = "cron")
+        String cron() default "";
+
+        @AliasFor(annotation = SchedulerLock.class, attribute = "lockAtMostFor")
+        long lockAtMostFor() default 20L;
+
+        @AliasFor(annotation = SchedulerLock.class, attribute = "name")
+        String name();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,9 @@ public LockConfiguration(String name, Instant lockUntil, Instant lockAtLeastUnti`
`48`	`48`	`if (lockAtMostUntil.isBefore(Instant.now())) {`
`49`	`49`	`throw new IllegalArgumentException("lockAtMost is in the past for lock '" + name + "'.");`
`50`	`50`	`}`
	`51`	`+ if (name.isEmpty()) {`
	`52`	`+ throw new IllegalArgumentException("lock name can not be empty");`
	`53`	`+ }`
`51`	`54`	`}`
`52`	`55`
`53`	`56`	`public String getName() {`