Package org.acemq.spring.boot.actuate

Class AceMqEndpoint

java.lang.Object

org.acemq.spring.boot.actuate.AceMqEndpoint

@Endpoint(id="acemq")
public class AceMqEndpoint
extends Object

The acemq actuator endpoint: every AceListener, its queue, whether it is running, and the counters its consumers keep.

• GET /actuator/acemq -- every listener, by id.
• GET /actuator/acemq/{id} -- one listener.
• POST /actuator/acemq/{id} with {"state": "stopped"} or {"state": "running"} -- stop or start it. Stopping drains: it waits up to acemq.listener.shutdown-timeout for the messages in flight, so the request can take that long. Starting checks that the queue exists first.

Write access is what Spring Boot grants any endpoint unless told otherwise; management.endpoint.acemq.access=read-only keeps the reads and refuses the writes. The endpoint is not exposed over HTTP until management.endpoints.web.exposure.include names it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AceMqEndpoint.Counters	A running listener's counters, from its consumer group.
static final record	AceMqEndpoint.ListenerDescriptor	One listener.
static final record	AceMqEndpoint.ListenersDescriptor	Every listener.

Constructor Summary

Constructors

Constructor	Description
AceMqEndpoint(AceListenerRegistry registry)

Method Summary

Modifier and Type	Method	Description
AceMqEndpoint.ListenerDescriptor	listener(String id)
AceMqEndpoint.ListenersDescriptor	listeners()
AceMqEndpoint.ListenerDescriptor	setState(String id, String state)	Starts or stops a listener.

Methods inherited from class java.lang.Object

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

Constructor Details

AceMqEndpoint

public AceMqEndpoint(AceListenerRegistry registry)

Method Details

listeners

@ReadOperation
public AceMqEndpoint.ListenersDescriptor listeners()

Returns:

every listener, by id

listener

@ReadOperation
public AceMqEndpoint.ListenerDescriptor listener(@Selector
 String id)

Parameters:

id - the listener id

Returns:

the listener, or null, which the endpoint answers with 404

setState

@WriteOperation
public AceMqEndpoint.ListenerDescriptor setState(@Selector
 String id,
 String state)

Starts or stops a listener.

Parameters:

id - the listener id

state - running or stopped

Returns:

the listener as it is now, or null (404) when there is no such listener