org.opends.server.replication.server

Class LightweightServerHandler

java.lang.Object

org.opends.server.api.MonitorProvider<MonitorProviderCfg>

org.opends.server.replication.server.LightweightServerHandler

public class LightweightServerHandler
extends MonitorProvider<MonitorProviderCfg>

This class defines a server handler dedicated to the remote LDAP servers connected to a remote Replication Server. This class is necessary because we want to provide monitor entries for them and because the monitor API only allows one entry by MonitorProvider instance so that no other class can provide the monitor entry for these objects. One instance of this class is created for each instance of remote LDAP server connected to a remote Replication Server.

Constructor Summary

Constructors

Constructor and Description
LightweightServerHandler(ReplicationServerHandler replServerHandler, DSInfo dsInfo) Creates a new LightweightServerHandler with the provided serverId, connected to the remote Replication Server represented by replServerHandler.

Method Summary

Methods

Modifier and Type	Method and Description
MonitorData	getMonitorData() Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.
String	getMonitorInstanceName() Retrieves the name of this monitor provider.
int	getServerId() Get the serverID associated with this LDAP server / directory server.
void	initializeMonitorProvider(MonitorProviderCfg configuration) Initializes this monitor provider based on the information in the provided configuration entry.
void	startHandler() Start this server handler processing.
void	stopHandler() Stop this server handler processing.
DSInfo	toDSInfo() Creates a DSInfo structure representing this remote DS.

Methods inherited from class org.opends.server.api.MonitorProvider

finalizeMonitorProvider, getMonitorObjectClass, isConfigurationAcceptable, scheduleUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LightweightServerHandler

public LightweightServerHandler(ReplicationServerHandler replServerHandler,
                        DSInfo dsInfo)

Creates a new LightweightServerHandler with the provided serverId, connected to the remote Replication Server represented by replServerHandler.

Parameters:

replServerHandler - The server handler of the RS this remote DS is connected to

dsInfo - all the info for the represented DS

Method Detail

toDSInfo

public DSInfo toDSInfo()

Creates a DSInfo structure representing this remote DS.

Returns:

The DSInfo structure representing this remote DS

getServerId

public int getServerId()

Get the serverID associated with this LDAP server / directory server.

Returns:

The serverId.

startHandler

public void startHandler()

Start this server handler processing.

stopHandler

public void stopHandler()

Stop this server handler processing.

initializeMonitorProvider

public void initializeMonitorProvider(MonitorProviderCfg configuration)
                               throws org.forgerock.opendj.config.server.ConfigException,
                                      InitializationException

Initializes this monitor provider based on the information in the provided configuration entry.

Overrides:

initializeMonitorProvider in class MonitorProvider<MonitorProviderCfg>

Parameters:

configuration - The configuration to use to initialize this monitor provider.

Throws:

org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

getMonitorInstanceName

public String getMonitorInstanceName()

Retrieves the name of this monitor provider. It should be unique among all monitor providers, including all instances of the same monitor provider.

Specified by:

getMonitorInstanceName in class MonitorProvider<MonitorProviderCfg>

Returns:

The name of this monitor provider.

getMonitorData

public MonitorData getMonitorData()

Description copied from class: MonitorProvider

Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.

Specified by:

getMonitorData in class MonitorProvider<MonitorProviderCfg>

Returns:

A set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.