org.forgerock.opendj.server.config.server

Interface AdminEndpointCfg

All Superinterfaces:

Configuration, HTTPEndpointCfg

public interface AdminEndpointCfg
extends HTTPEndpointCfg

A server-side interface for querying Admin Endpoint settings.

The Admin Endpoint provides RESTful access to OpenDJ's monitoring and configuration backends.

Method Summary

Modifier and Type	Method and Description
void	addAdminEndpointChangeListener(ConfigurationChangeListener<AdminEndpointCfg> listener) Register to be notified when this Admin Endpoint is changed.
Class<? extends AdminEndpointCfg>	configurationClass() Gets the configuration class associated with this Admin Endpoint.
String	getJavaClass() Gets the "java-class" property.
void	removeAdminEndpointChangeListener(ConfigurationChangeListener<AdminEndpointCfg> listener) Deregister an existing Admin Endpoint configuration change listener.

Methods inherited from interface org.forgerock.opendj.server.config.server.HTTPEndpointCfg

addChangeListener, getAuthorizationMechanism, getAuthorizationMechanismDNs, getBasePath, isEnabled, removeChangeListener

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Method Detail

configurationClass

Class<? extends AdminEndpointCfg> configurationClass()

Gets the configuration class associated with this Admin Endpoint.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HTTPEndpointCfg

Returns:

Returns the configuration class associated with this Admin Endpoint.

addAdminEndpointChangeListener

void addAdminEndpointChangeListener(ConfigurationChangeListener<AdminEndpointCfg> listener)

Register to be notified when this Admin Endpoint is changed.

Parameters:

listener - The Admin Endpoint configuration change listener.

removeAdminEndpointChangeListener

void removeAdminEndpointChangeListener(ConfigurationChangeListener<AdminEndpointCfg> listener)

Deregister an existing Admin Endpoint configuration change listener.

Parameters:

listener - The Admin Endpoint configuration change listener.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface HTTPEndpointCfg

Returns:

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