EntityManagerCache.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.apereo.portal.jpa.cache;

import java.io.Serializable;

/**
 * Used to cache data associated with a specific EntityManager. The EntityManager specified by the
 * Persistent Unit Name must be active in the current Thread.
 *
 */
public interface EntityManagerCache {

    /**
     * Cache a value associated with the persistent unit.
     *
     * @param persistenceUnitName The name of the JPA persistent unit to associate the cached data
     *     with
     * @param key The cache key
     * @param value The cache value
     */
    void put(String persistenceUnitName, Serializable key, Object value);

    /**
     * @param persistenceUnitName The name of the JPA persistent unit to associate the cached data
     *     with
     * @param key The cache key
     * @return The cached value
     */
    <T> T get(String persistenceUnitName, Serializable key);
}