org.tentackle.pdo.PdoCacheFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tentackle-pdo Show documentation
The PDO application layer of the Tentackle Framework
There is a newer version: 21.16.2.0
/*
 * Tentackle - https://tentackle.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.tentackle.pdo;

import org.tentackle.common.ServiceFactory;
import org.tentackle.session.Session;

import java.util.Collection;
import java.util.function.BiFunction;
import java.util.function.Function;


interface PdoCacheFactoryHolder {
  PdoCacheFactory INSTANCE = ServiceFactory.createService(PdoCacheFactory.class, DefaultPdoCacheFactory.class);
}


/**
 * Factory for PDO-Caches.

 * The factory keeps a list of all created caches.
 *
 * @author harald
 */
public interface PdoCacheFactory {

  /**
   * The singleton.
   *
   * @return the singleton
   */
  static PdoCacheFactory getInstance() {
    return PdoCacheFactoryHolder.INSTANCE;
  }


  /**
   * Creates a PDO-cache.

   * Multiple calls on this method return the same object reference,
   * since PDO-caches are singletons per PDO-type.
   *
   * @param  the PDO type
   * @param clazz is the PDO-class managed by the cache
   * @param preload is true if preload all objects in domain context of cache
   * @param readOnly true if cache is readonly
   * @param checkSecurity true if read permission is checked
   * @return the cache
   */
  > PdoCache createCache(
          Class clazz, boolean preload, boolean readOnly, boolean checkSecurity);

  /**
   * Creates an index for a PDO-cache.
   *
   * @param name the index name
   * @param selectFunction the function to select a PDO by key
   * @param extractFunction the function to extract the key from a PDO
   * @return the index
   * @param  the PDO type
   * @param  the key type
   */
  , C extends Comparable> PdoCacheIndex createCacheIndex(
    String name, BiFunction selectFunction, Function extractFunction);


  /**
   * Removes all objects in ALL caches that refer to a given session.

   * Useful after having closed a session in an RMI-Server, for example.
   *
   * @param session the session (probably closed)
   */
  void removeObjectsForSessionInAllCaches(Session session);


  /**
   * Gets a list of all registered caches.
   *
   * @return all registered caches
   */
  Collection>> getAllCaches();


  /**
   * Checks whether a PDO-class provides a cache.
   *
   * @param  the PDO class type
   * @param clazz the class
   * @return the cache, null if none
   */
  > PdoCache getCache(Class clazz);

}