Package org.forgerock.opendj.server.config.server

Interface HealthyEndpointCfg

All Superinterfaces:

Configuration, HttpEndpointCfg

public interface HealthyEndpointCfg
extends HttpEndpointCfg

A server-side interface for querying Healthy HTTP endpoint settings.

The Healthy HTTP endpoint provides a way to check whether the server is able to handle requests.

Method Summary

Modifier and Type	Method	Description
void	addHealthyEndpointChangeListener(ConfigurationChangeListener<HealthyEndpointCfg> listener)	Register to be notified when this Healthy HTTP endpoint is changed.
Class<? extends HealthyEndpointCfg>	configurationClass()	Gets the configuration class associated with this Healthy HTTP endpoint.
String	getJavaClass()	Gets the "java-class" property.
void	removeHealthyEndpointChangeListener(ConfigurationChangeListener<HealthyEndpointCfg> listener)	Deregister an existing Healthy 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 HealthyEndpointCfg> configurationClass()

Gets the configuration class associated with this Healthy HTTP endpoint.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HttpEndpointCfg

Returns:

Returns the configuration class associated with this Healthy HTTP endpoint.

addHealthyEndpointChangeListener

void addHealthyEndpointChangeListener(ConfigurationChangeListener<HealthyEndpointCfg> listener)

Register to be notified when this Healthy HTTP endpoint is changed.

Parameters:

listener - The Healthy HTTP endpoint configuration change listener.

removeHealthyEndpointChangeListener

void removeHealthyEndpointChangeListener(ConfigurationChangeListener<HealthyEndpointCfg> listener)

Deregister an existing Healthy HTTP endpoint configuration change listener.

Parameters:

listener - The Healthy 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 Healthy HTTP endpoint implementation.

Default value: org.opends.server.protocols.http.HealthyEndpoint

Specified by:

getJavaClass in interface HttpEndpointCfg

Returns:

Returns the value of the "java-class" property.