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:

URL, Service

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudCacheService.Locator

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.net.URL>	getGfshUrl() Returns an Optional Gfsh URL if configured, used to connect to Apache Geode's Management REST API (service).
java.util.List<CloudCacheService.Locator>	getLocatorList() Returns a List of Apache Geode Locator network endpoints.
java.util.Optional<java.lang.String>	getLocators() Returns an Optional String containing the list of Apache Geode Locator network endpoints.
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).
static CloudCacheService	with(java.lang.String name) Factory method used to construct a new CloudCacheService initialized with the given name.
CloudCacheService	withGfshUrl(java.net.URL gfshUrl) Builder method used to configure the Gfsh URL to connect to the Apache Geode Management REST API (service).
CloudCacheService	withLocators(java.lang.String locators) Builder method used to configure the list of Locator network endpoints.
CloudCacheService	withTls(java.lang.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).

Methods inherited from class org.springframework.geode.core.env.support.Service

getName, toString

Methods inherited from class java.lang.Object

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

Method Detail

with

public static CloudCacheService with(java.lang.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:

java.lang.IllegalArgumentException - if the name is null or empty.

See Also:

CloudCacheService(String)

getGfshUrl

public java.util.Optional<java.net.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:

withGfshUrl(URL), Optional, URL

getLocators

public java.util.Optional<java.lang.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:

withLocators(String)

getLocatorList

public java.util.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:

getLocators()

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(java.net.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:

getGfshUrl()

withLocators

public CloudCacheService withLocators(java.lang.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:

getLocators()

withTls

public CloudCacheService withTls(java.lang.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:

isTlsEnabled()