org.apache.ratis.conf

接口 Reconfigurable

所有已知实现类:

ReconfigurationBase

public interface Reconfigurable

To reconfigure RaftProperties in runtime.

方法概要

限定符和类型	方法和说明
RaftProperties	getProperties()
Collection<String>	getReconfigurableProperties()
default boolean	isPropertyReconfigurable(String property) Is the given property reconfigurable at runtime?
String	reconfigureProperty(String property, String newValue) Change a property on this object to the new value specified.

方法详细资料

getProperties

RaftProperties getProperties()

返回:

the RaftProperties to be reconfigured.

reconfigureProperty

String reconfigureProperty(String property,
                           String newValue)
                    throws ReconfigurationException

Change a property on this object to the new value specified. If the new value specified is null, reset the property to its default value.

This method must apply the change to all internal data structures derived from the configuration property that is being changed. If this object owns other Reconfigurable objects, it must call this method recursively in order to update all these objects.

参数:

property - the name of the given property.

newValue - the new value.

返回:

the effective value, which could possibly be different from specified new value, of the property after reconfiguration.

抛出:

ReconfigurationException - if the property is not reconfigurable or there is an error applying the new value.

isPropertyReconfigurable

default boolean isPropertyReconfigurable(String property)

Is the given property reconfigurable at runtime?

参数:

property - the name of the given property.

返回:

true iff the given property is reconfigurable.

getReconfigurableProperties

Collection<String> getReconfigurableProperties()

返回:

all the properties that are reconfigurable at runtime.