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

Class AliveEndpointCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<AliveEndpointCfgClient,AliveEndpointCfg>

org.forgerock.opendj.server.config.meta.AliveEndpointCfgDefn

public final class AliveEndpointCfgDefn
extends ManagedObjectDefinition<AliveEndpointCfgClient,AliveEndpointCfg>

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

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
AliveEndpointCfgClient	createClientConfiguration(ManagedObject<? extends AliveEndpointCfgClient> impl)	Creates a client configuration view of the provided managed object.
AliveEndpointCfg	createServerConfiguration(ServerManagedObject<? extends AliveEndpointCfg> 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 AliveEndpointCfgDefn	getInstance()	Get the Alive HTTP endpoint configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<AliveEndpointCfg>	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 AliveEndpointCfgDefn getInstance()

Get the Alive HTTP endpoint configuration definition singleton.

Returns:

Returns the Alive HTTP endpoint configuration definition singleton.

createClientConfiguration

public AliveEndpointCfgClient createClientConfiguration(ManagedObject<? extends AliveEndpointCfgClient> 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<AliveEndpointCfgClient,AliveEndpointCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<AliveEndpointCfgClient,AliveEndpointCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<AliveEndpointCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<AliveEndpointCfgClient,AliveEndpointCfg>

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 Alive 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 Alive 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 Alive HTTP endpoint implementation.

Returns:

Returns the "java-class" property definition.