com.hcl.domino.keep.platform

Enum InflightController

java.lang.Object

java.lang.Enum<InflightController>

com.hcl.domino.keep.platform.InflightController

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InflightController>

public enum InflightController
extends java.lang.Enum<InflightController>

Keeps track of all requests that came through HTTP and potentially others Requests are checked in / out and a warning is issued if threshold is passed used in HttpListener.handlerUUID

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	InflightController.InflightInfo Class to track requests while they are running

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton

Method Summary

Modifier and Type	Method and Description
InflightController	checkIn(java.lang.String uuid, java.time.Instant startMoment, java.lang.String method, java.lang.String absoluteUri) Checks in a request for tracking of duration and success
InflightController	checkOut(java.lang.String uuid, java.time.Instant stopMoment, java.lang.String absoluteUri, java.lang.String operationId, int status, boolean callSuccess) Records the completion of a request to the log, capturing key parameters
long	count()
void	dump(java.io.PrintStream out, boolean reportIfNothingHappened) Dumps a list of the current running inflight requestss to be visible Allows “empty” request notification appear 10 times less than actual values
io.vertx.core.json.JsonArray	dumpToJsonArray()
static InflightController	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InflightController[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final InflightController INSTANCE

Singleton

Method Detail

values

public static InflightController[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InflightController c : InflightController.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InflightController valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

checkIn

public InflightController checkIn(java.lang.String uuid,
                                  java.time.Instant startMoment,
                                  java.lang.String method,
                                  java.lang.String absoluteUri)

Checks in a request for tracking of duration and success

Parameters:

uuid -

• identifier the request can be found in the database

startMoment -

• when did it start

method -

• what HTTP method was involved

absoluteUri -

• URI called

Returns:

fluent

checkOut

public InflightController checkOut(java.lang.String uuid,
                                   java.time.Instant stopMoment,
                                   java.lang.String absoluteUri,
                                   java.lang.String operationId,
                                   int status,
                                   boolean callSuccess)

Records the completion of a request to the log, capturing key parameters

Parameters:

uuid -

• identifier for the request to remove it from inflight map

stopMoment -

• what time did it stop

absoluteUri -

• what URL was called

operationId -

• What operationId was involved

status -

• what is the status as HTTP return code

callSuccess -

• did the internal call succeed or run into an error

Returns:

fluent

count

public long count()

Returns:

Number of entries in flight

dump

public void dump(java.io.PrintStream out,
                 boolean reportIfNothingHappened)

Dumps a list of the current running inflight requestss to be visible Allows “empty” request notification appear 10 times less than actual values

Parameters:

out -

• PrintStream

reportIfNothingHappened -

• return a value if no inflights are on

dumpToJsonArray

public io.vertx.core.json.JsonArray dumpToJsonArray()

Returns:

a JsonArray with all inflight requests. Might be empty