Interface AdminEndpointCfgClient
-
- All Superinterfaces:
ConfigurationClient
,HttpEndpointCfgClient
public interface AdminEndpointCfgClient extends HttpEndpointCfgClient
A client-side interface for reading and modifying Admin Endpoint settings.The Admin Endpoint provides RESTful access to OpenDJ's monitoring and configuration backends.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagedObjectDefinition<? extends AdminEndpointCfgClient,? extends AdminEndpointCfg>
definition()
Get the configuration definition associated with this Admin Endpoint.ValueOrExpression<String>
getJavaClass()
Gets the "java-class" property.void
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
Methods inherited from interface org.forgerock.opendj.server.config.client.HttpEndpointCfgClient
getAuthorizationMechanism, getBasePath, isEnabled, setAuthorizationMechanism, setBasePath, setEnabled
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends AdminEndpointCfgClient,? extends AdminEndpointCfg> definition()
Get the configuration definition associated with this Admin Endpoint.- Specified by:
definition
in interfaceConfigurationClient
- Specified by:
definition
in interfaceHttpEndpointCfgClient
- Returns:
- Returns the configuration definition associated with this Admin Endpoint.
-
getJavaClass
@MandatoryProperty ValueOrExpression<String> getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the Admin Endpoint implementation.
Default value:
org.opends.server.protocols.http.rest2ldap.AdminEndpoint
- Specified by:
getJavaClass
in interfaceHttpEndpointCfgClient
- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
@MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Sets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the Admin Endpoint implementation.
- Specified by:
setJavaClass
in interfaceHttpEndpointCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
-