Interface HttpEndpointCfg
-
- All Superinterfaces:
Configuration
- All Known Subinterfaces:
AdminEndpointCfg
,AliveEndpointCfg
,CrestMetricsEndpointCfg
,HealthyEndpointCfg
,PrometheusEndpointCfg
,Rest2ldapEndpointCfg
public interface HttpEndpointCfg extends Configuration
A server-side interface for querying HTTP Endpoint settings.The HTTP Endpoint is used to define HTTP endpoint.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addChangeListener(ConfigurationChangeListener<HttpEndpointCfg> listener)
Register to be notified when this HTTP Endpoint is changed.Class<? extends HttpEndpointCfg>
configurationClass()
Gets the configuration class associated with this HTTP Endpoint.SortedSet<String>
getAuthorizationMechanism()
Gets the "authorization-mechanism" property.SortedSet<Dn>
getAuthorizationMechanismDns()
Gets the "authorization-mechanism" property as a set of DNs.String
getBasePath()
Gets the "base-path" property.String
getJavaClass()
Gets the "java-class" property.boolean
isEnabled()
Gets the "enabled" property.void
removeChangeListener(ConfigurationChangeListener<HttpEndpointCfg> listener)
Deregister an existing HTTP Endpoint configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
-
-
-
Method Detail
-
configurationClass
Class<? extends HttpEndpointCfg> configurationClass()
Gets the configuration class associated with this HTTP Endpoint.- Specified by:
configurationClass
in interfaceConfiguration
- 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<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.
-
-