org.redisson.config.SentinelServersConfig Maven / Gradle / Ivy
Show all versions of redisson Show documentation
/**
* Copyright (c) 2013-2022 Nikita Koksharov
*
* 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
*
* 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.redisson.config;
import org.redisson.api.HostNatMapper;
import org.redisson.api.HostPortNatMapper;
import org.redisson.api.NatMapper;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
*
* @author Nikita Koksharov
*
*/
public class SentinelServersConfig extends BaseMasterSlaveServersConfig {
private List sentinelAddresses = new ArrayList<>();
private NatMapper natMapper = NatMapper.direct();
private String masterName;
private String sentinelUsername;
private String sentinelPassword;
/**
* Database index used for Redis connection
*/
private int database = 0;
/**
* Sentinel scan interval in milliseconds
*/
private int scanInterval = 1000;
private boolean checkSentinelsList = true;
private boolean checkSlaveStatusWithSyncing = true;
private boolean sentinelsDiscovery = true;
public SentinelServersConfig() {
}
SentinelServersConfig(SentinelServersConfig config) {
super(config);
setSentinelAddresses(config.getSentinelAddresses());
setMasterName(config.getMasterName());
setDatabase(config.getDatabase());
setScanInterval(config.getScanInterval());
setNatMapper(config.getNatMapper());
setCheckSentinelsList(config.isCheckSentinelsList());
setSentinelUsername(config.getSentinelUsername());
setSentinelPassword(config.getSentinelPassword());
setCheckSlaveStatusWithSyncing(config.isCheckSlaveStatusWithSyncing());
setSentinelsDiscovery(config.isSentinelsDiscovery());
}
/**
* Master server name used by Redis Sentinel servers and master change monitoring task.
*
* @param masterName of Redis
* @return config
*/
public SentinelServersConfig setMasterName(String masterName) {
this.masterName = masterName;
return this;
}
public String getMasterName() {
return masterName;
}
/**
* Username required by the Redis Sentinel servers for authentication.
*
* @param sentinelUsername of Redis
* @return config
*/
public SentinelServersConfig setSentinelUsername(String sentinelUsername) {
this.sentinelUsername = sentinelUsername;
return this;
}
public String getSentinelUsername() {
return sentinelUsername;
}
/**
* Password required by the Redis Sentinel servers for authentication.
* Used only if sentinel password differs from master and slave.
*
* @param sentinelPassword of Redis
* @return config
*/
public SentinelServersConfig setSentinelPassword(String sentinelPassword) {
this.sentinelPassword = sentinelPassword;
return this;
}
public String getSentinelPassword() {
return sentinelPassword;
}
/**
* Add Redis Sentinel node address in host:port format. Multiple nodes at once could be added.
*
* @param addresses of Redis
* @return config
*/
public SentinelServersConfig addSentinelAddress(String... addresses) {
sentinelAddresses.addAll(Arrays.asList(addresses));
return this;
}
public List getSentinelAddresses() {
return sentinelAddresses;
}
public void setSentinelAddresses(List sentinelAddresses) {
this.sentinelAddresses = sentinelAddresses;
}
/**
* Database index used for Redis connection
* Default is 0
*
* @param database number
* @return config
*/
public SentinelServersConfig setDatabase(int database) {
this.database = database;
return this;
}
public int getDatabase() {
return database;
}
public int getScanInterval() {
return scanInterval;
}
/**
* Sentinel scan interval in milliseconds
*
* Default is 1000
*
* @param scanInterval in milliseconds
* @return config
*/
public SentinelServersConfig setScanInterval(int scanInterval) {
this.scanInterval = scanInterval;
return this;
}
/*
* Use {@link #setNatMapper(NatMapper)}
*/
@Deprecated
public SentinelServersConfig setNatMap(Map natMap) {
HostPortNatMapper mapper = new HostPortNatMapper();
mapper.setHostsPortMap(natMap);
this.natMapper = mapper;
return this;
}
public NatMapper getNatMapper() {
return natMapper;
}
/**
* Defines NAT mapper which maps Redis URI object.
* Applied to all Redis connections.
*
* @see HostNatMapper
* @see HostPortNatMapper
*
* @param natMapper - nat mapper object
* @return config
*/
public SentinelServersConfig setNatMapper(NatMapper natMapper) {
this.natMapper = natMapper;
return this;
}
public boolean isCheckSentinelsList() {
return checkSentinelsList;
}
/**
* Enables sentinels list check during Redisson startup.
*
* Default is true
*
* @param checkSentinelsList - boolean value
* @return config
*/
public SentinelServersConfig setCheckSentinelsList(boolean checkSentinelsList) {
this.checkSentinelsList = checkSentinelsList;
return this;
}
public boolean isCheckSlaveStatusWithSyncing() {
return checkSlaveStatusWithSyncing;
}
/**
* check node status from sentinel with 'master-link-status' flag
*
* Default is true
*
* @param checkSlaveStatusWithSyncing - boolean value
* @return config
*/
public SentinelServersConfig setCheckSlaveStatusWithSyncing(boolean checkSlaveStatusWithSyncing) {
this.checkSlaveStatusWithSyncing = checkSlaveStatusWithSyncing;
return this;
}
public boolean isSentinelsDiscovery() {
return sentinelsDiscovery;
}
/**
* Enables sentinels discovery.
*
* Default is true
*
* @param sentinelsDiscovery - boolean value
* @return config
*/
public SentinelServersConfig setSentinelsDiscovery(boolean sentinelsDiscovery) {
this.sentinelsDiscovery = sentinelsDiscovery;
return this;
}
}