io.lettuce.core

Class MaintNotificationsConfig

java.lang.Object

io.lettuce.core.MaintNotificationsConfig

public class MaintNotificationsConfig
extends Object

Configuration options for Redis maintenance events notifications.

Maintenance events allow clients to receive push notifications about server-side maintenance operations (moving, failing over, migrating) to enable graceful handling of connection disruptions.

The options provided by this class are used by Lettuce to determine whether to listen for and process maintenance events, and configure requested endpoint type for maintenance notifications.

Usage Examples:

 
 {
     @code
     // Enable maintenance events with endpoint type automatically determined based on connection characteristics.
     MaintNotificationsConfig options = MaintNotificationsConfig.enabled();

     // Enable maintenance events and force endpoint to external IP addresses
     MaintNotificationsConfig options = MaintNotificationsConfig.enabled(EndpointType.EXTERNAL_IP);

     // Builder pattern
     MaintNotificationsConfig options = MaintNotificationsConfig.builder().enableMaintNotifications()
             .autoResolveEndpointType().build();
 }
 

See Also:

Redis Maintenance Events Specification

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaintNotificationsConfig.Builder
static class	MaintNotificationsConfig.EndpointType Endpoint types for maintenance event notifications.
static class	MaintNotificationsConfig.EndpointTypeSource Strategy interface for determining the endpoint address type to request in maintenance notifications.

Field Summary

Fields

Modifier and Type	Field and Description
static MaintNotificationsConfig.EndpointTypeSource	DEFAULT_ENDPOINT_TYPE_SOURCE
static boolean	DEFAULT_MAINT_NOTIFICATIONS_ENABLED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MaintNotificationsConfig(MaintNotificationsConfig.Builder builder)

Method Summary

Modifier and Type	Method and Description
static MaintNotificationsConfig.Builder	builder()
static MaintNotificationsConfig	create() Create a new instance of MaintNotificationsConfig with default settings.
static MaintNotificationsConfig	disabled() Creates MaintNotificationsConfig with disabled support for maintenance notifications.
static MaintNotificationsConfig	enabled() Creates MaintNotificationsConfig with enabled support for maintenance notifications.
static MaintNotificationsConfig	enabled(MaintNotificationsConfig.EndpointType endpointType) Creates maintenance events options with a fixed address type.
MaintNotificationsConfig.EndpointTypeSource	getEndpointTypeSource() Returns the endpoint type source used to determine the requested endpoint type.
boolean	maintNotificationsEnabled() Check if maintenance events are supported.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAINT_NOTIFICATIONS_ENABLED

public static final boolean DEFAULT_MAINT_NOTIFICATIONS_ENABLED

See Also:

Constant Field Values

DEFAULT_ENDPOINT_TYPE_SOURCE

public static final MaintNotificationsConfig.EndpointTypeSource DEFAULT_ENDPOINT_TYPE_SOURCE

Constructor Detail

MaintNotificationsConfig

protected MaintNotificationsConfig(MaintNotificationsConfig.Builder builder)

Method Detail

builder

public static MaintNotificationsConfig.Builder builder()

create

public static MaintNotificationsConfig create()

Create a new instance of MaintNotificationsConfig with default settings.

Returns:

a new instance of MaintNotificationsConfig with default settings.

disabled

public static MaintNotificationsConfig disabled()

Creates MaintNotificationsConfig with disabled support for maintenance notifications.

Client will not send MAIN_NOTIFICATIONS ON command and will not listen for maintenance notifications.

Returns:

disabled maintenance events options

enabled

public static MaintNotificationsConfig enabled()

Creates MaintNotificationsConfig with enabled support for maintenance notifications.

The maintenance notifications endpoint type is automatically determined based on connection characteristics.

Returns:

enabled options with auto-resolution

enabled

public static MaintNotificationsConfig enabled(MaintNotificationsConfig.EndpointType endpointType)

Creates maintenance events options with a fixed address type.

Always requests the specified endpoint type for maintenance notifications.

Parameters:

endpointType - the fixed endpoint type to request

Returns:

enabled options with fixed endpoint type

maintNotificationsEnabled

public boolean maintNotificationsEnabled()

Check if maintenance events are supported.

Returns:

true if maintenance events are supported

getEndpointTypeSource

public MaintNotificationsConfig.EndpointTypeSource getEndpointTypeSource()

Returns the endpoint type source used to determine the requested endpoint type.

The endpoint type source determines what MaintNotificationsConfig.EndpointType to request for maintenance notifications.

Returns:

the endpoint type source, or null if maintenance events are disabled