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

Class HealthyEndpointCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>

org.forgerock.opendj.server.config.meta.HealthyEndpointCfgDefn

public final class HealthyEndpointCfgDefn
extends ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>

An interface for querying the Healthy HTTP endpoint managed object definition meta information.

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

Method Summary

Modifier and Type	Method	Description
HealthyEndpointCfgClient	createClientConfiguration(ManagedObject<? extends HealthyEndpointCfgClient> impl)	Creates a client configuration view of the provided managed object.
HealthyEndpointCfg	createServerConfiguration(ServerManagedObject<? extends HealthyEndpointCfg> impl)	Creates a server configuration view of the provided server managed object.
AggregationPropertyDefinition<HttpAuthorizationMechanismCfgClient,HttpAuthorizationMechanismCfg>	getAuthorizationMechanismPropertyDefinition()	Get the "authorization-mechanism" property definition.
StringPropertyDefinition	getBasePathPropertyDefinition()	Get the "base-path" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static HealthyEndpointCfgDefn	getInstance()	Get the Healthy HTTP endpoint configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<HealthyEndpointCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static HealthyEndpointCfgDefn getInstance()

Get the Healthy HTTP endpoint configuration definition singleton.

Returns:

Returns the Healthy HTTP endpoint configuration definition singleton.

createClientConfiguration

public HealthyEndpointCfgClient createClientConfiguration(ManagedObject<? extends HealthyEndpointCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public HealthyEndpointCfg createServerConfiguration(ServerManagedObject<? extends HealthyEndpointCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<HealthyEndpointCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAuthorizationMechanismPropertyDefinition

public AggregationPropertyDefinition<HttpAuthorizationMechanismCfgClient,HttpAuthorizationMechanismCfg> getAuthorizationMechanismPropertyDefinition()

Get the "authorization-mechanism" property definition.

The HTTP authorization mechanisms supported by this Healthy HTTP endpoint.

Returns:

Returns the "authorization-mechanism" property definition.

getBasePathPropertyDefinition

public StringPropertyDefinition getBasePathPropertyDefinition()

Get the "base-path" property definition.

All HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found.

Returns:

Returns the "base-path" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Healthy HTTP endpoint is enabled.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.