io.micronaut.discovery.aws.route53.registration

Class Route53AutoNamingRegistrationClient

java.lang.Object

io.micronaut.discovery.registration.AutoRegistration

io.micronaut.discovery.client.registration.DiscoveryServiceAutoRegistration

io.micronaut.discovery.aws.route53.registration.Route53AutoNamingRegistrationClient

All Implemented Interfaces:

ApplicationEventListener<AbstractServiceInstanceEvent>, EventListener

@Singleton
 @Requires(classes=com.amazonaws.services.servicediscovery.AWSServiceDiscovery.class) @Requires(env="ec2") @Requires(beans=Route53AutoRegistrationConfiguration.class) @Requires(property="aws.route53.registration.enabled",value="true",defaultValue="false") @Requires(property="micronaut.application.name")
public class Route53AutoNamingRegistrationClient
extends DiscoveryServiceAutoRegistration

An implementation of DiscoveryServiceAutoRegistration for Route 53.

Since:

1.0

Author:

Rvanderwerf, graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	AWS_ALIAS_DNS_NAME Constant for AWS alias dns name.
static String	AWS_INSTANCE_CNAME Constant for AWS instance cname.
static String	AWS_INSTANCE_IPV4 Constant for AWS intance IPv4.
static String	AWS_INSTANCE_IPV6 Constant for AWS instance IPv6.
static String	AWS_INSTANCE_PORT Constant for AWS instance port.
static String	ENABLED Constant for whether route 53 registration is enabled.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Route53AutoNamingRegistrationClient(Environment environment, Route53AutoRegistrationConfiguration route53AutoRegistrationConfiguration, io.micronaut.configuration.aws.AWSClientConfiguration clientConfiguration, AmazonComputeInstanceMetadataResolver amazonComputeInstanceMetadataResolver, Executor executorService, AWSServiceDiscoveryResolver awsServiceDiscoveryResolver) Constructor for setup.

Method Summary

Modifier and Type	Method and Description
String	createNamespace(String name) This is a helper method for integration tests to create a new namespace.
String	createService(com.amazonaws.services.servicediscovery.AWSServiceDiscovery serviceDiscovery, String name, String description, String namespaceId, Long ttl) Create service, helper for integration tests.
void	deleteNamespace(String namespaceId) these are convenience methods to help cleanup things like integration test data.
void	deleteService(String serviceId) These are convenience methods to help cleanup things like integration test data.
protected void	deregister(ServiceInstance instance) shutdown instance if it fails health check can gracefully stop.
com.amazonaws.services.servicediscovery.AWSServiceDiscoveryAsync	getDiscoveryClient() Gets the discovery client Impl for easier testing.
com.amazonaws.services.servicediscovery.model.Service	getDiscoveryService() Gets the discovery service used on route53.
protected void	pulsate(ServiceInstance instance, HealthStatus status) If custom health check is enabled, this sends a heartbeat to it.
protected void	register(ServiceInstance instance) register new instance to the service registry.
void	setDiscoveryService(com.amazonaws.services.servicediscovery.model.Service discoveryService) Used for testing.

Methods inherited from class io.micronaut.discovery.client.registration.DiscoveryServiceAutoRegistration

getErrorMessage, performDeregistration, performRegistration

Methods inherited from class io.micronaut.discovery.registration.AutoRegistration

onApplicationEvent, validateApplicationName, validateName

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.context.event.ApplicationEventListener

supports

Field Detail

AWS_INSTANCE_PORT

public static final String AWS_INSTANCE_PORT

Constant for AWS instance port.

See Also:

Constant Field Values

AWS_INSTANCE_IPV4

public static final String AWS_INSTANCE_IPV4

Constant for AWS intance IPv4.

See Also:

Constant Field Values

AWS_INSTANCE_CNAME

public static final String AWS_INSTANCE_CNAME

Constant for AWS instance cname.

See Also:

Constant Field Values

AWS_INSTANCE_IPV6

public static final String AWS_INSTANCE_IPV6

Constant for AWS instance IPv6.

See Also:

Constant Field Values

AWS_ALIAS_DNS_NAME

public static final String AWS_ALIAS_DNS_NAME

Constant for AWS alias dns name.

See Also:

Constant Field Values

ENABLED

public static final String ENABLED

Constant for whether route 53 registration is enabled.

See Also:

Constant Field Values

Constructor Detail

Route53AutoNamingRegistrationClient

protected Route53AutoNamingRegistrationClient(Environment environment,
                                              Route53AutoRegistrationConfiguration route53AutoRegistrationConfiguration,
                                              io.micronaut.configuration.aws.AWSClientConfiguration clientConfiguration,
                                              AmazonComputeInstanceMetadataResolver amazonComputeInstanceMetadataResolver,
                                              @Named(value="io")
                                              Executor executorService,
                                              AWSServiceDiscoveryResolver awsServiceDiscoveryResolver)

Constructor for setup.

Parameters:

environment - current environemnts

route53AutoRegistrationConfiguration - config for auto registration

clientConfiguration - general client configuraiton

amazonComputeInstanceMetadataResolver - resolver for aws compute metdata

executorService - this is for executing the thread to monitor the register operation for completion

awsServiceDiscoveryResolver - this allows is to swap out the bean for a mock version for unit testing

Method Detail

pulsate

protected void pulsate(ServiceInstance instance,
                       HealthStatus status)

If custom health check is enabled, this sends a heartbeat to it. In most cases aws monitoring works off polling an application's endpoint

Specified by:

pulsate in class AutoRegistration

Parameters:

instance - The instance of the service

status - The HealthStatus

deregister

protected void deregister(ServiceInstance instance)

shutdown instance if it fails health check can gracefully stop.

Specified by:

deregister in class AutoRegistration

Parameters:

instance - The ServiceInstance

register

protected void register(ServiceInstance instance)

register new instance to the service registry.

Specified by:

register in class AutoRegistration

Parameters:

instance - The ServiceInstance

deleteService

public void deleteService(String serviceId)

These are convenience methods to help cleanup things like integration test data.

Parameters:

serviceId - service id from AWS to delete

deleteNamespace

public void deleteNamespace(String namespaceId)

these are convenience methods to help cleanup things like integration test data.

Parameters:

namespaceId - namespace ID from AWS to delete

createNamespace

public String createNamespace(String name)

This is a helper method for integration tests to create a new namespace. Normally you would do this yourself with your own domain/subdomain on route53.

Parameters:

name - name of the namespace in your route53

Returns:

id of the namespace

createService

public String createService(com.amazonaws.services.servicediscovery.AWSServiceDiscovery serviceDiscovery,
                            String name,
                            String description,
                            String namespaceId,
                            Long ttl)

Create service, helper for integration tests.

Parameters:

serviceDiscovery - service discovery instance

name - name of the service

description - description of the service

namespaceId - namespaceId to attach it to (get via cli or api call)

ttl - time to live for checking pulse

Returns:

serviceId

getDiscoveryClient

public com.amazonaws.services.servicediscovery.AWSServiceDiscoveryAsync getDiscoveryClient()

Gets the discovery client Impl for easier testing.

Returns:

interface to communicate with AWS (or fake it)

getDiscoveryService

public com.amazonaws.services.servicediscovery.model.Service getDiscoveryService()

Gets the discovery service used on route53. This to check to see if it has custom health checks.

Returns:

service used to register instances to or get instances from

setDiscoveryService

public void setDiscoveryService(com.amazonaws.services.servicediscovery.model.Service discoveryService)

Used for testing.

Parameters:

discoveryService - service reference on route53 on AWS