org.springframework.data.aerospike.config.ReadPolicyFactoryBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-aerospike Show documentation
There is a newer version: 4.8.0
Show newest version
/*
 * Copyright 2015 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.aerospike.config;

import com.aerospike.client.policy.Policy;
import org.springframework.beans.factory.FactoryBean;

/**
 * A {@link FactoryBean} implementation that exposes the setters necessary to configure a read policy via XML.
 *
 * @author Peter Milne
 */
public class ReadPolicyFactoryBean implements FactoryBean {

    private final Policy policy;

    /**
     * Creates a new {@link ReadPolicyFactoryBean}.
     */
    public ReadPolicyFactoryBean() {
        this.policy = new Policy();
    }

    /**
     * Configures the timeout for each transaction attempt of an operation.
     *
     * @param socketTimeout The socketTimeout configuration value.
     */
    public void setSocketTimeout(int socketTimeout) {
        this.policy.socketTimeout = socketTimeout;
    }

    /**
     * Configures the timeout for an operation.
     *
     * @param totalTimeout The totalTimeout configuration value.
     */
    public void setTotalTimeout(int totalTimeout) {
        this.policy.totalTimeout = totalTimeout;
    }

    /**
     * Configures the maximum number of retries before aborting the current transaction. A retry is attempted when there
     * is a network error other than timeout. If maxRetries is exceeded, the abort will occur even if the timeout has
     * not yet been exceeded.  The default number of retries is 1.
     *
     * @param maxRetries The maxRetries configuration value.
     */
    public void setMaxRetries(int maxRetries) {
        this.policy.maxRetries = maxRetries;
    }

    /**
     * Configures the sleep between retries if a transaction fails and the timeout was not exceeded.  Enter zero to skip
     * sleep. The default sleep between retries is 500 ms.
     *
     * @param sleepBetweenRetries The sleepBetweenRetries configuration value.
     */
    public void setSleepBetweenRetries(int sleepBetweenRetries) {
        this.policy.sleepBetweenRetries = sleepBetweenRetries;
    }

    @Override
    public Policy getObject() throws Exception {
        return policy;
    }

    @Override
    public boolean isSingleton() {
        return false;
    }

    @Override
    public Class getObjectType() {
        return Policy.class;
    }
}