io.micronaut.eclipsestore.annotations.Store Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-eclipsestore-annotations Show documentation
Micronaut integration with EclipseStore
The newest version!
/*
 * Copyright 2017-2022 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
 *
 * https://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 io.micronaut.eclipsestore.annotations;

import io.micronaut.aop.Around;
import io.micronaut.context.annotation.AliasFor;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 *
 * An around annotation for methods which simplifies storing objects in an associated Storage Manager.
 *
 * 
 * This annotation will wrap the decorated method to ensure thread isolation.
 * 
 * 
 * You can store method parameters or a Method return statement.
 * 
 * 
 * A method such as this:
 * 
 *  * {@literal @Store(parameters = "customers")}
 * protected Customer addCustomer(Map<String, Customer> customers, CustomerSave customerSave) {
 *     String id = UUID.randomUUID().toString();
 *     Customer customer = new Customer(id, customerSave.getFirstName(), customerSave.getLastName());
 *     customers.put(id, customer);
 *     return customer;
 * }
 * 
 *
 * 
 * Becomes
 * 
 *  * protected Customer addCustomer(Map<String, Customer> customers, CustomerSave customerSave) {
 *     return XThreads.executeSynchronized(() -> {
 *         String id = UUID.randomUUID().toString();
 *         Customer customer = new Customer(id, customerSave.getFirstName(), customerSave.getLastName());
 *         customers.put(id, customer);
 *         embeddedStorageManager.store(customers);
 *         return customer;
 *     });
 * }
 * 
 * 
 * You can store a method's result.
 * 
 * 
 * A method such as this:
 * 
 *  * {@literal @Store(result = true)}
 * protected Customer updateCustomer(String id, CustomerSave customerSave) {
 *     Customer c = data().getCustomers().get(id);
 *     if (c != null) {
 *         c.setFirstName(customerSave.getFirstName());
 *         c.setLastName(customerSave.getLastName());
 *         return c;
 *     }
 *     return null;
 * }
 * 
 * 
 * Becomes
 * 
 *  * protected Customer updateCustomer(String id, CustomerSave customerSave) {
 *     XThreads.executeSynchronized(() -> {
 *         Customer c = data().getCustomers().get(id);
 *         if (c != null) {
 *             c.setFirstName(customerSave.getFirstName());
 *             c.setLastName(customerSave.getLastName());
 *             embeddedStorageManager.store(c);
 *             return c;
 *         }
 *         return null;
 *     }
 * }
 * 
 *
 * @see EclipseStore mutable data docs.
 * @since 1.0.0
 * @author Tim Yates
 * @author Sergio del Amo
 */
@Documented
@Retention(RUNTIME)
@Target({ElementType.METHOD})
@Around
public @interface Store {
    /**
     * The optional name qualifier of the StorageManager to use.
     * If your application only have a EclipseStore instance, this is not required
     *
     * @return The name qualifier of the StorageManager to use.
     */
    @AliasFor(member = "value")
    String name() default "";

    /**
     * parameters which should be stored in the associated StorageManager.
     * @return parameters name which should be stored in the associated StorageManager.
     */
    String[] parameters() default {};

    /**
     * Whether to store the method result.
     * @return Whether to store the method result.
     */
    boolean result() default false;

    /**
     * The Storing strategy. Defaults to Lazy.
     * @return Storing Strategy;
     */
    StoringStrategy strategy() default StoringStrategy.LAZY;

    /**
     * Whether to ignore {@link Store#parameters()} and {@link Store#result()} and store the whole entity class root. Defaults to false.
     *
     * @return  Whether to ignore {@link Store#parameters()} and {@link Store#result()} and store the whole entity class root.
     */
    boolean root() default false;
}