io.ebean.event.BeanQueryAdapter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean-api Show documentation

ebean api

There is a newer version: 15.8.0

package io.ebean.event;

import io.ebean.config.DatabaseConfig;

/**
 * Objects extending this modify queries prior their execution.
 * 
 * This can be used to add expressions to a query - for example to enable
 * partitioning based on the user executing the query.
 * 
 * 
 * A BeanQueryAdapter is either found automatically via class path search or can
 * be added programmatically via {@link DatabaseConfig#add(BeanQueryAdapter)}.
 * 
 * 
 * Note that a BeanQueryAdapter should be thread safe (stateless) and if
 * registered automatically via class path search it needs to have a default
 * constructor.
 * 
 */
public interface BeanQueryAdapter {

  /**
   * Return true if this adapter is interested in queries for the given entity
   * type.
   */
  boolean isRegisterFor(Class cls);

  /**
   * Returns an int to to control the order in which BeanQueryAdapter are
   * executed when there is multiple of them registered for a given entity type
   * (class).
   */
  int getExecutionOrder();

  /**
   * Modify the associated query prior to it being executed.
   */
  void preQuery(BeanQueryRequest request);

}