public final class HealthyEndpointCfgDefn extends ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>
The Healthy HTTP endpoint provides a way to check whether the server is able to handle requests.
Modifier and Type | Method and 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.
|
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
public static HealthyEndpointCfgDefn getInstance()
public HealthyEndpointCfgClient createClientConfiguration(ManagedObject<? extends HealthyEndpointCfgClient> impl)
ManagedObjectDefinition
createClientConfiguration
in class ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>
impl
- The managed object.public HealthyEndpointCfg createServerConfiguration(ServerManagedObject<? extends HealthyEndpointCfg> impl)
ManagedObjectDefinition
createServerConfiguration
in class ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>
impl
- The server managed object.public Class<HealthyEndpointCfg> getServerConfigurationClass()
ManagedObjectDefinition
getServerConfigurationClass
in class ManagedObjectDefinition<HealthyEndpointCfgClient,HealthyEndpointCfg>
public AggregationPropertyDefinition<HttpAuthorizationMechanismCfgClient,HttpAuthorizationMechanismCfg> getAuthorizationMechanismPropertyDefinition()
The HTTP authorization mechanisms supported by this Healthy HTTP endpoint.
public StringPropertyDefinition getBasePathPropertyDefinition()
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.
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the Healthy HTTP endpoint is enabled.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the Healthy HTTP endpoint implementation.
Copyright 2010-2022 ForgeRock AS.