com.alipay.sofa.jraft.conf.Configuration Maven / Gradle / Ivy
/*
* 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 com.alipay.sofa.jraft.conf;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.alipay.sofa.jraft.entity.PeerId;
import com.alipay.sofa.jraft.util.Copiable;
import com.alipay.sofa.jraft.util.Requires;
/**
* A configuration with a set of peers.
* @author boyan ([email protected])
*
* 2018-Mar-15 11:00:26 AM
*/
public class Configuration implements Iterable, Copiable {
private static final Logger LOG = LoggerFactory.getLogger(Configuration.class);
private static final String LEARNER_POSTFIX = "/learner";
private List peers = new ArrayList<>();
// use LinkedHashSet to keep insertion order.
private LinkedHashSet learners = new LinkedHashSet<>();
public Configuration() {
super();
}
/**
* Construct a configuration instance with peers.
*
* @param conf configuration
*/
public Configuration(final Iterable conf) {
this(conf, null);
}
/**
* Construct a configuration from another conf.
*
* @param conf configuration
*/
public Configuration(final Configuration conf) {
this(conf.getPeers(), conf.getLearners());
}
/**
* Construct a Configuration instance with peers and learners.
*
* @param conf peers configuration
* @param learners learners
* @since 1.3.0
*/
public Configuration(final Iterable conf, final Iterable learners) {
Requires.requireNonNull(conf, "conf");
for (final PeerId peer : conf) {
this.peers.add(peer.copy());
}
addLearners(learners);
}
public void setLearners(final LinkedHashSet learners) {
this.learners = learners;
}
/**
* Add a learner peer.
*
* @param learner learner to add
* @return true when add successfully.
*/
public boolean addLearner(final PeerId learner) {
return this.learners.add(learner);
}
/**
* Add learners in batch, returns the added count.
*
* @param learners learners to add
* @return the total added count
*/
public int addLearners(final Iterable learners) {
int ret = 0;
if (learners != null) {
for (final PeerId peer : learners) {
if (this.learners.add(peer.copy())) {
ret++;
}
}
}
return ret;
}
/**
* Remove a learner peer.
*
* @param learner learner to remove
* @return true when remove successfully.
*/
public boolean removeLearner(final PeerId learner) {
return this.learners.remove(learner);
}
/**
* Retrieve the learners set.
*
* @return learners
*/
public LinkedHashSet getLearners() {
return this.learners;
}
/**
* Retrieve the learners set copy.
*
* @return learners
*/
public List listLearners() {
return new ArrayList<>(this.learners);
}
@Override
public Configuration copy() {
return new Configuration(this.peers, this.learners);
}
/**
* Returns true when the configuration is valid.
*
* @return true if the configuration is valid.
*/
public boolean isValid() {
final Set intersection = new HashSet<>(this.peers);
intersection.retainAll(this.learners);
return !this.peers.isEmpty() && intersection.isEmpty();
}
public void reset() {
this.peers.clear();
this.learners.clear();
}
public boolean isEmpty() {
return this.peers.isEmpty();
}
/**
* Returns the peers total number.
*
* @return total num of peers
*/
public int size() {
return this.peers.size();
}
@Override
public Iterator iterator() {
return this.peers.iterator();
}
public Set getPeerSet() {
return new HashSet<>(this.peers);
}
public List listPeers() {
return new ArrayList<>(this.peers);
}
public List getPeers() {
return this.peers;
}
public void setPeers(final List peers) {
this.peers.clear();
for (final PeerId peer : peers) {
this.peers.add(peer.copy());
}
}
public void appendPeers(final Collection set) {
this.peers.addAll(set);
}
public boolean addPeer(final PeerId peer) {
return this.peers.add(peer);
}
public boolean removePeer(final PeerId peer) {
return this.peers.remove(peer);
}
public boolean contains(final PeerId peer) {
return this.peers.contains(peer);
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((this.learners == null) ? 0 : this.learners.hashCode());
result = prime * result + ((this.peers == null) ? 0 : this.peers.hashCode());
return result;
}
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Configuration other = (Configuration) obj;
if (this.learners == null) {
if (other.learners != null) {
return false;
}
} else if (!this.learners.equals(other.learners)) {
return false;
}
if (this.peers == null) {
return other.peers == null;
} else {
return this.peers.equals(other.peers);
}
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
final List peers = listPeers();
int i = 0;
int size = peers.size();
for (final PeerId peer : peers) {
sb.append(peer);
if (i < size - 1 || !this.learners.isEmpty()) {
sb.append(",");
}
i++;
}
size = this.learners.size();
i = 0;
for (final PeerId peer : this.learners) {
sb.append(peer).append(LEARNER_POSTFIX);
if (i < size - 1) {
sb.append(",");
}
i++;
}
return sb.toString();
}
public boolean parse(final String conf) {
if (StringUtils.isBlank(conf)) {
return false;
}
reset();
final String[] peerStrs = StringUtils.split(conf, ',');
for (String peerStr : peerStrs) {
final PeerId peer = new PeerId();
int index;
boolean isLearner = false;
if ((index = peerStr.indexOf(LEARNER_POSTFIX)) > 0) {
// It's a learner
peerStr = peerStr.substring(0, index);
isLearner = true;
}
if (peer.parse(peerStr)) {
if (isLearner) {
addLearner(peer);
} else {
addPeer(peer);
}
} else {
LOG.error("Fail to parse peer {} in {}, ignore it.", peerStr, conf);
}
}
return true;
}
/**
* Get the difference between |*this| and |rhs|
* |included| would be assigned to |*this| - |rhs|
* |excluded| would be assigned to |rhs| - |*this|
*/
public void diff(final Configuration rhs, final Configuration included, final Configuration excluded) {
included.peers = new ArrayList<>(this.peers);
included.peers.removeAll(rhs.peers);
excluded.peers = new ArrayList<>(rhs.peers);
excluded.peers.removeAll(this.peers);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy