|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface ProxyServerContext
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. |
Method Detail |
---|
Location getLocation()
null
if no location has been assigned.HealthCheckResult createHealthCheckResult(HealthCheckState state, int score, java.lang.String... messages)
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.
HealthCheckResult createHealthCheckResult(HealthCheckState state, int score, java.util.List<java.lang.String> messages)
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.
HealthCheckResult aggregate(java.util.List<HealthCheckResult> results)
results
- The list of health check results to be aggregated. It
must not be null
or empty.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |