io microsphere spring cloud client service registry endpoint ServiceRegistrationEndpoint

ServiceRegistrationEndpoint

Type: Class | Module: microsphere-spring-cloud-commons | Package: io.microsphere.spring.cloud.client.service.registry.endpoint | Since: 1.0.0

Source: microsphere-spring-cloud-commons/src/main/java/io/microsphere/spring/cloud/client/service/registry/endpoint/ServiceRegistrationEndpoint.java

Overview

The Endpoint @Endpoint for Service Registration

Declaration

public class ServiceRegistrationEndpoint extends AbstractServiceRegistrationEndpoint

Author: Mercy

Version Information

• Introduced in: 1.0.0
• Current Project Version: 0.2.9-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version	Status
Java 17	✅ Compatible
Java 21	✅ Compatible
Java 25	✅ Compatible

Examples

Method Examples

start

// Via actuator HTTP GET to /actuator/serviceRegistration
ServiceRegistrationEndpoint endpoint = context.getBean(ServiceRegistrationEndpoint.class);
Map<String, Object> metadata = endpoint.metadata();
String appName = (String) metadata.get("application-name");

// Via actuator HTTP POST to /actuator/serviceRegistration
ServiceRegistrationEndpoint endpoint = context.getBean(ServiceRegistrationEndpoint.class);
boolean wasAlreadyRunning = endpoint.start();

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-spring-cloud-commons</artifactId>
    <version>${microsphere-spring-cloud.version}</version>
</dependency>

Tip: Use the BOM (microsphere-spring-cloud-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.spring.cloud.client.service.registry.endpoint.ServiceRegistrationEndpoint;

API Reference

Public Methods

Method	Description
start	Returns metadata about the current service registration, including application name,

Method Details

start

public boolean start()

Returns metadata about the current service registration, including application name, registration details, port, status, and running state. This is a read operation exposed via the /actuator/serviceRegistration endpoint.

Example Usage:

`// Via actuator HTTP GET to /actuator/serviceRegistration
ServiceRegistrationEndpoint endpoint = context.getBean(ServiceRegistrationEndpoint.class);
Map metadata = endpoint.metadata();
String appName = (String) metadata.get("application-name");
`

See Also

• AbstractAutoServiceRegistration
• Endpoint

---

This documentation was auto-generated from the source code of microsphere-spring-cloud.