alex-plekhanov commented on a change in pull request #46: URL: https://github.com/apache/ignite-extensions/pull/46#discussion_r583534161
########## File path: modules/spring-cache-ext/src/main/java/org/apache/ignite/cache/spring/IgniteClientSpringCacheManager.java ########## @@ -0,0 +1,216 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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 + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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.apache.ignite.cache.spring; + +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.locks.Lock; +import org.apache.ignite.Ignition; +import org.apache.ignite.client.ClientCache; +import org.apache.ignite.client.ClientCacheConfiguration; +import org.apache.ignite.client.IgniteClient; +import org.apache.ignite.configuration.ClientConfiguration; +import org.apache.ignite.internal.util.typedef.internal.A; +import org.apache.ignite.springdata.proxy.IgniteCacheClientProxy; +import org.springframework.beans.factory.DisposableBean; +import org.springframework.cache.annotation.Cacheable; +import org.springframework.context.ApplicationListener; +import org.springframework.context.event.ContextRefreshedEvent; + +/** + * Represents implementation of {@link AbstractCacheManager} that uses thin client to connect to an Ignite cluster + * and obtain an Ignite cache instance. It requires {@link IgniteClient} instance or {@link ClientConfiguration} to be + * set before manager use (see {@link #setClientInstance(IgniteClient), + * {@link #setClientConfiguration(ClientConfiguration)}}). + * + * + * Note that Spring Cache synchronous mode ({@link Cacheable#sync}) is not supported by the current manager + * implementation. Instead, use an {@link SpringCacheManager} that uses an Ignite thick client to connect to Ignite cluster. + * + * You can provide Ignite client instance to a Spring configuration XML file, like below: + * + * <pre name="code" class="xml"> + * <beans xmlns="http://www.springframework.org/schema/beans"; + * xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + * xmlns:cache="http://www.springframework.org/schema/cache"; + * xsi:schemaLocation=" + * http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd + * http://www.springframework.org/schema/cache http://www.springframework.org/schema/cache/spring-cache.xsd"> + * <bean id="igniteClient" class="org.apache.ignite.IgniteClientSpringBean"> + * <property name="clientConfiguration"> + * <bean class="org.apache.ignite.configuration.ClientConfiguration"> + * <property name="addresses"> + * <list> + * <value>127.0.0.1:10800</value> + * </list> + * </property> + * </bean> + * </property> + * </bean> + * + * <!-- Provide Ignite client instance. --> + * <bean id="cacheManager" class="org.apache.ignite.cache.spring.IgniteClientSpringCacheManager"> + * <property name="clientInstance" ref="igniteClient"/> + * </bean> + * + * <!-- Use annotation-driven cache configuration. --> + * <cache:annotation-driven/> + * </beans> + * </pre> + * + * Or you can provide Ignite client configuration, like below: + * + * <pre name="code" class="xml"> + * <beans xmlns="http://www.springframework.org/schema/beans"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + * xmlns:cache="http://www.springframework.org/schema/cache"; + * xsi:schemaLocation=" + * http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd + * http://www.springframework.org/schema/cache http://www.springframework.org/schema/cache/spring-cache.xsd"> + * <!-- Provide Ignite client instance. --> + * <bean id="cacheManager" class="org.apache.ignite.cache.spring.IgniteClientSpringCacheManager"> + * <property name="clientConfiguration"> + * <bean class="org.apache.ignite.configuration.ClientConfiguration"> + * <property name="addresses"> + * <list> + * <value>127.0.0.1:10800</value> + * </list> + * </property> + * </bean> + * </property> + * </bean> + * + * <!-- Use annotation-driven cache configuration. --> + * <cache:annotation-driven/> + * </beans> + * </pre> + */ +public class IgniteClientSpringCacheManager extends AbstractCacheManager implements DisposableBean, + ApplicationListener<ContextRefreshedEvent> +{ + /** Ignite client instance. */ + private IgniteClient cli; + + /** Ignite client configuration. */ + private ClientConfiguration cliCfg; + + /** Cache configurations mapped to cache name. */ + private Map<String, ClientCacheConfiguration> ccfgs; + + /** Flag that indicates whether Ignite client instance was set explicitly. */ + private boolean externalCliInstance; + + /** Gets Ignite client instance. */ + public IgniteClient getClientInstance() { + return cli; + } + + /** Sets Ignite client instance. */ + public IgniteClientSpringCacheManager setClientInstance(IgniteClient cli) { + A.notNull(cli, "cli"); + + this.cli = cli; + + externalCliInstance = true; + + return this; + } + + /** Gets Ignite client configuration. */ + public ClientConfiguration getClientConfiguration() { + return cliCfg; + } + + /** Sets Ignite client configuration that will be used to start the client instance by the manager. */ + public IgniteClientSpringCacheManager setClientConfiguration(ClientConfiguration cliCfg) { + this.cliCfg = cliCfg; + + return this; + } + + /** Gets Ignite cache configurations. */ + public Collection<ClientCacheConfiguration> getCacheConfigurations() { + return ccfgs == null ? Collections.emptyList() : ccfgs.values(); + } + + /** + * Sets the Ignite cache configurations that will be used to start the Ignite cache with the name requested by + * the Spring Cache Framework if one does not exist. If configuration with the requested name + * is not found among the configurations specified by this method, the default configuration with the requested + * name will be used. + */ + public IgniteClientSpringCacheManager setCacheConfigurations(ClientCacheConfiguration... cfgs) { Review comment: Unique configuration for each cache can be defined in Ignite node configuration. The current approach doesn't include a dynamic cache configuration approach, you should always set cache configuration explicitly for each cache. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
