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

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.util.List<java.lang.String> messages) Creates a health check result with the provided information.
HealthCheckResult	createHealthCheckResult(HealthCheckState state, int score, java.lang.String... messages) Creates a health check result with the provided information.
Location	getLocation() Retrieves the location that has been assigned to the server, if any.

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

createThread, debugCaught, debugEnabled, debugError, debugInfo, debugThrown, debugVerbose, debugWarning, deregisterAllMonitorProviders, deregisterChangeListener, deregisterDiskSpaceConsumer, deregisterMonitorProvider, deregisterShutdownListener, deregisterSupportedControlOID, getClientConnection, getClientRootConnection, getCompactProductName, getFullProductName, getFullVendorName, getInstanceName, getInternalConnection, getInternalRootConnection, getMajorVersionNumber, getMinorVersionNumber, getPackageName, getPatchVersionNumber, getPointVersionNumber, getSchema, getServerRoot, getShortVendorName, getSourceRevision, getStartTime, getStartupID, getStartupUUID, getVersionQualifier, isDirectoryFunctionalityAvailable, isDirectoryProxyFunctionalityAvailable, isRunning, isShuttingDown, isStarting, isSyncFunctionalityAvailable, logMessage, registerChangeListener, registerDiskSpaceConsumer, registerMonitorProvider, registerShutdownListener, registerSupportedControlOID, sendAlert, sendAlert

Method Detail

getLocation

Location getLocation()

Retrieves the location that has been assigned to the server, if any.

Returns:

The location that has been assigned to the server, or null if no location has been assigned.

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.