Class YamlClientConfigBuilder

java.lang.Object
com.hazelcast.config.AbstractYamlConfigBuilder
com.hazelcast.client.config.YamlClientConfigBuilder

public class YamlClientConfigBuilder
extends AbstractYamlConfigBuilder
Loads the ClientConfig using YAML.
  • Constructor Details

    • YamlClientConfigBuilder

      public YamlClientConfigBuilder​(String resource) throws IOException
      Throws:
      IOException
    • YamlClientConfigBuilder

      public YamlClientConfigBuilder​(File file) throws IOException
      Throws:
      IOException
    • YamlClientConfigBuilder

      public YamlClientConfigBuilder​(URL url) throws IOException
      Throws:
      IOException
    • YamlClientConfigBuilder

      public YamlClientConfigBuilder​(InputStream in)
    • YamlClientConfigBuilder

      public YamlClientConfigBuilder()
      Loads the client config using the following resolution mechanism:
      1. first it checks if a system property 'hazelcast.client.config' is set. If it exist and it begins with 'classpath:', then a classpath resource is loaded. Else it will assume it is a file reference. The configuration file or resource will be loaded only if the postfix of its name ends with `.yaml`.
      2. it checks if a hazelcast-client.yaml is available in the working dir
      3. it checks if a hazelcast-client.yaml is available on the classpath
      4. it loads the hazelcast-client-default.yaml
    • YamlClientConfigBuilder

      @PrivateApi public YamlClientConfigBuilder​(com.hazelcast.client.config.impl.YamlClientConfigLocator locator)
      Constructs a YamlClientConfigBuilder that loads the configuration with the provided YamlClientConfigLocator.

      If the provided YamlClientConfigLocator is null, a new instance is created and the config is located in every possible places. For these places, please see YamlClientConfigLocator.

      If the provided YamlClientConfigLocator is not null, it is expected that it already located the configuration YAML to load from. No further attempt to locate the configuration YAML is made if the configuration YAML is not located already.

      Parameters:
      locator - the configured locator to use
  • Method Details