Merge grace-cache into the framework

Closes gh-1209

Author: rainboyan

grace-cache-core/README.md

@@ -0,0 +1,3 @@
+# grace-cache-core
+
+This module contains Cache annotations and core APIs.

grace-cache-core/build.gradle

@@ -0,0 +1,9 @@
+dependencies {
+    api project(":grace-core")
+    api libs.spring.aop
+    api libs.spring.context
+    api libs.grace.datastore.core
+    api libs.grace.datastore.gorm, {
+        exclude group: 'org.graceframework', module: 'grace-datastore-gorm-validation'
+    }
+}

grace-cache-core/src/main/groovy/grails/plugin/cache/CacheEvict.java

@@ -0,0 +1,63 @@
+/* Copyright 2012-2013 SpringSource.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package grails.plugin.cache;
+
+import org.codehaus.groovy.transform.GroovyASTTransformationClass;
+import org.grails.datastore.gorm.transform.GormASTTransformationClass;
+
+import java.lang.annotation.*;
+
+/**
+ * Indicates that a method (or all methods on a class) trigger(s)
+ * a cache invalidate operation.
+ *
+ * @author Jeff Brown
+ * @author Graeme Rocher
+ */
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@Documented
+@GroovyASTTransformationClass("org.grails.datastore.gorm.transform.OrderedGormTransformation")
+@GormASTTransformationClass("org.grails.plugin.cache.compiler.CacheEvictTransformation")
+public @interface CacheEvict {
+
+	/**
+	 * Qualifier value for the specified cached operation.
+	 * <p>May be used to determine the target cache (or caches), matching the qualifier
+	 * value.
+	 */
+	String[] value();
+
+	/**
+	 * A closure for computing the key dynamically.
+	 * <p>Default is null, meaning all method parameters are considered as a key.
+	 */
+	Class[] key() default {};
+
+	/**
+	 * A closure used for conditioning the method caching.
+	 * <p>Default is null, meaning the method is always cached.
+	 */
+	Class[] condition() default {};
+
+	/**
+	 * Whether or not all the entries inside the cache(s) are removed or not. By
+	 * default, only the value under the associated key is removed.
+	 * <p>Note that specifying setting this parameter to true and specifying a
+	 * CacheKey is not allowed.
+	 */
+	boolean allEntries() default false;
+}

grace-cache-core/src/main/groovy/grails/plugin/cache/CacheOperation.java

@@ -0,0 +1,30 @@
+/* Copyright 2015 original authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package grails.plugin.cache;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * An annotation added to all methods or types that produce a cache operation.
+ *
+ * @author Graeme Rocher
+ */
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface CacheOperation {
+}

grace-cache-core/src/main/groovy/grails/plugin/cache/CachePut.java

@@ -0,0 +1,51 @@
+/* Copyright 2012-2013 SpringSource.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package grails.plugin.cache;
+
+import org.codehaus.groovy.transform.GroovyASTTransformationClass;
+import org.grails.datastore.gorm.transform.GormASTTransformationClass;
+
+import java.lang.annotation.*;
+
+/**
+ * Indicates that a method (or all methods on a class) trigger(s)
+ * aCache#put(Object, Object) operation. As opposed to {@link Cacheable} annotation,
+ * this annotation does not cause the target method to be skipped - rather it
+ * always causes the method to be invoked and its result to be placed into the cache.
+ *
+ * @author Jeff Brown
+ * @author Graeme Rocher
+ */
+@Target({ ElementType.METHOD, ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@Documented
+@GroovyASTTransformationClass("org.grails.datastore.gorm.transform.OrderedGormTransformation")
+@GormASTTransformationClass("org.grails.plugin.cache.compiler.CachePutTransformation")
+public @interface CachePut {
+
+	/**
+	 * Name of the caches in which the update takes place.
+	 * <p>May be used to determine the target cache (or caches), matching the
+	 * qualifier value.
+	 */
+	String[] value();
+
+	/**
+	 * A closure for computing the key dynamically.
+	 * <p>Default is null, meaning all method parameters are considered as a key.
+	 */
+	Class[] key() default {};
+}

grace-cache-core/src/main/groovy/grails/plugin/cache/Cacheable.java

@@ -0,0 +1,62 @@
+/* Copyright 2012-201 SpringSource.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package grails.plugin.cache;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.codehaus.groovy.transform.GroovyASTTransformationClass;
+import org.grails.datastore.gorm.transform.GormASTTransformationClass;
+
+/**
+ * Indicates that a method (or all the methods on a class) can be cached.
+ *
+ * <p>The method arguments and signature are used for computing the key while the
+ * returned instance is used as the cache value.
+ *
+ * @author Jeff Brown
+ * @author Graeme Rocher
+ */
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@Documented
+@GroovyASTTransformationClass("org.grails.datastore.gorm.transform.OrderedGormTransformation")
+@GormASTTransformationClass("org.grails.plugin.cache.compiler.CacheableTransformation")
+public @interface Cacheable {
+
+    /**
+     * Name of the caches in which the update takes place.
+     * <p>May be used to determine the target cache (or caches), matching the
+     * qualifier value.
+     */
+    String[] value();
+
+    /**
+     * A closure for computing the key dynamically.
+     * <p>Default is null, meaning all method parameters are considered as a key.
+     */
+    Class[] key() default {};
+
+    /**
+     * A closure used for conditioning the method caching.
+     * <p>Default is null, meaning the method is always cached.
+     */
+    Class[] condition() default {};
+}