org.bitsofinfo.hazelcast.discovery.consul

Class BaseRegistrator

java.lang.Object

org.bitsofinfo.hazelcast.discovery.consul.BaseRegistrator

All Implemented Interfaces:

ConsulRegistrator

Direct Known Subclasses:

ExplicitIpPortRegistrator, LocalDiscoveryNodeRegistrator

public abstract class BaseRegistrator
extends java.lang.Object
implements ConsulRegistrator

Use derivatives of this ConsulRegistrator if you don't have or don't want to run a separate Consul agent process on the same box where this hazelcast enabled application runs. This ConsulRegistrator will register this hazelcast instance with Consul as a service and also optional configure a health-check script if you defined it. The IP/PORT that it registers with is generally dictated by classes that derive from this class and override the determineMyLocalAddress() method. It will also de-register the service if invoked to do so. Common custom options (specified as JSON value for the 'consul-registrator-config') which are available to all derivative classes - healthCheckScript: can be anything you want Consul to do to determine health. Variables #MYIP/#MYPORT will be replaced. https://www.consul.io/docs/agent/checks.html - healthCheckScriptIntervalSeconds: self explanatory - healthCheckHttp: valid hostname and port to use for health check. You can provide optional path to a specific script. - healthCheckHttpIntervalSeconds: self explanatory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_PROP_HEALTH_CHECK_PROVIDER
protected java.lang.String	consulAclToken
protected java.lang.String	consulHost
protected java.lang.Integer	consulPort
protected java.lang.String	consulServiceName
protected com.hazelcast.logging.ILogger	logger
protected com.hazelcast.nio.Address	myLocalAddress
protected java.util.Map<java.lang.String,java.lang.Object>	registratorConfig
protected java.lang.String[]	tags

Constructor Summary

Constructors

Constructor and Description
BaseRegistrator()

Method Summary

Modifier and Type	Method and Description
void	deregister() Deregister this hazelcast instance as a service node with Consul
protected abstract com.hazelcast.nio.Address	determineMyLocalAddress(com.hazelcast.spi.discovery.DiscoveryNode localDiscoveryNode, java.util.Map<java.lang.String,java.lang.Object> registratorConfig)
java.lang.String	getMyServiceId() Return the service id as registered with Consul
void	init(java.lang.String consulHost, java.lang.Integer consulPort, java.lang.String consulServiceName, java.lang.String[] consulTags, java.lang.String consulAclToken, boolean consulSslEnabled, java.lang.String consulSslServerCertFilePath, java.lang.String consulSslServerCertBase64, boolean consulServerHostnameVerify, com.hazelcast.spi.discovery.DiscoveryNode localDiscoveryNode, java.util.Map<java.lang.String,java.lang.Object> registratorConfig, com.hazelcast.logging.ILogger logger) Initialize the registrator
void	register() Register this hazelcast instance as a service node with Consul

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PROP_HEALTH_CHECK_PROVIDER

public static final java.lang.String CONFIG_PROP_HEALTH_CHECK_PROVIDER

See Also:

Constant Field Values

logger

protected com.hazelcast.logging.ILogger logger

myLocalAddress

protected com.hazelcast.nio.Address myLocalAddress

tags

protected java.lang.String[] tags

consulServiceName

protected java.lang.String consulServiceName

consulHost

protected java.lang.String consulHost

consulPort

protected java.lang.Integer consulPort

consulAclToken

protected java.lang.String consulAclToken

registratorConfig

protected java.util.Map<java.lang.String,java.lang.Object> registratorConfig

Constructor Detail

BaseRegistrator

public BaseRegistrator()

Method Detail

determineMyLocalAddress

protected abstract com.hazelcast.nio.Address determineMyLocalAddress(com.hazelcast.spi.discovery.DiscoveryNode localDiscoveryNode,
                                                                     java.util.Map<java.lang.String,java.lang.Object> registratorConfig)
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

init

public void init(java.lang.String consulHost,
                 java.lang.Integer consulPort,
                 java.lang.String consulServiceName,
                 java.lang.String[] consulTags,
                 java.lang.String consulAclToken,
                 boolean consulSslEnabled,
                 java.lang.String consulSslServerCertFilePath,
                 java.lang.String consulSslServerCertBase64,
                 boolean consulServerHostnameVerify,
                 com.hazelcast.spi.discovery.DiscoveryNode localDiscoveryNode,
                 java.util.Map<java.lang.String,java.lang.Object> registratorConfig,
                 com.hazelcast.logging.ILogger logger)
          throws java.lang.Exception

Description copied from interface: ConsulRegistrator

Initialize the registrator

Specified by:

init in interface ConsulRegistrator

Throws:

java.lang.Exception

getMyServiceId

public java.lang.String getMyServiceId()

Description copied from interface: ConsulRegistrator

Return the service id as registered with Consul

Specified by:

getMyServiceId in interface ConsulRegistrator

Returns:

register

public void register()
              throws java.lang.Exception

Description copied from interface: ConsulRegistrator

Register this hazelcast instance as a service node with Consul

Specified by:

register in interface ConsulRegistrator

Throws:

java.lang.Exception

deregister

public void deregister()
                throws java.lang.Exception

Description copied from interface: ConsulRegistrator

Deregister this hazelcast instance as a service node with Consul

Specified by:

deregister in interface ConsulRegistrator

Throws:

java.lang.Exception