org.springframework.cache.jcache.interceptor.AbstractJCacheKeyOperation Maven / Gradle / Ivy
/*
* Copyright 2002-2018 the original author or 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 org.springframework.cache.jcache.interceptor;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.List;
import javax.cache.annotation.CacheInvocationParameter;
import javax.cache.annotation.CacheMethodDetails;
import org.springframework.cache.interceptor.CacheResolver;
import org.springframework.cache.interceptor.KeyGenerator;
/**
* A base {@link JCacheOperation} that operates with a key.
*
* @author Stephane Nicoll
* @since 4.1
* @param the annotation type
*/
abstract class AbstractJCacheKeyOperation extends AbstractJCacheOperation {
private final KeyGenerator keyGenerator;
private final List keyParameterDetails;
/**
* Create a new instance.
* @param methodDetails the {@link CacheMethodDetails} related to the cached method
* @param cacheResolver the cache resolver to resolve regular caches
* @param keyGenerator the key generator to compute cache keys
*/
protected AbstractJCacheKeyOperation(CacheMethodDetails methodDetails,
CacheResolver cacheResolver, KeyGenerator keyGenerator) {
super(methodDetails, cacheResolver);
this.keyGenerator = keyGenerator;
this.keyParameterDetails = initializeKeyParameterDetails(this.allParameterDetails);
}
/**
* Return the {@link KeyGenerator} to use to compute cache keys.
*/
public KeyGenerator getKeyGenerator() {
return this.keyGenerator;
}
/**
* Return the {@link CacheInvocationParameter} for the parameters that are to be
* used to compute the key.
* Per the spec, if some method parameters are annotated with
* {@link javax.cache.annotation.CacheKey}, only those parameters should be part
* of the key. If none are annotated, all parameters except the parameter annotated
* with {@link javax.cache.annotation.CacheValue} should be part of the key.
*
The method arguments must match the signature of the related method invocation
* @param values the parameters value for a particular invocation
* @return the {@link CacheInvocationParameter} instances for the parameters to be
* used to compute the key
*/
public CacheInvocationParameter[] getKeyParameters(Object... values) {
List result = new ArrayList<>();
for (CacheParameterDetail keyParameterDetail : this.keyParameterDetails) {
int parameterPosition = keyParameterDetail.getParameterPosition();
if (parameterPosition >= values.length) {
throw new IllegalStateException("Values mismatch, key parameter at position "
+ parameterPosition + " cannot be matched against " + values.length + " value(s)");
}
result.add(keyParameterDetail.toCacheInvocationParameter(values[parameterPosition]));
}
return result.toArray(new CacheInvocationParameter[0]);
}
private static List initializeKeyParameterDetails(List allParameters) {
List all = new ArrayList<>();
List annotated = new ArrayList<>();
for (CacheParameterDetail allParameter : allParameters) {
if (!allParameter.isValue()) {
all.add(allParameter);
}
if (allParameter.isKey()) {
annotated.add(allParameter);
}
}
return (annotated.isEmpty() ? all : annotated);
}
}