Tarantool JCache Provider (JSR-107)

Getting started

1. Clone this repository to your local machine

2. Install this into you local Maven repository:

mvn clean install

3. Add a dependency to pom.xml file in your project:

<dependency>
    <groupId>org.tarantool</groupId>
    <artifactId>tarantool-jcache</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

4. Configure Hibernate for use Tarantool JCache.

Edit application .properties file in your Spring project:

spring.jpa.properties.hibernate.cache.use_second_level_cache=true
spring.jpa.properties.hibernate.cache.use_structured_entries=true
spring.jpa.properties.hibernate.cache.region.factory_class=org.hibernate.cache.jcache.JCacheRegionFactory
spring.jpa.properties.hibernate.javax.cache.provider=org.tarantool.jsr107.TarantoolCachingProvider
spring.jpa.properties.hibernate.javax.cache.uri=classpath:tarantool.xml

... or configure via hibernate session factory XML file (hibernate.cfg.xml):

<property name="hibernate.cache.use_structured_entries">true</property>
<property name="hibernate.cache.use_second_level_cache">true</property>
<property name="hibernate.cache.region.factory_class">
    org.hibernate.cache.jcache.JCacheRegionFactory
</property>
<property name="hibernate.javax.cache.provider">
    org.tarantool.jsr107.TarantoolCachingProvider
</property>
<property name="hibernate.javax.cache.uri">
    classpath:tarantool.xml
</property>

5. Put tarantool.xml file into your project resource directory, adjust host, port, username (can be empty for guest), password (can be empty). See example of tarantool.xml:

<config
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://www.tarantool.org/v1">
    <connections>
        <connection host="localhost" port="3301"/>
    </connections>
    <default-template>yourCustomTemplateName</default-template>
    <cache-template name="yourCustomTemplateName" enable-management="false" enable-statistics="false">
        <expiry>
            <ttl unit="seconds">30</ttl>
        </expiry>
    </cache-template>
</config>

6. Install and run Tarantool instance. Use default port (3301) on your localhost machine (see "hibernate.javax.cache.uri" property):

box.cfg{listen = 3301}

7. Grant user access to guest:

box.schema.user.grant('guest','read,write,execute,create,drop','universe')

Testing

1. Clone this repository to your local machine

2. Run JSR107 Technology Compability Kit (TCK) test:

mvn clean -DskipTests=false test

For more information related with Tarantool see: https://tarantool.io/en/doc/2.0/book/getting_started/using_docker/