AliveEndpointCfg (OpenDJ Public API Javadoc 7.4.4-20250319151205-3e38ada61695e05f34ebbd799d03be9218ebe6be Documentation)

All Superinterfaces:

Configuration, HttpEndpointCfg
```
public interface AliveEndpointCfg
extends HttpEndpointCfg
```
A server-side interface for querying Alive HTTP endpoint settings.
The Alive HTTP endpoint provides a way to check whether the server is facing serious problems that need administrative actions to recover.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addAliveEndpointChangeListener(ConfigurationChangeListener<AliveEndpointCfg> listener)`	Register to be notified when this Alive HTTP endpoint is changed.
`Class<? extends AliveEndpointCfg>`	`configurationClass()`	Gets the configuration class associated with this Alive HTTP endpoint.
`String`	`getJavaClass()`	Gets the "java-class" property.
`void`	`removeAliveEndpointChangeListener(ConfigurationChangeListener<AliveEndpointCfg> listener)`	Deregister an existing Alive HTTP endpoint configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.HttpEndpointCfg
addChangeListener, getAuthorizationMechanism, getAuthorizationMechanismDns, getBasePath, isEnabled, removeChangeListener

- Method Detail
  - configurationClass
```
Class<? extends AliveEndpointCfg> configurationClass()
```
    Gets the configuration class associated with this Alive HTTP endpoint.
    
    Specified by:
    
    configurationClass in interface Configuration
    
    Specified by:
    
    configurationClass in interface HttpEndpointCfg
    
    Returns:
    
    Returns the configuration class associated with this Alive HTTP endpoint.
  - addAliveEndpointChangeListener
```
void addAliveEndpointChangeListener(ConfigurationChangeListener<AliveEndpointCfg> listener)
```
    Register to be notified when this Alive HTTP endpoint is changed.
    
    Parameters:
    
    listener - The Alive HTTP endpoint configuration change listener.
  - removeAliveEndpointChangeListener
```
void removeAliveEndpointChangeListener(ConfigurationChangeListener<AliveEndpointCfg> listener)
```
    Deregister an existing Alive HTTP endpoint configuration change listener.
    
    Parameters:
    
    listener - The Alive HTTP endpoint configuration change listener.
  - getJavaClass
```
String getJavaClass()
```
    Gets the "java-class" property.
    Specifies the fully-qualified name of the Java class that provides the Alive HTTP endpoint implementation.
    Default value: org.opends.server.protocols.http.AliveEndpoint
    
    Specified by:
    
    getJavaClass in interface HttpEndpointCfg
    
    Returns:
    
    Returns the value of the "java-class" property.