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

Interface HTTPEndpointCfg

    • Method Detail

      • configurationClass

        Class<? extends HTTPEndpointCfg> configurationClass()
        Gets the configuration class associated with this HTTP Endpoint.
        Specified by:
        configurationClass in interface Configuration
        Returns:
        Returns the configuration class associated with this HTTP Endpoint.

      • addChangeListener

        void addChangeListener​(ConfigurationChangeListener<HTTPEndpointCfg> listener)
        Register to be notified when this HTTP Endpoint is changed.
        Parameters:
        listener - The HTTP Endpoint configuration change listener.

      • removeChangeListener

        void removeChangeListener​(ConfigurationChangeListener<HTTPEndpointCfg> listener)
        Deregister an existing HTTP Endpoint configuration change listener.
        Parameters:
        listener - The HTTP Endpoint configuration change listener.

      • getAuthorizationMechanism

        SortedSet<String> getAuthorizationMechanism()
        Gets the "authorization-mechanism" property.

        The HTTP authorization mechanisms supported by this HTTP Endpoint.

        Returns:
        Returns an unmodifiable set containing the values of the "authorization-mechanism" property.

      • getAuthorizationMechanismDNs

        SortedSet<org.forgerock.opendj.ldap.DN> getAuthorizationMechanismDNs()
        Gets the "authorization-mechanism" property as a set of DNs.

        The HTTP authorization mechanisms supported by this HTTP Endpoint.

        Returns:
        Returns the DN values of the "authorization-mechanism" property.

      • getBasePath

        String getBasePath()
        Gets the "base-path" property.

        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 value of the "base-path" property.

      • isEnabled

        boolean isEnabled()
        Gets the "enabled" property.

        Indicates whether the HTTP Endpoint is enabled.

        Returns:
        Returns the value of the "enabled" property.

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

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

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