org.springframework.data.gemfire.dao.GemfireDaoSupport Maven / Gradle / Ivy
/*
* Copyright 2016-2020 the original author or authors.
*
* Licensed 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
*
* https://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.springframework.data.gemfire.dao;
import org.apache.geode.cache.Region;
import org.springframework.dao.support.DaoSupport;
import org.springframework.data.gemfire.GemfireOperations;
import org.springframework.data.gemfire.GemfireTemplate;
import org.springframework.util.Assert;
/**
* Convenient super class for Pivotal GemFire Data Access Objects (DAO) implementing the Spring
* {@link DaoSupport} abstract class. Intended for use with {@link GemfireTemplate}.
*
* Requires a Pivotal GemFire {@link Region} to be set, providing a {@link GemfireTemplate} based on it to subclasses.
* Can alternatively be initialized directly via a {@link GemfireTemplate} reusing the template's settings.
*
* This class will create its own {@link GemfireTemplate} if a Pivotal GemFire {@link Region} reference is passed in.
* A custom {@link GemfireTemplate} instance can be used through overriding createGemfireTemplate.
*
* @author Costin Leau
* @author John Blum
* @see org.apache.geode.cache.Region
* @see org.springframework.dao.support.DaoSupport
* @see org.springframework.data.gemfire.GemfireTemplate
*/
public abstract class GemfireDaoSupport extends DaoSupport {
private GemfireOperations gemfireTemplate;
/**
* Set the GemfireTemplate for this DAO explicitly as an alternative to specifying a Pivotal GemFire Cache {@link Region}.
*
* @param gemfireTemplate the GemfireTemplate to be use by this DAO.
* @see org.springframework.data.gemfire.GemfireOperations
* @see org.springframework.data.gemfire.GemfireTemplate
* @see #setRegion
*/
public final void setGemfireTemplate(GemfireOperations gemfireTemplate) {
this.gemfireTemplate = gemfireTemplate;
}
/**
* Returns the GemfireTemplate for this DAO, pre-initialized with the Region or set explicitly.
*
* @return an instance of the GemfireTemplate to perform data access operations on the Pivotal GemFire Cache Region.
* @see org.springframework.data.gemfire.GemfireOperations
* @see org.springframework.data.gemfire.GemfireTemplate
*/
public final GemfireOperations getGemfireTemplate() {
return this.gemfireTemplate;
}
/**
* Sets the Pivotal GemFire Cache Region to be used by this DAO. Will automatically create
* an instance of the GemfireTemplate for the given Region.
*
* @param region the Pivotal GemFire Cache Region upon which this DAO operates.
* @see org.apache.geode.cache.Region
* @see #createGemfireTemplate(org.apache.geode.cache.Region)
*/
public void setRegion(Region region) {
this.gemfireTemplate = createGemfireTemplate(region);
}
/**
* Creates an instance of the GemfireTemplate for the given Pivotal GemFire Cache Region.
* Can be overridden in subclasses to provide a GemfireTemplate instance with different configuration,
* or even a custom GemfireTemplate subclass.
*
* @param region the Pivotal GemFire Cache Region for which the GemfireTemplate is created.
* @return a new GemfireTemplate instance configured with the given Pivotal GemFire Cache Region.
* @see org.apache.geode.cache.Region
* @see #setRegion
*/
protected GemfireTemplate createGemfireTemplate(Region region) {
return new GemfireTemplate(region);
}
/**
* Verifies that this DAO has been configured properly.
*/
@Override
protected final void checkDaoConfig() {
Assert.state(gemfireTemplate != null, "A Cache Region or instance of GemfireTemplate is required");
}
}