Package com.illumon.iris.controller.handle

Class CommunityPersistentQueryHandle

java.lang.Object

com.illumon.iris.controller.handle.CommunityPersistentQueryHandle

All Implemented Interfaces:

PersistentQueryHandle

public class CommunityPersistentQueryHandle
extends Object

A Handle to a Persistent Query backed by an Enterprise worker.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	CommunityPersistentQueryHandle.CommunityWorkerHandle

Field Summary

Fields

Modifier and Type	Field	Description
protected final PersistentQueryConfiguration	config
protected final ControllerConfigurationType	configurationType
protected final PersistentQueryDbServerConfig	dbServerConfig
protected final com.fishlib.net.ConnectionMonitor.Params	dispatcherConnectionMonitorParams
protected final PublicPrivateKeyEncryption	encryption
protected final ThreadPoolExecutor	executorService
protected final ScriptPathLoader	loader
protected final com.fishlib.io.logger.Logger	log
static final int	MAX_INBOUND_MESSAGE_SIZE
protected final PersistentQueryState	state
protected QueryDispatcherConnection.QueryProcessorRequestHandle	workerRequestHandle

Constructor Summary

Constructors

Constructor	Description
CommunityPersistentQueryHandle(com.fishlib.io.logger.Logger log, Object queryHandleContext)	Create a new Handle for an enterprise worker.

Method Summary

Modifier and Type	Method	Description
protected boolean	checkQueryTerminatingOrTerminal()
protected WorkerHandle	createWorkerHandle(RemoteProcessingRequest request, QueryDispatcherConnection dispatcherConnection)
protected void	ensureShutdown(boolean awaitDisconnection)
protected String	getScriptCode()
PersistentQueryState	getState()	Get the current state object for the Persistent Query.
long	getVersion()	Get the currently running version of the Persistent Query.
protected boolean	maybeSetTerminalStatus(Supplier<PersistentQueryState.Status> statusSupplier)
protected boolean	onDispatcherConnected(QueryDispatcherConnection dispatcherConnection)
protected void	onError(Throwable t)
protected void	onFailure(Throwable t, boolean awaitDisconnection)
protected void	onFailure(Throwable t, boolean awaitDisconnection, String message)
protected void	onStartRequested()
protected void	publishState()
void	shutdown(String lastAuthenticatedUser, String lastEffectiveUser)	Shutdown the worker, if it is running.
void	start()	Start the worker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_INBOUND_MESSAGE_SIZE

public static final int MAX_INBOUND_MESSAGE_SIZE

log

@NotNull
protected final com.fishlib.io.logger.Logger log

configurationType

protected final ControllerConfigurationType configurationType

config

protected final PersistentQueryConfiguration config

loader

protected final ScriptPathLoader loader

dbServerConfig

protected final PersistentQueryDbServerConfig dbServerConfig

state

protected final PersistentQueryState state

dispatcherConnectionMonitorParams

protected final com.fishlib.net.ConnectionMonitor.Params dispatcherConnectionMonitorParams

executorService

protected final ThreadPoolExecutor executorService

encryption

protected final PublicPrivateKeyEncryption encryption

workerRequestHandle

protected volatile QueryDispatcherConnection.QueryProcessorRequestHandle workerRequestHandle

Constructor Details

CommunityPersistentQueryHandle

public CommunityPersistentQueryHandle(@NotNull
 com.fishlib.io.logger.Logger log,
 @NotNull
 Object queryHandleContext)

Create a new Handle for an enterprise worker.

Parameters:

log - the log.

queryHandleContext - A context object containing the required parameters for this object.

Method Details

onStartRequested

protected void onStartRequested()

onDispatcherConnected

protected boolean onDispatcherConnected(@NotNull
 QueryDispatcherConnection dispatcherConnection)

createWorkerHandle

protected WorkerHandle createWorkerHandle(RemoteProcessingRequest request,
 QueryDispatcherConnection dispatcherConnection)

getVersion

public long getVersion()

Description copied from interface: PersistentQueryHandle

Get the currently running version of the Persistent Query.

Specified by:

getVersion in interface PersistentQueryHandle

Returns:

the version of the running query

getState

public PersistentQueryState getState()

Description copied from interface: PersistentQueryHandle

Get the current state object for the Persistent Query.

Specified by:

getState in interface PersistentQueryHandle

Returns:

the current state

start

public void start()

Description copied from interface: PersistentQueryHandle

Start the worker.

Specified by:

start in interface PersistentQueryHandle

shutdown

public void shutdown(String lastAuthenticatedUser,
 String lastEffectiveUser)

Description copied from interface: PersistentQueryHandle

Shutdown the worker, if it is running.

Specified by:

shutdown in interface PersistentQueryHandle

Parameters:

lastAuthenticatedUser - the authenticating user requesting the shutdown

lastEffectiveUser - the effective user requesting the shuutdown

ensureShutdown

protected void ensureShutdown(boolean awaitDisconnection)

Parameters:

awaitDisconnection - Used to communicate whether we need to care further about ensuring disconnection, or not. If true, we block until interrupted or until another thread calls ensureShutdown(false). If false, we're asserting that the DB is already disconnected, or that we don't care (because no script was run yet).

checkQueryTerminatingOrTerminal

protected boolean checkQueryTerminatingOrTerminal()

maybeSetTerminalStatus

protected boolean maybeSetTerminalStatus(Supplier<PersistentQueryState.Status> statusSupplier)

onError

protected void onError(@Nullable
 Throwable t)

onFailure

protected void onFailure(@Nullable
 Throwable t,
 boolean awaitDisconnection)

onFailure

protected void onFailure(@Nullable
 Throwable t,
 boolean awaitDisconnection,
 @Nullable
 String message)

publishState

protected void publishState()

getScriptCode

protected String getScriptCode()