com.alibaba.csp.sentinel.cluster.flow.rule

Class ClusterFlowRuleManager

java.lang.Object

com.alibaba.csp.sentinel.cluster.flow.rule.ClusterFlowRuleManager

public final class ClusterFlowRuleManager
extends Object

Manager for cluster flow rules.

Since:

1.4.0

Author:

Eric Zhao

Field Summary

Fields

Modifier and Type	Field and Description
static Function<String,SentinelProperty<List<FlowRule>>>	DEFAULT_PROPERTY_SUPPLIER The default cluster flow rule property supplier that creates a new dynamic property for a specific namespace to do rule management manually.

Method Summary

Modifier and Type	Method and Description
static List<FlowRule>	getAllFlowRules()
static int	getConnectedCount(long flowId) Get connected count for associated namespace of given flowId.
static Set<Long>	getFlowIdSet(String namespace)
static FlowRule	getFlowRuleById(Long id) Get flow rule by rule ID.
static List<FlowRule>	getFlowRules(String namespace) Get all cluster flow rules within a specific namespace.
static String	getNamespace(long flowId)
static void	loadRules(String namespace, List<FlowRule> rules) Load flow rules for a specific namespace.
static void	register2Property(String namespace) Listen to the SentinelProperty for cluster FlowRules.
static void	registerPropertyIfAbsent(String namespace) Listen to the SentinelProperty for cluster FlowRules if current property for namespace is absent.
static void	removeProperty(String namespace) Remove cluster flow rule property for a specific namespace.
static void	setPropertySupplier(Function<String,SentinelProperty<List<FlowRule>>> propertySupplier)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PROPERTY_SUPPLIER

public static final Function<String,SentinelProperty<List<FlowRule>>> DEFAULT_PROPERTY_SUPPLIER

The default cluster flow rule property supplier that creates a new dynamic property for a specific namespace to do rule management manually.

Method Detail

setPropertySupplier

public static void setPropertySupplier(Function<String,SentinelProperty<List<FlowRule>>> propertySupplier)

register2Property

public static void register2Property(String namespace)

Listen to the SentinelProperty for cluster FlowRules. The property is the source of cluster FlowRules for a specific namespace.

Parameters:

namespace - namespace to register

registerPropertyIfAbsent

public static void registerPropertyIfAbsent(String namespace)

Listen to the SentinelProperty for cluster FlowRules if current property for namespace is absent. The property is the source of cluster FlowRules for a specific namespace.

Parameters:

namespace - namespace to register

removeProperty

public static void removeProperty(String namespace)

Remove cluster flow rule property for a specific namespace.

Parameters:

namespace - valid namespace

getFlowRuleById

public static FlowRule getFlowRuleById(Long id)

Get flow rule by rule ID.

Parameters:

id - rule ID

Returns:

flow rule

getFlowIdSet

public static Set<Long> getFlowIdSet(String namespace)

getAllFlowRules

public static List<FlowRule> getAllFlowRules()

getFlowRules

public static List<FlowRule> getFlowRules(String namespace)

Get all cluster flow rules within a specific namespace.

Parameters:

namespace - valid namespace

Returns:

cluster flow rules within the provided namespace

loadRules

public static void loadRules(String namespace,
                             List<FlowRule> rules)

Load flow rules for a specific namespace. The former rules of the namespace will be replaced.

Parameters:

namespace - a valid namespace

rules - rule list

getConnectedCount

public static int getConnectedCount(long flowId)

Get connected count for associated namespace of given flowId.

Parameters:

flowId - unique flow ID

Returns:

connected count

getNamespace

public static String getNamespace(long flowId)