java.lang.Object

com.illumon.iris.controller.PersistentQueryState

All Implemented Interfaces:: com.fishlib.base.log.LogOutputAppendable, StatusCallback, Serializable, Cloneable

public class PersistentQueryState
extends Object
implements Serializable, Cloneable, StatusCallback, com.fishlib.base.log.LogOutputAppendable

An Object describing the current state of a Persistent Query.

See Also:: Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class PersistentQueryState.Status
Field Summary

Fields

Modifier and Type Field Description

static int NULL_PORT
Constructor Summary

Constructors

Constructor Description

PersistentQueryState(long configurationSerial, long configurationVersion)

Method Summary

Modifier and Type	Method	Description
`com.fishlib.base.log.LogOutput`	`append(com.fishlib.base.log.LogOutput logOutput)`
`PersistentQueryState`	`clone()`
`long`	`getConfigurationSerial()`
`long`	`getConfigurationVersion()`	Get the configuration version of the currently running query.
`String`	`getDispatcherHost()`
`String`	`getEnvoyPrefix()`
`ExceptionDetails`	`getExceptionDetails()`
`Date`	`getInitializationCompleteTime()`
`Date`	`getInitializationStartTime()`
`String`	`getLastAuthenticatedUser()`
`String`	`getLastEffectiveUser()`
`Date`	`getLastUpdateTime()`
`ScriptPathLoaderState`	`getLoaderState()`
`String`	`getProcessInfoId()`
`String`	`getProgressMessage()`
`int`	`getProgressPercentage()`
`Map<String,ExportedObjectType>`	`getScopeNamesAndTypes()`
`PersistentQueryState.Status`	`getStatus()`
`Map<String,String[]>`	`getTableGroups()`
`String[]`	`getTableGroups(String tableName)`
`TypeSpecificQueryState`	`getTypeSpecificState()`
`int`	`getValue()`	get the current value of the progress object.
`int`	`getWebsocketPort()`
`String`	`getWorkerHost()`
`String`	`getWorkerName()`
`int`	`getWorkerPort()`
`boolean`	`hasProgress()`
`boolean`	`hasTableAcls()`
`boolean`	`isRunningForRestart()`
`void`	`setDispatcherHost(String dispatcherHost)`
`void`	`setEnvoyPrefix(String envoyPrefix)`
`void`	`setExceptionDetails(Throwable t)`
`void`	`setInitializationCompleteTime(Date initializationCompleteTime)`
`void`	`setInitializationStartTime(Date initializationStartTime)`
`void`	`setLastAuthenticatedUser(String lastAuthenticatedUser)`
`void`	`setLastEffectiveUser(String lastEffectiveUser)`
`void`	`setLastUpdateTime(Date lastUpdateTime)`
`void`	`setProcessInfoId(String processInfoId)`
`void`	`setScopeNamesAndTypes(Map<String,ExportedObjectType> scopeNamesAndTypes)`
`void`	`setScriptLoaderState(ScriptPathLoaderState state)`
`void`	`setStatus(PersistentQueryState.Status status)`
`void`	`setTableGroups(Map<String,String[]> tableGroups)`
`void`	`setTypeSpecificState(TypeSpecificQueryState typeSpecificState)`
`void`	`setWebsocketPort(int websocketPort)`
`void`	`setWorkerHost(String workerHost)`
`void`	`setWorkerName(String workerName)`
`void`	`setWorkerPort(int workerPort)`
`PersistentQueryState`	`shallowCopy()`
`String`	`toString()`
`void`	`update(int progress, Supplier<String> statusSupplier)`	Update the progress % and status message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.util.progress.StatusCallback

finish, finish, getStepValue, remaining, remaining, subrange, update

Field Details
- NULL_PORT
  
  public static final int NULL_PORT
  
  See Also:
  
  Constant Field Values
Constructor Details
- PersistentQueryState
  
  public PersistentQueryState(long configurationSerial, long configurationVersion)
Method Details
- shallowCopy
  
  public PersistentQueryState shallowCopy()
- clone
  
  public PersistentQueryState clone() throws CloneNotSupportedException
  
  Overrides:
  
  clone in class Object
  
  Throws:
  
  CloneNotSupportedException
- getConfigurationSerial
  
  public long getConfigurationSerial()
- getConfigurationVersion
  
  public long getConfigurationVersion()
  
  Get the configuration version of the currently running query. Note that this can be different from the version of the current PersistentQueryConfiguration, given that a query can be changed without immediately restarting it. A difference in these values can be used to detect this situation.
  
  Returns:
  
  The currently running query version.
- getStatus
  
  public PersistentQueryState.Status getStatus()
- isRunningForRestart
  
  public boolean isRunningForRestart()
- setStatus
  
  public void setStatus(PersistentQueryState.Status status)
- getInitializationStartTime
  
  public Date getInitializationStartTime()
- setInitializationStartTime
  
  public void setInitializationStartTime(Date initializationStartTime)
- getInitializationCompleteTime
  
  public Date getInitializationCompleteTime()
- setInitializationCompleteTime
  
  public void setInitializationCompleteTime(Date initializationCompleteTime)
- getLastUpdateTime
  
  public Date getLastUpdateTime()
- setLastUpdateTime
  
  public void setLastUpdateTime(Date lastUpdateTime)
- getWorkerHost
  
  public String getWorkerHost()
- setWorkerHost
  
  public void setWorkerHost(String workerHost)
- getDispatcherHost
  
  public String getDispatcherHost()
- setDispatcherHost
  
  public void setDispatcherHost(String dispatcherHost)
- getWorkerName
  
  public String getWorkerName()
- setWorkerName
  
  public void setWorkerName(String workerName)
- getProcessInfoId
  
  public String getProcessInfoId()
- setProcessInfoId
  
  public void setProcessInfoId(String processInfoId)
- getTypeSpecificState
  
  public TypeSpecificQueryState getTypeSpecificState()
- setTypeSpecificState
  
  public void setTypeSpecificState(TypeSpecificQueryState typeSpecificState)
- getTableGroups
  
  public Map<String,String[]> getTableGroups()
- hasTableAcls
  
  public boolean hasTableAcls()
- getTableGroups
  
  public String[] getTableGroups(String tableName)
- setTableGroups
  
  public void setTableGroups(Map<String,String[]> tableGroups)
- getScopeNamesAndTypes
  
  public Map<String,ExportedObjectType> getScopeNamesAndTypes()
- setScopeNamesAndTypes
  
  public void setScopeNamesAndTypes(Map<String,ExportedObjectType> scopeNamesAndTypes)
- getWorkerPort
  
  public int getWorkerPort()
- getEnvoyPrefix
  
  public String getEnvoyPrefix()
- setWorkerPort
  
  public void setWorkerPort(int workerPort)
- getWebsocketPort
  
  public int getWebsocketPort()
- setWebsocketPort
  
  public void setWebsocketPort(int websocketPort)
- setEnvoyPrefix
  
  public void setEnvoyPrefix(String envoyPrefix)
- getExceptionDetails
  
  public ExceptionDetails getExceptionDetails()
- setExceptionDetails
  
  public void setExceptionDetails(Throwable t)
- getLastAuthenticatedUser
  
  public String getLastAuthenticatedUser()
- setLastAuthenticatedUser
  
  public void setLastAuthenticatedUser(String lastAuthenticatedUser)
- getLastEffectiveUser
  
  public String getLastEffectiveUser()
- setLastEffectiveUser
  
  public void setLastEffectiveUser(String lastEffectiveUser)
- setScriptLoaderState
  
  public void setScriptLoaderState(ScriptPathLoaderState state)
- getLoaderState
  
  public ScriptPathLoaderState getLoaderState()
- hasProgress
  
  public boolean hasProgress()
- getProgressMessage
  
  public String getProgressMessage()
- getProgressPercentage
  
  public int getProgressPercentage()
- update
  
  public void update(int progress, Supplier<String> statusSupplier)
  
  Description copied from interface: StatusCallback
  
  Update the progress % and status message.
  
  Specified by:
  
  update in interface StatusCallback
  
  Parameters:
  
  progress - percent complete (0-100)
  
  statusSupplier - optional message supplier
- getValue
  
  public int getValue()
  
  Description copied from interface: StatusCallback
  
  get the current value of the progress object.
  
  Specified by:
  
  getValue in interface StatusCallback
  
  Returns:
  
  the % complete of the topmost ProcessStatus - a number between 1 and 100
- append
  
  public com.fishlib.base.log.LogOutput append(com.fishlib.base.log.LogOutput logOutput)
  
  Specified by:
  
  append in interface com.fishlib.base.log.LogOutputAppendable
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class PersistentQueryState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.illumon.util.progress.StatusCallback

Field Details

Constructor Details

Method Details