Class ConsulAutoRegistration

java.lang.Object

org.springframework.cloud.consul.serviceregistry.ConsulRegistration

org.springframework.cloud.consul.serviceregistry.ConsulAutoRegistration

All Implemented Interfaces:

org.springframework.cloud.client.ServiceInstance, org.springframework.cloud.client.serviceregistry.Registration

public class ConsulAutoRegistration
extends ConsulRegistration

Author:

Spencer Gibb

Field Summary

Fields

Modifier and Type	Field	Description
static final char	SEPARATOR	Instance ID separator.

Constructor Summary

Constructors

Constructor	Description
ConsulAutoRegistration(org.springframework.cloud.consul.model.http.agent.NewService service, org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties, ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context, HeartbeatProperties heartbeatProperties)	Deprecated.
ConsulAutoRegistration(org.springframework.cloud.consul.model.http.agent.NewService service, org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties, ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context, HeartbeatProperties heartbeatProperties, List<ConsulManagementRegistrationCustomizer> managementRegistrationCustomizers)

Method Summary

Modifier and Type	Method	Description
static org.springframework.cloud.consul.model.http.agent.NewService.Check	createCheck(Integer port, HeartbeatProperties ttlConfig, ConsulDiscoveryProperties properties)
static void	customize(List<ConsulRegistrationCustomizer> registrationCustomizers, ConsulAutoRegistration registration)
static String	getAppName(ConsulDiscoveryProperties properties, org.springframework.core.env.Environment env)
static String	getInstanceId(ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context)
static Integer	getManagementPort(ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context)
static String	getManagementServiceId(ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context)
static String	getManagementServiceName(ConsulDiscoveryProperties properties, org.springframework.core.env.Environment env)
void	initializePort(int knownPort)
static void	managementCustomize(List<ConsulManagementRegistrationCustomizer> registrationCustomizers, ConsulAutoRegistration registration)
ConsulAutoRegistration	managementRegistration()
static ConsulAutoRegistration	managementRegistration(org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties, ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context, List<ConsulManagementRegistrationCustomizer> managementRegistrationCustomizers, HeartbeatProperties heartbeatProperties)
static String	normalizeForDns(String s)
static ConsulAutoRegistration	registration(org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties, ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context, List<ConsulRegistrationCustomizer> registrationCustomizers, List<ConsulManagementRegistrationCustomizer> managementRegistrationCustomizers, HeartbeatProperties heartbeatProperties)
static void	setCheck(org.springframework.cloud.consul.model.http.agent.NewService service, org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties, ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context, HeartbeatProperties heartbeatProperties)
static boolean	shouldRegisterManagement(org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties, ConsulDiscoveryProperties properties, org.springframework.context.ApplicationContext context)

Methods inherited from class ConsulRegistration

getHost, getInstanceId, getMetadata, getPort, getProperties, getService, getServiceId, getUri, isSecure

Methods inherited from class Object

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

Methods inherited from interface org.springframework.cloud.client.ServiceInstance

getScheme

Field Details

SEPARATOR

public static final char SEPARATOR

Instance ID separator.

See Also:

• Constant Field Values

Constructor Details

ConsulAutoRegistration

@Deprecated
public ConsulAutoRegistration(org.springframework.cloud.consul.model.http.agent.NewService service,
 org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties,
 ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context,
 HeartbeatProperties heartbeatProperties)

Deprecated.

ConsulAutoRegistration

public ConsulAutoRegistration(org.springframework.cloud.consul.model.http.agent.NewService service,
 org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties,
 ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context,
 HeartbeatProperties heartbeatProperties,
 List<ConsulManagementRegistrationCustomizer> managementRegistrationCustomizers)

Method Details

registration

public static ConsulAutoRegistration registration(org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties,
 ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context,
 List<ConsulRegistrationCustomizer> registrationCustomizers,
 List<ConsulManagementRegistrationCustomizer> managementRegistrationCustomizers,
 HeartbeatProperties heartbeatProperties)

customize

public static void customize(List<ConsulRegistrationCustomizer> registrationCustomizers,
 ConsulAutoRegistration registration)

setCheck

public static void setCheck(org.springframework.cloud.consul.model.http.agent.NewService service,
 org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties,
 ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context,
 HeartbeatProperties heartbeatProperties)

managementRegistration

public static ConsulAutoRegistration managementRegistration(org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties,
 ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context,
 List<ConsulManagementRegistrationCustomizer> managementRegistrationCustomizers,
 HeartbeatProperties heartbeatProperties)

managementCustomize

public static void managementCustomize(List<ConsulManagementRegistrationCustomizer> registrationCustomizers,
 ConsulAutoRegistration registration)

getInstanceId

public static String getInstanceId(ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context)

normalizeForDns

public static String normalizeForDns(String s)

createCheck

public static org.springframework.cloud.consul.model.http.agent.NewService.Check createCheck(Integer port,
 HeartbeatProperties ttlConfig,
 ConsulDiscoveryProperties properties)

getAppName

public static String getAppName(ConsulDiscoveryProperties properties,
 org.springframework.core.env.Environment env)

Parameters:

properties - consul discovery properties

env - Spring environment

Returns:

the app name, currently the spring.application.name property

shouldRegisterManagement

public static boolean shouldRegisterManagement(org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties autoServiceRegistrationProperties,
 ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context)

Parameters:

autoServiceRegistrationProperties - registration properties

properties - discovery properties

context - Spring application context

Returns:

if the management service should be registered with the ServiceRegistry

getManagementServiceId

public static String getManagementServiceId(ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context)

Parameters:

properties - discovery properties

context - Spring application context

Returns:

the serviceId of the Management Service

getManagementServiceName

public static String getManagementServiceName(ConsulDiscoveryProperties properties,
 org.springframework.core.env.Environment env)

Parameters:

properties - discovery properties

env - Spring environment

Returns:

the service name of the Management Service

getManagementPort

public static Integer getManagementPort(ConsulDiscoveryProperties properties,
 org.springframework.context.ApplicationContext context)

Parameters:

properties - discovery properties

context - Spring application context

Returns:

the port of the Management Service

initializePort

public void initializePort(int knownPort)

managementRegistration

public ConsulAutoRegistration managementRegistration()