org.springframework.boot.autoconfigure.aerospike.AerospikeProperties Maven / Gradle / Ivy
/*
* Copyright 2019 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.boot.autoconfigure.aerospike;
import java.time.Duration;
import com.aerospike.client.policy.AuthMode;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Basic configuration properties for Aerospike client.
* For more details on each option see corresponding field documentation in {@link com.aerospike.client.policy.ClientPolicy}.
*
* @author Anastasiia Smirnova
*/
@Data
@ConfigurationProperties(prefix = "spring.aerospike")
public class AerospikeProperties {
/**
* Potential hosts to seed the cluster from string format: hostname1:port1,hostname2:port2 ... .
*
* See {@link com.aerospike.client.Host#parseHosts} documentation for more details.
*/
private String hosts;
/**
* Port is used if no port specified in AerospikeProperties#hosts.
*
* See {@link com.aerospike.client.Host#parseHosts} documentation for more details.
*/
private int defaultPort = 3000;
/**
* User authentication to cluster.
*/
private String user;
/**
* Password authentication to cluster.
*/
public String password;
/**
* Expected cluster name.
*/
private String clusterName;
/**
* Authentication mode used when user/password is defined.
*/
private AuthMode authMode;
/**
* Initial host connection timeout.
*/
private Duration connectTimeout = Duration.ofSeconds(10);
/**
* Login timeout.
*/
private Duration loginTimeout;
/**
* Maximum number of connections allowed per server node.
*/
private Integer maxConnsPerNode;
/**
* Number of synchronous connection pools used for each node.
*/
private Integer connPoolsPerNode;
/**
* Maximum socket idle.
*/
private Duration maxSocketIdle;
/**
* Interval between cluster tends by maintenance thread.
*/
private Duration tendInterval;
/**
* Throw exception if all seed connections fail on cluster instantiation.
*/
private Boolean failIfNotConnected = true;
private ReadPolicyDefault read = new ReadPolicyDefault();
private WritePolicyDefault write = new WritePolicyDefault();
private BatchPolicyDefault batch = new BatchPolicyDefault();
private QueryPolicyDefault query = new QueryPolicyDefault();
/**
* For more details on each option see corresponding field documentation in {@link com.aerospike.client.policy.Policy}.
*/
@Data
public abstract static class PolicyDefault {
/**
* Socket idle timeout when processing a database command.
*/
public Duration socketTimeout;
/**
* Total transaction timeout.
*/
public Duration totalTimeout;
/**
* Delay after socket read timeout in an attempt to recover the socket
* in the background.
*/
public Duration timeoutDelay;
/**
* Maximum number of retries before aborting the current transaction.
* NOTE: The initial attempt is not counted as a retry.
*/
public Integer maxRetries;
/**
* Time to sleep between retries.
*/
public Duration sleepBetweenRetries;
}
/**
* For more details on each option see corresponding field documentation in {@link com.aerospike.client.policy.QueryPolicy}.
*/
@Data
public static class QueryPolicyDefault extends PolicyDefault {
/**
* Approximate number of records to return to client.
*/
public Long maxRecords;
/**
* Maximum number of concurrent requests to server nodes at any point in time.
*/
public Integer maxConcurrentNodes;
/**
* Number of records to place in queue before blocking.
*/
public Integer recordQueueSize;
/**
* Should bin data be retrieved. If false, only record digests (and user keys
* if stored on the server) are retrieved.
*/
public Boolean includeBinData;
/**
* Terminate query if cluster is in migration state.
*/
public Boolean failOnClusterChange;
}
@Data
public static class ReadPolicyDefault extends PolicyDefault {
}
/**
* For more details on each option see corresponding field documentation in {@link com.aerospike.client.policy.WritePolicy}.
*/
@Data
public static class WritePolicyDefault extends PolicyDefault {
/**
* If the key is sent on a write, the key will be stored with the record on the server.
*/
public Boolean sendKey;
/**
* If the transaction results in a record deletion, leave a tombstone for the record.
*/
public Boolean durableDelete;
}
/**
* For more details on each option see corresponding field documentation in {@link com.aerospike.client.policy.BatchPolicy}.
*/
@Data
public static class BatchPolicyDefault extends PolicyDefault {
/**
* Number of concurrent synchronous batch request threads to server nodes.
*/
public Integer maxConcurrentThreads;
/**
* Allow batch to be processed immediately in the server's receiving thread.
*/
public Boolean allowInline;
/**
* Send set name for every key in the batch.
*/
public Boolean sendSetName;
}
}