Package com.illumon.iris.controller
Class PersistentQueryConfiguration
java.lang.Object
com.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
com.illumon.iris.controller.PersistentQueryConfiguration
- All Implemented Interfaces:
com.fishlib.base.Copyable<com.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration>
,com.fishlib.base.log.LogOutputAppendable
,com.fishlib.base.SafeCloneable<com.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration>
,com.fishlib.dataobjects.persistence.WObjectStreamConstants
,com.fishlib.dataobjects.WAbstractDataObject
,Externalizable
,Serializable
,Cloneable
public class PersistentQueryConfiguration
extends com.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
PersistentQueryConfiguration contains the persistent state for a query.
- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PersistentQueryConfiguration.ValidationException
static class
PersistentQueryConfiguration.ValidationFailure
static class
PersistentQueryConfiguration.ValidationWarning
-
Field Summary
Fields inherited from class com.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
classPathAdditions, columnSet_, columnSetName_, completedStatus, configurationType, dataBufferPoolToHeapSizeRatio, dbServerName, detailedGCLoggingEnabled, enabled, expirationTime, extraEnvironmentVariables, extraJvmArguments, heapSizeInGB, INDEX_OF_CLASSPATHADDITIONS, INDEX_OF_COMPLETEDSTATUS, INDEX_OF_CONFIGURATIONTYPE, INDEX_OF_DATABUFFERPOOLTOHEAPSIZERATIO, INDEX_OF_DBSERVERNAME, INDEX_OF_DETAILEDGCLOGGINGENABLED, INDEX_OF_ENABLED, INDEX_OF_EXPIRATIONTIME, INDEX_OF_EXTRAENVIRONMENTVARIABLES, INDEX_OF_EXTRAJVMARGUMENTS, INDEX_OF_HEAPSIZEINGB, INDEX_OF_JVMPROFILE, INDEX_OF_KUBERNETESCONTROL, INDEX_OF_LASTMODIFIEDBYAUTHENTICATED, INDEX_OF_LASTMODIFIEDBYEFFECTIVE, INDEX_OF_LASTMODIFIEDTIME, INDEX_OF_NAME, INDEX_OF_OMITDEFAULTGCPARAMETERS, INDEX_OF_OWNER, INDEX_OF_RESTARTUSERS, INDEX_OF_SCHEDULING, INDEX_OF_SCRIPTCODE, INDEX_OF_SCRIPTLANGUAGE, INDEX_OF_SCRIPTPATH, INDEX_OF_SERIAL, INDEX_OF_TIMEOUT, INDEX_OF_TYPESPECIFICFIELDS, INDEX_OF_VERSION, INDEX_OF_WEEPSADMINGROUPS, INDEX_OF_WEEPSVIEWERGROUPS, jVMProfile, kubernetesControl, lastModifiedByAuthenticated, lastModifiedByEffective, lastModifiedTime, name, omitDefaultGCParameters, owner, restartUsers, RESTARTUSERS_ADMIN, RESTARTUSERS_ADMINANDVIEWERS, RESTARTUSERS_VIEWERSWHENDOWN, scheduling, scriptCode, scriptLanguage, scriptPath, serial, timeout, typeSpecificFields, version, weepsAdminGroups, weepsViewerGroups
Fields inherited from interface com.fishlib.dataobjects.persistence.WObjectStreamConstants
ADD_CLASS, ADD_COLUMN_SET_CLASS, ADD_ENUM, ADD_ENUM_LONG, ADO_ARRAY_TYPE, ARRAY_TYPE, BOOLEAN_TYPE, BYTE_ARRAY_TYPE, BYTE_TYPE, DATE_TYPE, DOUBLE_ARRAY_TYPE, DOUBLE_TYPE, FLOAT_ARRAY_TYPE, FLOAT_TYPE, INT_ARRAY_TYPE, INTEGER_TYPE, KNOWN_ENUM, KNOWN_ENUM_LONG, LINKED_MAP_TYPE, LINKED_SET_TYPE, LONG_ARRAY_TYPE, LONG_STRING_TYPE, LONG_TYPE, MAP_TYPE, NULL_TYPE, OBJECT_TYPE, SET_TYPE, STRING_ARRAY_TYPE, STRING_TYPE, TREE_MAP_TYPE, TREE_SET_TYPE
-
Constructor Summary
Constructors Constructor Description PersistentQueryConfiguration()
PersistentQueryConfiguration(PersistentQueryConfiguration other)
-
Method Summary
Methods inherited from class com.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
copyValues, getByte, getByte, getByte, getClassPathAdditions, getColumnSet, getColumnSetName, getColumnSetStatic, getCompletedStatus, getConfigurationType, getDataBufferPoolToHeapSizeRatio, getDate, getDate, getDate, getDbServerName, getDetailedGCLoggingEnabled, getDouble, getDouble, getDouble, getEnabled, getExpirationTime, getExtraEnvironmentVariables, getExtraJvmArguments, getHeapSizeInGB, getInt, getInt, getInt, getJVMProfile, getKubernetesControl, getLastModifiedByAuthenticated, getLastModifiedByEffective, getLastModifiedTime, getLong, getLong, getLong, getName, getOmitDefaultGCParameters, getOwner, getRestartUsers, getScheduling, getScriptCode, getScriptLanguage, getScriptPath, getSerial, getString, getString, getString, getTimeout, getTypeSpecificFields, getValue, getValue, getValue, getVersion, getWeepsAdminGroups, getWeepsViewerGroups, readExternal, safeClone, setByte, setByte, setClassPathAdditions, setCompletedStatus, setConfigurationType, setDataBufferPoolToHeapSizeRatio, setDate, setDate, setDbServerName, setDetailedGCLoggingEnabled, setDouble, setDouble, setEnabled, setExpirationTime, setExtraEnvironmentVariables, setExtraJvmArguments, setHeapSizeInGB, setInt, setInt, setJVMProfile, setKubernetesControl, setLastModifiedByAuthenticated, setLastModifiedByEffective, setLastModifiedTime, setLong, setLong, setName, setOmitDefaultGCParameters, setOwner, setRestartUsers, setScheduling, setScriptCode, setScriptLanguage, setScriptPath, setSerial, setString, setString, setTimeout, setTypeSpecificFields, setValue, setValue, setVersion, setWeepsAdminGroups, setWeepsViewerGroups, writeExternal
-
Constructor Details
-
PersistentQueryConfiguration
public PersistentQueryConfiguration() -
PersistentQueryConfiguration
-
-
Method Details
-
clone
- Specified by:
clone
in interfacecom.fishlib.dataobjects.WAbstractDataObject
- Overrides:
clone
in classcom.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
-
toDetailedString
-
toString
- Overrides:
toString
in classcom.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
-
getDescription
-
appendDetailed
public com.fishlib.base.log.LogOutput appendDetailed(com.fishlib.base.log.LogOutput logOutput) -
append
public com.fishlib.base.log.LogOutput append(com.fishlib.base.log.LogOutput logOutput)- Specified by:
append
in interfacecom.fishlib.base.log.LogOutputAppendable
- Overrides:
append
in classcom.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
-
equals
- Overrides:
equals
in classcom.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
-
hashCode
public int hashCode()- Overrides:
hashCode
in classcom.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration
-
getScriptPathSet
public static Set<String> getScriptPathSet(String owner, io.deephaven.enterprise.auth.UserContext userContext, IrisGroupProvider irisGroupProvider, PersistentQueryScriptSource persistentQueryScriptSource, long serial) -
validate
public void validate(Map<Long,PersistentQueryInfo> allConfigurations, PersistentQueryControllerConfiguration serverConfig) throws PersistentQueryConfiguration.ValidationFailure -
getHeapSizeInMB
public int getHeapSizeInMB() -
getJvmArguments
-
getExtraJvmArgumentsAsString
-
setExtraJvmArgumentsFromString
-
getClassPathAdditionsAsString
-
setClassPathAdditionsFromString
-
getExtraJvmArgumentsAsList
-
setExtraJvmArgumentsFromList
-
getExtraEnvironmentVariablesAsString
-
setExtraEnvironmentVariablesFromString
-
setKubernetesControl
-
getExtraEnvironmentVariablesAsMap
-
setExtraEnvironmentVariablesFromMap
-
createFromXmlByteArray
public static List<PersistentQueryConfiguration> createFromXmlByteArray(byte[] xmlBytes) throws IOException, org.jdom2.JDOMExceptionCreate a list of PersistentQueryConfiguration instances from a byte array containing XML. The XML should have been created by the correspondingcreateXmlDocumentFromConfigurations(Collection,BiConsumer)
method. There are no guarantees on the type, mutability, serializability, or thread-safety of the returned List.- Parameters:
xmlBytes
- the byte array containing the XML- Returns:
- a List of PersistentQueryConfiguration instances
- Throws:
IOException
org.jdom2.JDOMException
-
asXmlString
Convert this persistent query into an XML String.- Returns:
- this persistent query represented as an XML string.
-
writeXmlFromConfigurations
public static void writeXmlFromConfigurations(@NotNull Collection<PersistentQueryConfiguration> configurations, Writer outputWriter, BiConsumer<Boolean,PersistentQueryConfiguration> contextCallback)Write XML text resenting a collection of persistent query configurations to the specified Writer.- Parameters:
configurations
- the PersistentQueryConfiguration instances to be writtenoutputWriter
- the Writer to use for the outputcontextCallback
- optional functor that takes a flag and a query configuration, used to annotate informational logging outputs around the processing of each config, true on entry, false on exit, null == no-op.
-