Package com.unboundid.directory.sdk.proxy.types

Interface ProxyServerContext

All Superinterfaces:

ServerContext

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface ProxyServerContext
extends ServerContext

This interface may be used to obtain information about the Directory Proxy Server in which an extension is running.

Method Summary

Modifier and Type	Method	Description
HealthCheckResult	aggregate(java.util.List<HealthCheckResult> results)	Aggregates the information contained in the provided list of health check results into a single result.
HealthCheckResult	createHealthCheckResult(HealthCheckState state, int score, java.lang.String... messages)	Creates a health check result with the provided information.
HealthCheckResult	createHealthCheckResult(HealthCheckState state, int score, java.util.List<java.lang.String> messages)	Creates a health check result with the provided information.
java.util.Map<java.lang.String,RequestProcessor>	getRequestProcessors()	For each Subtree View, return the corresponding RequestProcessor in a map keyed by the configured name of the Subtree View.

Methods inherited from interface com.unboundid.directory.sdk.common.types.ServerContext

createEMailAttachment, createEMailMessage, createThread, createValueConstructor, debugCaught, debugEnabled, debugError, debugInfo, debugThrown, debugVerbose, debugWarning, deregisterAllMonitorProviders, deregisterChangeListener, deregisterDiskSpaceConsumer, deregisterMonitorProvider, deregisterShutdownListener, deregisterSupportedControlOID, getBasicProductName, getClientConnection, getClientRootConnection, getCompactProductName, getEncryptedOutputStream, getEncryptedOutputStream, getEncryptionSettingsDefinition, getEncryptionSettingsDefinitions, getFullProductName, getFullVendorName, getFullVersion, getGroup, getGroupsForUser, getInstanceName, getInternalConnection, getInternalRootConnection, getLDAPExternalServerConnection, getLDAPExternalServerConnectionPool, getLocation, getMajorVersionNumber, getMinorVersionNumber, getObscuredValue, getPackageName, getPassphraseFromPassphraseProvider, getPatchVersionNumber, getPointVersionNumber, getPossiblyCompressedAndEncryptedInputStream, getPossiblyCompressedAndEncryptedInputStream, getPreferredEncryptionSettingsDefinition, getPrivilegeNames, getSchema, getServerRoot, getShortVendorName, getSourceRevision, getStartTime, getStartupID, getStartupUUID, getToolExecutor, getVersionNumber, getVersionQualifier, hasPrivilege, isDirectoryFunctionalityAvailable, isDirectoryProxyFunctionalityAvailable, isRunning, isShuttingDown, isStarting, isSyncFunctionalityAvailable, isTraceMessageLoggable, logMessage, logTraceMessage, logTraceMessage, registerChangeListener, registerDiskSpaceConsumer, registerMonitorProvider, registerShutdownListener, registerSupportedControlOID, reloadHTTPConnectionHandlerCertificates, sendAlert, sendAlert, sendDegradedAlertNotification, sendUnavailableAlertNotification

Method Detail

createHealthCheckResult

HealthCheckResult createHealthCheckResult(HealthCheckState state,
                                          int score,
                                          java.lang.String... messages)

Creates a health check result with the provided information.

Parameters:

state - The health check state for the result. It must not be null.

score - The score for the result. It must be an integer value between 1 and 10 for a state of AVAILABLE or DEGRADED, or zero for a state of UNAVAILABLE.

messages - A set of messages with additional information about the reason for the provided state and score. It may be null or empty if no messages are needed.

Returns:

The created health check result.

createHealthCheckResult

HealthCheckResult createHealthCheckResult(HealthCheckState state,
                                          int score,
                                          java.util.List<java.lang.String> messages)

Creates a health check result with the provided information.

Parameters:

state - The health check state for the result. It must not be null.

score - The score for the result. It must be an integer value between 1 and 10 for a state of AVAILABLE or DEGRADED, or zero for a state of UNAVAILABLE.

messages - A set of messages with additional information about the reason for the provided state and score. It may be null or empty if no messages are needed.

Returns:

The created health check result.

aggregate

HealthCheckResult aggregate(java.util.List<HealthCheckResult> results)

Aggregates the information contained in the provided list of health check results into a single result. The aggregate result will be the worst result of all of the provided results, and will contain all the messages from all of the given results.

Parameters:

results - The list of health check results to be aggregated. It must not be null or empty.

Returns:

The health check result which is an aggregation of the provided list of results.

getRequestProcessors

java.util.Map<java.lang.String,RequestProcessor> getRequestProcessors()

For each Subtree View, return the corresponding RequestProcessor in a map keyed by the configured name of the Subtree View. This is particularly useful for getting access to EntryBalancingRequestProcessors One use case of this method is to modify an incoming LDAP request in a Plugin#doPreParse implementation by accessing the Entry Balancing Request Processor's global indexes using the EntryBalancingRequestProcessor#getGlobalIndexHint methods.

Returns:

A map from the configured name of the Subtree View to its corresponding RequestProcessor.