org.flite.cach3.aop.UpdateAssignCacheAdvice.java Source code

Java tutorial

Introduction

Here is the source code for org.flite.cach3.aop.UpdateAssignCacheAdvice.java

Source

/*
 * Copyright (c) 2011-2013 Flite, Inc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package org.flite.cach3.aop;

import net.spy.memcached.*;
import org.aspectj.lang.*;
import org.aspectj.lang.annotation.*;
import org.flite.cach3.annotations.*;
import org.flite.cach3.annotations.groups.UpdateAssignCaches;
import org.flite.cach3.api.*;
import org.slf4j.*;
import org.springframework.core.*;
import org.springframework.core.annotation.*;

import java.lang.reflect.*;
import java.security.*;
import java.util.*;

@Aspect
@Order(Ordered.HIGHEST_PRECEDENCE / 2)
public class UpdateAssignCacheAdvice extends CacheBase {
    private static final Logger LOG = LoggerFactory.getLogger(UpdateAssignCacheAdvice.class);

    @Pointcut("@annotation(org.flite.cach3.annotations.UpdateAssignCache)")
    public void updateAssign() {
    }

    @AfterReturning(pointcut = "updateAssign()", returning = "retVal")
    public Object cacheUpdateAssign(final JoinPoint jp, final Object retVal) throws Throwable {
        // If we've disabled the caching programmatically (or via properties file) just flow through.
        if (isCacheDisabled()) {
            LOG.debug("Caching is disabled.");
            return retVal;
        }

        final MemcachedClientIF cache = getMemcachedClient();
        // This is injected caching.  If anything goes wrong in the caching, LOG the crap outta it,
        // but do not let it surface up past the AOP injection itself.
        try {
            final Method methodToCache = getMethodToCache(jp);
            final UpdateAssignCache annotation = methodToCache.getAnnotation(UpdateAssignCache.class);
            final AnnotationInfo info = getAnnotationInfo(annotation, methodToCache.getName(), getJitterDefault());
            final String cacheKey = buildCacheKey(info.getAsString(AType.ASSIGN_KEY),
                    info.getAsString(AType.NAMESPACE), info.getAsString(AType.KEY_PREFIX));
            final int dataIndex = info.getAsInteger(AType.DATA_INDEX, -2).intValue();
            final Object dataObject = dataIndex == -1 ? retVal
                    : getIndexObject(dataIndex, jp.getArgs(), methodToCache.toString());
            final Object submission = (dataObject == null) ? new PertinentNegativeNull() : dataObject;
            boolean cacheable = true;
            if (submission instanceof CacheConditionally) {
                cacheable = ((CacheConditionally) submission).isCacheable();
            }
            if (cacheable) {
                cache.set(cacheKey, info.getAsInteger(AType.JITTER), submission);
            }

            // Notify the observers that a cache interaction happened.
            final List<UpdateAssignCacheListener> listeners = getPertinentListeners(UpdateAssignCacheListener.class,
                    info.getAsString(AType.NAMESPACE));
            if (listeners != null && !listeners.isEmpty()) {
                for (final UpdateAssignCacheListener listener : listeners) {
                    try {
                        listener.triggeredUpdateAssignCache(info.getAsString(AType.NAMESPACE),
                                info.getAsString(AType.ASSIGN_KEY), dataObject, retVal, jp.getArgs());
                    } catch (Exception ex) {
                        LOG.warn("Problem when triggering a listener.", ex);
                    }
                }
            }
        } catch (Exception ex) {
            if (LOG.isDebugEnabled()) {
                LOG.warn("Caching on " + jp.toShortString() + " aborted due to an error.", ex);
            } else {
                LOG.warn("Caching on " + jp.toShortString() + " aborted due to an error: " + ex.getMessage());
            }
        }

        return retVal;
    }

    @Pointcut("@annotation(org.flite.cach3.annotations.groups.UpdateAssignCaches)")
    public void updateAssigns() {
    }

    @AfterReturning(pointcut = "updateAssigns()", returning = "retVal")
    public Object cacheUpdateAssigns(final JoinPoint jp, final Object retVal) throws Throwable {
        try {
            doUpdate(jp, retVal);
        } catch (Throwable ex) {
            if (LOG.isDebugEnabled()) {
                LOG.warn("Caching on " + jp.toShortString() + " aborted due to an error.", ex);
            } else {
                LOG.warn("Caching on " + jp.toShortString() + " aborted due to an error: " + ex.getMessage());
            }
        }
        return retVal;
    }

    private void doUpdate(final JoinPoint jp, final Object retVal) throws Throwable {
        // If we've disabled the caching programmatically (or via properties file) just flow through.
        if (isCacheDisabled()) {
            LOG.debug("Caching is disabled.");
            return;
        }

        final MemcachedClientIF cache = getMemcachedClient();
        final Method methodToCache = getMethodToCache(jp);
        List<UpdateAssignCache> lAnnotations;

        if (methodToCache.getAnnotation(UpdateAssignCache.class) != null) {
            lAnnotations = Arrays.asList(methodToCache.getAnnotation(UpdateAssignCache.class));
        } else {
            lAnnotations = Arrays.asList(methodToCache.getAnnotation(UpdateAssignCaches.class).value());
        }

        for (int i = 0; i < lAnnotations.size(); i++) {
            try {
                // This is injected caching.  If anything goes wrong in the caching, LOG the crap outta it,
                // but do not let it surface up past the AOP injection itself.

                final AnnotationInfo info = getAnnotationInfo(lAnnotations.get(i), methodToCache.getName(),
                        getJitterDefault());
                final String cacheKey = buildCacheKey(info.getAsString(AType.ASSIGN_KEY),
                        info.getAsString(AType.NAMESPACE), info.getAsString(AType.KEY_PREFIX));
                final int dataIndex = info.getAsInteger(AType.DATA_INDEX, -2).intValue();
                final Object dataObject = dataIndex == -1 ? retVal
                        : getIndexObject(dataIndex, jp.getArgs(), methodToCache.toString());
                final Object submission = (dataObject == null) ? new PertinentNegativeNull() : dataObject;
                cache.set(cacheKey, info.getAsInteger(AType.JITTER), submission);

                // Notify the observers that a cache interaction happened.
                final List<UpdateAssignCacheListener> listeners = getPertinentListeners(
                        UpdateAssignCacheListener.class, info.getAsString(AType.NAMESPACE));
                if (listeners != null && !listeners.isEmpty()) {
                    for (final UpdateAssignCacheListener listener : listeners) {
                        try {
                            listener.triggeredUpdateAssignCache(info.getAsString(AType.NAMESPACE),
                                    info.getAsString(AType.ASSIGN_KEY), dataObject, retVal, jp.getArgs());
                        } catch (Exception ex) {
                            LOG.warn("Problem when triggering a listener.", ex);
                        }
                    }
                }
            } catch (Exception ex) {
                if (LOG.isDebugEnabled()) {
                    LOG.warn("Caching on " + jp.toShortString() + " aborted due to an error.", ex);
                } else {
                    LOG.warn("Caching on " + jp.toShortString() + " aborted due to an error: " + ex.getMessage());
                }
            }
        }

    }

    /*default*/ static AnnotationInfo getAnnotationInfo(final UpdateAssignCache annotation,
            final String targetMethodName, final int jitterDefault) {
        final AnnotationInfo result = new AnnotationInfo();

        if (annotation == null) {
            throw new InvalidParameterException(
                    String.format("No annotation of type [%s] found.", UpdateAssignCache.class.getName()));
        }

        final String namespace = annotation.namespace();
        if (AnnotationConstants.DEFAULT_STRING.equals(namespace) || namespace == null || namespace.length() < 1) {
            throw new InvalidParameterException(
                    String.format("Namespace for annotation [%s] must be defined on [%s]",
                            UpdateAssignCache.class.getName(), targetMethodName));
        }
        result.add(new AType.Namespace(namespace));

        final String assignKey = annotation.assignedKey();
        if (AnnotationConstants.DEFAULT_STRING.equals(assignKey) || assignKey == null || assignKey.length() < 1) {
            throw new InvalidParameterException(
                    String.format("AssignedKey for annotation [%s] must be defined on [%s]",
                            UpdateAssignCache.class.getName(), targetMethodName));
        }
        result.add(new AType.AssignKey(assignKey));

        final int dataIndex = annotation.dataIndex();
        if (dataIndex < -1) {
            throw new InvalidParameterException(
                    String.format("DataIndex for annotation [%s] must be -1 or greater on [%s]",
                            UpdateAssignCache.class.getName(), targetMethodName));
        }
        result.add(new AType.DataIndex(dataIndex));

        final int expiration = annotation.expiration();
        if (expiration < 0) {
            throw new InvalidParameterException(
                    String.format("Expiration for annotation [%s] must be 0 or greater on [%s]",
                            UpdateAssignCache.class.getName(), targetMethodName));
        }
        result.add(new AType.Expiration(expiration));

        final int jitter = annotation.jitter();
        if (jitter < -1 || jitter > 99) {
            throw new InvalidParameterException(
                    String.format("Jitter for annotation [%s] must be -1 <= jitter <= 99 on [%s]",
                            UpdateAssignCache.class.getName(), targetMethodName));
        }
        result.add(new AType.Jitter(jitter == -1 ? jitterDefault : jitter));

        return result;
    }
}