/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.syncope.core.provisioning.api.cache;

/**
 * Virtual Attribute Value cache.
 */
public interface VirAttrCache {

    void setCacheSpec(String cacheSpec);

    /**
     * Force entry expiring.
     *
     * @param key cache key
     */
    void expire(VirAttrCacheKey key);

    /**
     * Retrieve cached value. Return null in case of virtual attribute not cached.
     *
     * @param key cache key
     * @return cached values or null if virtual attribute is not cached.
     */
    VirAttrCacheValue get(VirAttrCacheKey key);

    /**
     * Cache virtual attribute values.
     *
     * @param key cache key
     * @param value virtual attribute values
     * @return value after caching
     */
    VirAttrCacheValue put(VirAttrCacheKey key, VirAttrCacheValue value);
}
