com.hcl.domino.keep.platform

Enum AsyncAgentController

java.lang.Object

java.lang.Enum<AsyncAgentController>

com.hcl.domino.keep.platform.AsyncAgentController

All Implemented Interfaces:

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

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

Holder for Async agent processing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsyncAgentController.AgentState States that agent processing can be in
static class	AsyncAgentController.AsyncAgentInfo In-memory class for agent info

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton to keep an eye on running agents

Field Summary

Fields

Modifier and Type	Field and Description
java.util.concurrent.atomic.AtomicBoolean	isStarted Track if the agent is started
java.util.concurrent.atomic.AtomicBoolean	isStopping Track if the agent has been asked to stop

Method Summary

Modifier and Type	Method and Description
void	abortOne(java.lang.String uuid) Allows a single agent to be cancelled
long	count()
static AsyncAgentController.AsyncAgentInfo	createAsyncAgentInfoFromDoc(com.hcl.domino.data.Document doc)
AsyncAgentController	deregister(java.lang.String uuid) Removes an AsyncAgentInfo object from the holder and the list of UUIDs aborted
void	disposeQueued() Removes any AsyncAgentInfo objects with state QUEUED.
void	dump(java.io.PrintStream out, boolean reportIfNothingHappened) Outputs info of all AsyncAgentInfo objects held in memory Format for all AsyncAgentInfo objects: uuid, logDocUnid, state, username, runAsServer, dbPath, agentName, incoming, creation time
io.vertx.core.json.JsonArray	dumpToJsonArray() Outputs info of all AsyncAgentInfo objects held in memory as a JSON array
AsyncAgentController.AsyncAgentInfo	getAgentInfoByKey(java.lang.String uuid) Gets the AsyncAgentInfo object relating to a specific UUID
int	getAgentRequestSize() Gets the number of agents not yet disposed
boolean	isCleared() Checks if all AsyncAgentInfo objects have been disposed
boolean	isOneAborted(java.lang.String uuid) Check for whether a specific agent has been aborted
void	register(AsyncAgentController.AsyncAgentInfo agentInfo)
AsyncAgentController.AsyncAgentInfo	register(java.lang.String uuid, java.time.Instant startMoment, java.lang.String logDocUnid, java.lang.String dbPath, java.lang.String agentName, KeepUser user, java.lang.Boolean runAsServer, io.vertx.core.json.JsonObject payload) Register an AsyncAgentInfo object into the holder
static AsyncAgentController	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AsyncAgentController[]	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 AsyncAgentController INSTANCE

Singleton to keep an eye on running agents

Field Detail

isStarted

public final java.util.concurrent.atomic.AtomicBoolean isStarted

Track if the agent is started

isStopping

public final java.util.concurrent.atomic.AtomicBoolean isStopping

Track if the agent has been asked to stop

Method Detail

values

public static AsyncAgentController[] 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 (AsyncAgentController c : AsyncAgentController.values())
    System.out.println(c);

Returns:

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

valueOf

public static AsyncAgentController 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

createAsyncAgentInfoFromDoc

public static AsyncAgentController.AsyncAgentInfo createAsyncAgentInfoFromDoc(com.hcl.domino.data.Document doc)
                                                                       throws KeepException

Parameters:

doc -

Returns:

AsyncAgentInfo

Throws:

KeepException

abortOne

public void abortOne(java.lang.String uuid)

Allows a single agent to be cancelled

Parameters:

uuid - of the AsyncAgentInfo object

count

public long count()

Returns:

Number of entries in flight

deregister

public AsyncAgentController deregister(java.lang.String uuid)

Removes an AsyncAgentInfo object from the holder and the list of UUIDs aborted

Parameters:

uuid - for the AsyncAgentInfo object

Returns:

fluent

disposeQueued

public void disposeQueued()

Removes any AsyncAgentInfo objects with state QUEUED. Used during shut-down to prevent starting of additional agents as we’re shutting down.

dump

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

Outputs info of all AsyncAgentInfo objects held in memory Format for all AsyncAgentInfo objects: uuid, logDocUnid, state, username, runAsServer, dbPath, agentName, incoming, creation time

Parameters:

out - PrintStream to write to

reportIfNothingHappened - if true -> no output on empty agetnd

dumpToJsonArray

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

Outputs info of all AsyncAgentInfo objects held in memory as a JSON array

Returns:

content for all AsyncAgentInfo objects

getAgentInfoByKey

public AsyncAgentController.AsyncAgentInfo getAgentInfoByKey(java.lang.String uuid)

Gets the AsyncAgentInfo object relating to a specific UUID

Parameters:

uuid - of the AsyncAgentInfo object

Returns:

AsyncAgentInfo object or null

getAgentRequestSize

public int getAgentRequestSize()

Gets the number of agents not yet disposed

Returns:

number of AsyncAgentInfo objects held

isCleared

public boolean isCleared()

Checks if all AsyncAgentInfo objects have been disposed

Returns:

true if holder is empty

isOneAborted

public boolean isOneAborted(java.lang.String uuid)

Check for whether a specific agent has been aborted

Parameters:

uuid - of the AsyncAgentInfo object

Returns:

true if the agent has been aborted

register

public void register(AsyncAgentController.AsyncAgentInfo agentInfo)

Parameters:

agentInfo -

register

public AsyncAgentController.AsyncAgentInfo register(java.lang.String uuid,
                                                    java.time.Instant startMoment,
                                                    java.lang.String logDocUnid,
                                                    java.lang.String dbPath,
                                                    java.lang.String agentName,
                                                    KeepUser user,
                                                    java.lang.Boolean runAsServer,
                                                    io.vertx.core.json.JsonObject payload)

Register an AsyncAgentInfo object into the holder

Parameters:

uuid - passed in the messages

startMoment - Instant the object was constructed

logDocUnid - for NotesDocument in AgentScheduler database

dbPath - for the agent to run

agentName - to run

user - the call was initiated by

runAsServer - to override running as the user who initiated the call

payload -

Returns:

created AsyncAgentInfo