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

Class HdapEndpointCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<HdapEndpointCfgClient,HdapEndpointCfg>
org.forgerock.opendj.server.config.meta.HdapEndpointCfgDefn
public final class HdapEndpointCfgDefn extends ManagedObjectDefinition<HdapEndpointCfgClient,HdapEndpointCfg>
An interface for querying the Hdap Endpoint managed object definition meta information.

The Hdap Endpoint provides a lightweight REST API for accessing all directory data.

  • Method Details

    • getInstance

      public static HdapEndpointCfgDefn getInstance()
      Get the Hdap Endpoint configuration definition singleton.
      Returns:
      Returns the Hdap Endpoint configuration definition singleton.

    • createClientConfiguration

      public HdapEndpointCfgClient createClientConfiguration(ManagedObject<? extends HdapEndpointCfgClient> 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<HdapEndpointCfgClient,HdapEndpointCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public HdapEndpointCfg createServerConfiguration(ServerManagedObject<? extends HdapEndpointCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<HdapEndpointCfgClient,HdapEndpointCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<HdapEndpointCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<HdapEndpointCfgClient,HdapEndpointCfg>
      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 Hdap 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 Hdap 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 Hdap Endpoint implementation.

      Returns:
      Returns the "java-class" property definition.

    • getReturnNullForMissingPropertiesPropertyDefinition

      public BooleanPropertyDefinition getReturnNullForMissingPropertiesPropertyDefinition()
      Get the "return-null-for-missing-properties" property definition.

      Indicates whether missing JSON properties should be included in JSON resources.

      By default JSON properties which are not present in the target LDAP entries are not included in JSON resources returned by the REST endpoint. Set this option to true if these JSON properties should be included. LDAP attributes that are defined as SINGLE-VALUE are returned as null, or as an empty array if not.

      Returns:
      Returns the "return-null-for-missing-properties" property definition.