Package com.github.robtimus.connect.sdk.java.springboot.actuator

Class ConnectionsEndpoint

java.lang.Object

com.github.robtimus.connect.sdk.java.springboot.actuator.ConnectionsEndpoint

@Endpoint(id="connectSdkConnections",
          enableByDefault=false)
public class ConnectionsEndpoint
extends Object

An Endpoint for managing connections in connect-sdk-java.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConnectionsEndpoint.BeanNotCloseableException
static class	ConnectionsEndpoint.CloseableBeans
static enum	ConnectionsEndpoint.CloseableConnectionState

Constructor Summary

Constructors

Constructor	Description
ConnectionsEndpoint(ApplicationContext context, long defaultIdleTimeInMillis)

Method Summary

Modifier and Type	Method	Description
void	closeConnections(Duration idleTime, ConnectionsEndpoint.CloseableConnectionState state)	Closes all connections that are idle, expired or both for all PooledConnection, Communicator and Client beans.
void	closeConnectionsForBean(String beanName, Duration idleTime, ConnectionsEndpoint.CloseableConnectionState state)	Closes all connections that are idle, expired or both for a specific PooledConnection, Communicator and Client bean.
ConnectionsEndpoint.CloseableBeans	listCloseableBeans()

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectionsEndpoint

public ConnectionsEndpoint(ApplicationContext context,
 long defaultIdleTimeInMillis)

Method Details

listCloseableBeans

@ReadOperation
public ConnectionsEndpoint.CloseableBeans listCloseableBeans()

Returns:

All PooledConnection, Communicator and Client beans.

closeConnections

@DeleteOperation
public void closeConnections(@Nullable
 Duration idleTime,
 @Nullable
 ConnectionsEndpoint.CloseableConnectionState state)

Closes all connections that are idle, expired or both for all PooledConnection, Communicator and Client beans.

Parameters:

idleTime - The idle time; ignored if close is ConnectionsEndpoint.CloseableConnectionState.EXPIRED.

state - ConnectionsEndpoint.CloseableConnectionState.IDLE to close all idle connections, ConnectionsEndpoint.CloseableConnectionState.EXPIRED to close all expired connections, or null to close all idle and expired connections.

Since:

3.8

closeConnectionsForBean

@DeleteOperation
public void closeConnectionsForBean(@Selector
 String beanName,
 @Nullable
 Duration idleTime,
 @Nullable
 ConnectionsEndpoint.CloseableConnectionState state)

Closes all connections that are idle, expired or both for a specific PooledConnection, Communicator and Client bean.

Parameters:

beanName - The name of the PooledConnection, Communicator or Client bean.

idleTime - The idle time; ignored if close is ConnectionsEndpoint.CloseableConnectionState.EXPIRED.

state - ConnectionsEndpoint.CloseableConnectionState.IDLE to close all idle connections, ConnectionsEndpoint.CloseableConnectionState.EXPIRED to close all expired connections, or null to close all idle and expired connections.

Since:

3.8