1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.syncope.core.provisioning.api.cache;
20
21 /**
22 * Virtual Attribute Value cache.
23 */
24 public interface VirAttrCache {
25
26 void setCacheSpec(String cacheSpec);
27
28 /**
29 * Force entry expiring.
30 *
31 * @param key cache key
32 */
33 void expire(VirAttrCacheKey key);
34
35 /**
36 * Retrieve cached value. Return null in case of virtual attribute not cached.
37 *
38 * @param key cache key
39 * @return cached values or null if virtual attribute is not cached.
40 */
41 VirAttrCacheValue get(VirAttrCacheKey key);
42
43 /**
44 * Cache virtual attribute values.
45 *
46 * @param key cache key
47 * @param value virtual attribute values
48 * @return value after caching
49 */
50 VirAttrCacheValue put(VirAttrCacheKey key, VirAttrCacheValue value);
51 }