Package org.apache.dubbo.rpc.cluster.governance

Interface GovernanceRuleRepository

All Known Implementing Classes:
DefaultGovernanceRuleRepositoryImpl
@SPI(value="default", scope=MODULE) public interface GovernanceRuleRepository

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_GROUP
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addListener(String key, String group, org.apache.dubbo.common.config.configcenter.ConfigurationListener listener)
    Register a configuration listener for a specified key The listener only works for service governance purpose, so the target group would always be the value user specifies at startup or 'dubbo' by default.
    default void
    addListener(String key, org.apache.dubbo.common.config.configcenter.ConfigurationListener listener)
    addListener(String, String, ConfigurationListener)
    default String
    getRule(String key, String group)
    Get the governance rule mapped to the given key and the given group
    String
    getRule(String key, String group, long timeout)
    Get the governance rule mapped to the given key and the given group.
    void
    removeListener(String key, String group, org.apache.dubbo.common.config.configcenter.ConfigurationListener listener)
    Stops one listener from listening to value changes in the specified key.
    default void
    removeListener(String key, org.apache.dubbo.common.config.configcenter.ConfigurationListener listener)
    removeListener(String, String, ConfigurationListener)

  • Field Details

  • Method Details

    • addListener

      default void addListener(String key, org.apache.dubbo.common.config.configcenter.ConfigurationListener listener)
      addListener(String, String, ConfigurationListener)
      Parameters:
      key - the key to represent a configuration
      listener - configuration listener

    • removeListener

      default void removeListener(String key, org.apache.dubbo.common.config.configcenter.ConfigurationListener listener)
      removeListener(String, String, ConfigurationListener)
      Parameters:
      key - the key to represent a configuration
      listener - configuration listener

    • addListener

      void addListener(String key, String group, org.apache.dubbo.common.config.configcenter.ConfigurationListener listener)
      Register a configuration listener for a specified key The listener only works for service governance purpose, so the target group would always be the value user specifies at startup or 'dubbo' by default. This method will only register listener, which means it will not trigger a notification that contains the current value.
      Parameters:
      key - the key to represent a configuration
      group - the group where the key belongs to
      listener - configuration listener

    • removeListener

      void removeListener(String key, String group, org.apache.dubbo.common.config.configcenter.ConfigurationListener listener)
      Stops one listener from listening to value changes in the specified key.
      Parameters:
      key - the key to represent a configuration
      group - the group where the key belongs to
      listener - configuration listener

    • getRule

      default String getRule(String key, String group)
      Get the governance rule mapped to the given key and the given group
      Parameters:
      key - the key to represent a configuration
      group - the group where the key belongs to
      Returns:
      target configuration mapped to the given key and the given group

    • getRule

      String getRule(String key, String group, long timeout) throws IllegalStateException
      Get the governance rule mapped to the given key and the given group. If the rule fails to return after timeout exceeds, IllegalStateException will be thrown.
      Parameters:
      key - the key to represent a configuration
      group - the group where the key belongs to
      timeout - timeout value for fetching the target config
      Returns:
      target configuration mapped to the given key and the given group, IllegalStateException will be thrown if timeout exceeds.
      Throws:
      IllegalStateException