Package com.nimbusds.infinispan.persistence.sql.config

Class SQLStoreConfigurationBuilder

java.lang.Object
org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder
org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<SQLStoreConfiguration,SQLStoreConfigurationBuilder>
com.nimbusds.infinispan.persistence.sql.config.SQLStoreConfigurationBuilder
All Implemented Interfaces:
SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>, org.infinispan.commons.configuration.Builder<SQLStoreConfiguration>, org.infinispan.commons.configuration.Self<SQLStoreConfigurationBuilder>, org.infinispan.configuration.cache.ConfigurationChildBuilder, org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder, org.infinispan.configuration.cache.StoreConfigurationBuilder<SQLStoreConfiguration,SQLStoreConfigurationBuilder>, org.infinispan.configuration.cache.StoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
public class SQLStoreConfigurationBuilder extends org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<SQLStoreConfiguration,SQLStoreConfigurationBuilder> implements SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
SQL store configuration builder.

Used by the Infinispan ConfigurationBuilder to implement fluent configuration for the SQL CacheLoader / CacheWriter. Methods should use the fluent style, rather than the setter/getter style and should return an instance of this object.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.infinispan.configuration.cache.ConfigurationBuilder
    builder
     

    Fields inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder

    async, attributes

  • Constructor Summary

    Constructors
    Constructor
    Description
    SQLStoreConfigurationBuilder(org.infinispan.configuration.cache.PersistenceConfigurationBuilder builder)
    Creates a new SQL store configuration builder.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.infinispan.configuration.cache.Configuration
    build()
     
    org.infinispan.configuration.cache.ClusteringConfigurationBuilder
    clustering()
     
    SQLStoreConfigurationBuilder
    connectionPool(String cacheName)
    Sets the optional connection pool reference.
    SQLStoreConfiguration
    create()
     
    SQLStoreConfigurationBuilder
    createTableIfMissing(boolean createTableIfMissing)
    Sets the optional create table if missing configuration.
    SQLStoreConfigurationBuilder
    createTableIgnoreErrors(boolean createTableIgnoreErrors)
    Sets the optional create table ignore errors configuration.
    org.infinispan.configuration.cache.CustomInterceptorsConfigurationBuilder
    customInterceptors()
    Deprecated, for removal: This API element is subject to removal in a future version.
    org.infinispan.configuration.cache.EncodingConfigurationBuilder
    encoding()
     
    org.infinispan.configuration.cache.ExpirationConfigurationBuilder
    expiration()
     
    SQLStoreConfigurationBuilder
    expiredQueryPageLimit(int pageLimit)
    Sets the page limit in SQL queries to select expired records.
    protected org.infinispan.configuration.cache.ConfigurationBuilder
    getBuilder()
     
    org.infinispan.configuration.cache.IndexingConfigurationBuilder
    indexing()
     
    org.infinispan.configuration.cache.InvocationBatchingConfigurationBuilder
    invocationBatching()
     
    org.infinispan.configuration.cache.LockingConfigurationBuilder
    locking()
     
    org.infinispan.configuration.cache.MemoryConfigurationBuilder
    memory()
     
    org.infinispan.configuration.cache.PersistenceConfigurationBuilder
    persistence()
     
    org.infinispan.configuration.cache.QueryConfigurationBuilder
    query()
     
    SQLStoreConfigurationBuilder
    queryExecutorClass(Class queryExecutorClass)
    Sets the optional class for executing direct SQL queries against the database.
    SQLStoreConfigurationBuilder
    recordTransformerClass(Class recordTransformerClass)
    Sets the class for transforming between Infinispan entries (key / value pair and optional metadata) and a corresponding SQL record.
    org.infinispan.configuration.cache.SecurityConfigurationBuilder
    security()
     
    SQLStoreConfigurationBuilder
    self()
     
    boolean
    simpleCache()
     
    org.infinispan.configuration.cache.ConfigurationChildBuilder
    simpleCache(boolean arg0)
     
    org.infinispan.configuration.cache.SitesConfigurationBuilder
    sites()
     
    SQLStoreConfigurationBuilder
    sqlDialect(org.jooq.SQLDialect sqlDialect)
    Sets the preferred SQL dialect.
    org.infinispan.configuration.cache.StatisticsConfigurationBuilder
    statistics()
     
    org.infinispan.configuration.cache.ConfigurationChildBuilder
    template(boolean arg0)
     
    org.infinispan.configuration.cache.TransactionConfigurationBuilder
    transaction()
     
    org.infinispan.configuration.cache.UnsafeConfigurationBuilder
    unsafe()
     
    void
    validate()
     
    SQLStoreConfigurationBuilder
    withProperties(Properties properties)
     

    Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder

    addProperty, async, attributes, fetchPersistentState, ignoreModifications, maxBatchSize, preload, properties, purgeOnStartup, read, segmented, shared, toString, transactional, validate, validate, writeOnly

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.infinispan.commons.configuration.Builder

    read, reset

    Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, query, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe, validate

    Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder

    persistence

    Methods inherited from interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder

    addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, segmented, shared, transactional, writeOnly

  • Field Details

    • builder

      protected final org.infinispan.configuration.cache.ConfigurationBuilder builder

  • Constructor Details

    • SQLStoreConfigurationBuilder

      public SQLStoreConfigurationBuilder(org.infinispan.configuration.cache.PersistenceConfigurationBuilder builder)
      Creates a new SQL store configuration builder.
      Parameters:
      builder - The general persistence configuration builder.

  • Method Details

    • create

      public SQLStoreConfiguration create()
      Specified by:
      create in interface org.infinispan.commons.configuration.Builder<SQLStoreConfiguration>

    • recordTransformerClass

      public SQLStoreConfigurationBuilder recordTransformerClass(Class recordTransformerClass)
      Description copied from interface: SQLStoreConfigurationChildBuilder
      Sets the class for transforming between Infinispan entries (key / value pair and optional metadata) and a corresponding SQL record.
      Specified by:
      recordTransformerClass in interface SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
      Parameters:
      recordTransformerClass - The record transformer class. Must not be null.
      Returns:
      The builder.

    • queryExecutorClass

      public SQLStoreConfigurationBuilder queryExecutorClass(Class queryExecutorClass)
      Description copied from interface: SQLStoreConfigurationChildBuilder
      Sets the optional class for executing direct SQL queries against the database.
      Specified by:
      queryExecutorClass in interface SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
      Parameters:
      queryExecutorClass - The query executor class, null if not specified.
      Returns:
      The builder.

    • sqlDialect

      public SQLStoreConfigurationBuilder sqlDialect(org.jooq.SQLDialect sqlDialect)
      Description copied from interface: SQLStoreConfigurationChildBuilder
      Sets the preferred SQL dialect.
      Specified by:
      sqlDialect in interface SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
      Parameters:
      sqlDialect - The preferred SQL dialect. Must not be null.
      Returns:
      The builder.

    • createTableIfMissing

      public SQLStoreConfigurationBuilder createTableIfMissing(boolean createTableIfMissing)
      Description copied from interface: SQLStoreConfigurationChildBuilder
      Sets the optional create table if missing configuration.
      Specified by:
      createTableIfMissing in interface SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
      Parameters:
      createTableIfMissing - true to create the underlying SQL table(s) if they are missing (the default setting), false to skip this check.
      Returns:
      The builder.

    • createTableIgnoreErrors

      public SQLStoreConfigurationBuilder createTableIgnoreErrors(boolean createTableIgnoreErrors)
      Description copied from interface: SQLStoreConfigurationChildBuilder
      Sets the optional create table ignore errors configuration.
      Specified by:
      createTableIgnoreErrors in interface SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
      Parameters:
      createTableIgnoreErrors - true to ignore create table errors, false to treat them as fatal.
      Returns:
      The builder.

    • connectionPool

      public SQLStoreConfigurationBuilder connectionPool(String cacheName)
      Description copied from interface: SQLStoreConfigurationChildBuilder
      Sets the optional connection pool reference.
      Specified by:
      connectionPool in interface SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
      Parameters:
      cacheName - The cache name for which to use its SQL store connection pool, null if not specified.
      Returns:
      The builder.

    • expiredQueryPageLimit

      public SQLStoreConfigurationBuilder expiredQueryPageLimit(int pageLimit)
      Description copied from interface: SQLStoreConfigurationChildBuilder
      Sets the page limit in SQL queries to select expired records.
      Specified by:
      expiredQueryPageLimit in interface SQLStoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
      Parameters:
      pageLimit - The page limit in SQL queries to select expired records.
      Returns:
      The page limit in SQL queries to select expired records.

    • withProperties

      public SQLStoreConfigurationBuilder withProperties(Properties properties)
      Specified by:
      withProperties in interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder<SQLStoreConfigurationBuilder>
      Overrides:
      withProperties in class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<SQLStoreConfiguration,SQLStoreConfigurationBuilder>

    • validate

      public void validate()
      Specified by:
      validate in interface org.infinispan.commons.configuration.Builder<SQLStoreConfiguration>
      Overrides:
      validate in class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<SQLStoreConfiguration,SQLStoreConfigurationBuilder>

    • self

      public SQLStoreConfigurationBuilder self()
      Specified by:
      self in interface org.infinispan.commons.configuration.Self<SQLStoreConfigurationBuilder>

    • template

      public org.infinispan.configuration.cache.ConfigurationChildBuilder template(boolean arg0)
      Specified by:
      template in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • simpleCache

      public org.infinispan.configuration.cache.ConfigurationChildBuilder simpleCache(boolean arg0)
      Specified by:
      simpleCache in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • simpleCache

      public boolean simpleCache()
      Specified by:
      simpleCache in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • clustering

      public org.infinispan.configuration.cache.ClusteringConfigurationBuilder clustering()
      Specified by:
      clustering in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • customInterceptors

      @Deprecated(forRemoval=true) public org.infinispan.configuration.cache.CustomInterceptorsConfigurationBuilder customInterceptors()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      customInterceptors in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • encoding

      public org.infinispan.configuration.cache.EncodingConfigurationBuilder encoding()
      Specified by:
      encoding in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • expiration

      public org.infinispan.configuration.cache.ExpirationConfigurationBuilder expiration()
      Specified by:
      expiration in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • query

      public org.infinispan.configuration.cache.QueryConfigurationBuilder query()
      Specified by:
      query in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • indexing

      public org.infinispan.configuration.cache.IndexingConfigurationBuilder indexing()
      Specified by:
      indexing in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • invocationBatching

      public org.infinispan.configuration.cache.InvocationBatchingConfigurationBuilder invocationBatching()
      Specified by:
      invocationBatching in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • statistics

      public org.infinispan.configuration.cache.StatisticsConfigurationBuilder statistics()
      Specified by:
      statistics in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • persistence

      public org.infinispan.configuration.cache.PersistenceConfigurationBuilder persistence()
      Specified by:
      persistence in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • locking

      public org.infinispan.configuration.cache.LockingConfigurationBuilder locking()
      Specified by:
      locking in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • security

      public org.infinispan.configuration.cache.SecurityConfigurationBuilder security()
      Specified by:
      security in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • transaction

      public org.infinispan.configuration.cache.TransactionConfigurationBuilder transaction()
      Specified by:
      transaction in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • unsafe

      public org.infinispan.configuration.cache.UnsafeConfigurationBuilder unsafe()
      Specified by:
      unsafe in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • sites

      public org.infinispan.configuration.cache.SitesConfigurationBuilder sites()
      Specified by:
      sites in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • memory

      public org.infinispan.configuration.cache.MemoryConfigurationBuilder memory()
      Specified by:
      memory in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

    • getBuilder

      protected org.infinispan.configuration.cache.ConfigurationBuilder getBuilder()

    • build

      public org.infinispan.configuration.cache.Configuration build()
      Specified by:
      build in interface org.infinispan.configuration.cache.ConfigurationChildBuilder