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

Interface AliveEndpointCfgClient

All Superinterfaces:

ConfigurationClient, HttpEndpointCfgClient

public interface AliveEndpointCfgClient
extends HttpEndpointCfgClient

A client-side interface for reading and modifying 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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends AliveEndpointCfgClient,? extends AliveEndpointCfg>	definition()	Get the configuration definition associated with this Alive HTTP endpoint.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.HttpEndpointCfgClient

getAuthorizationMechanism, getBasePath, isEnabled, setAuthorizationMechanism, setBasePath, setEnabled

Method Details

definition

ManagedObjectDefinition<? extends AliveEndpointCfgClient,? extends AliveEndpointCfg> definition()

Get the configuration definition associated with this Alive HTTP endpoint.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HttpEndpointCfgClient

Returns:

Returns the configuration definition associated with this Alive HTTP endpoint.

getJavaClass

@MandatoryProperty
ValueOrExpression<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 HttpEndpointCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Alive HTTP endpoint implementation.

Specified by:

setJavaClass in interface HttpEndpointCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.