Package org.springframework.geode.core.env.support

Class CloudCacheService

java.lang.Object
org.springframework.geode.core.env.support.Service
org.springframework.geode.core.env.support.CloudCacheService
public class CloudCacheService extends Service
The CloudCacheService class is an Abstract Data Type (ADT) modeling the Pivotal Cloud Cache service in Pivotal CloudFoundry (PCF).
Since:
1.0.0
See Also:

  • Method Details

    • with

      public static CloudCacheService with(String name)
      Factory method used to construct a new CloudCacheService initialized with the given name.
      Parameters:
      name - String containing the name of the CloudCacheService.
      Returns:
      the new CloudCacheService with the given name.
      Throws:
      IllegalArgumentException - if the name is null or empty.
      See Also:
      • CloudCacheService(String)

    • getGfshUrl

      public Optional<URL> getGfshUrl()
      Returns an Optional Gfsh URL if configured, used to connect to Apache Geode's Management REST API (service).
      Returns:
      an Optional Gfsh URL used to connect to Apache Geode's Management REST API (service).
      See Also:

    • getLocators

      public Optional<String> getLocators()
      Returns an Optional String containing the list of Apache Geode Locator network endpoints. The format of the String, if present, is host1[port1],host2[port2], ...,hostN[portN].
      Returns:
      an Optional String containing the list of Apache Geode Locator network endpoints.
      See Also:

    • getLocatorList

      public List<CloudCacheService.Locator> getLocatorList()
      Returns a List of Apache Geode Locator network endpoints. Returns an empty List if no Locators were configured.
      Returns:
      a List of Apache Geode Locator network endpoints.
      See Also:

    • isTlsEnabled

      public boolean isTlsEnabled()
      Returns a Boolean determining whether TLS/SSL is enabled between the client and the Pivotal Cloud Cache (PCC) service instance in Pivotal CloudFoundry (PCF).
      Returns:
      true if TLS is enabled, false if not.

    • withGfshUrl

      public CloudCacheService withGfshUrl(URL gfshUrl)
      Builder method used to configure the Gfsh URL to connect to the Apache Geode Management REST API (service).
      Parameters:
      gfshUrl - URL used to connect to the Apache Geode Management REST API (service).
      Returns:
      this CloudCacheService.
      See Also:

    • withLocators

      public CloudCacheService withLocators(String locators)
      Builder method used to configure the list of Locator network endpoints.
      Parameters:
      locators - String containing a comma-delimited list of Locator network endpoints of the format: host1[port1],host2[port2], ...,hostN[portN].
      Returns:
      this CloudCacheService.
      See Also:

    • withTls

      public CloudCacheService withTls(Boolean enabled)
      Builder method used to configure whether TLS/SSL is enabled between a client and the Pivotal Cloud Cache (PCC) service instance in Pivotal CloudFoundry (PCF).
      Parameters:
      enabled - Boolean value indicating whether TLS/SSL is enabled.
      Returns:
      this CloudCacheService.
      See Also: