public class AspenProperties
extends java.util.Properties
The valid properties are all listed in the aspen.properties
file. This class provided a method to get each of them. Although it is
possible to retrieve properties using the inherited Properties.getProperty(String)
method, we recommend that you use methods in
this class.
Modifier and Type | Field and Description |
---|---|
StringProperty |
acceptFPs
With SSL, accept the client certificates with matching fingerprint, reject connection otherwise
Comma separated list of SHA1 fingerprints
|
DoubleProperty |
aggregateMaximumDeadBucketRatio
The property aspen.aggregate.maximumDeadBucketRatio controls
when the streaming aggregate xo will clear its hashmap instead
of marking aggrtegate buckets dead.
|
BooleanProperty |
aggregateUseResultBuffering
The property aspen.aggregate.useResultBuffering controls
when when the streaming aggregate xos will buffer their results
so that they can start processing input before downstream xos have
processed it's output.
|
StringProperty |
blessedPluginNames
The "aspen.test.plugin.names" property specifies a
comma-separated list of case-sensitive plugin names
that are "blessed" to be preserved across AspenTestCase
setup and teardown.
|
StringProperty |
blessedSchemaNames
The "aspen.test.schema.names" property specifies a
comma-separated list of case-sensitive schema names
that are "blessed" to be preserved across AspenTestCase
setup and teardown.
|
StringProperty |
CApath
With SSL, Certificate verification path, usually /etc/ssl/certs/
|
StringProperty |
catalogDir
The "aspen.catalog.directory" property holds the name of the directory
which contains the Aspen repository file.
|
StringProperty |
catalogFile
The "aspen.catalog.file" property holds
the basename of the Aspen repository file.
|
BooleanProperty |
clusterAutojoin
Determines if RMPs automagically join the cluster upon startup or if
they must be added via DDL after startup.
|
StringProperty |
clusterIdentifier
The property "aspen.cluster.uuid" is the cluster's unique identifier.
|
StringProperty |
configUrl
The "aspen.config.url" property holds the URL of a properties file
loaded at boot time.
|
StringProperty |
customPropertiesUrl
The "aspen.custom.properties.url" property holds the URL of a custom
properties file also loaded at boot time.
|
BooleanProperty |
devMode
The property "aspen.dev.mode" allows the control node to either
behave normally or in development mode.
|
BooleanProperty |
failOnTooFewRmps
The property "aspen.node.redundancy.fail" tells Aspen if to fail to
plan queries when there are not enough RMPs to meet redundancy
requirements
|
StringProperty |
installAwsaccount_id
The AWS installer/setup prompts and fills field.
|
StringProperty |
installCompany
The installer prompts and fills this field.
|
StringProperty |
installEmail
The installer prompts and fills field.
|
BooleanProperty |
inToolContext
The property "aspen.tool" indicates to aspen components that they are
running as part of a tool, not as part of an aspen server.
|
StringProperty |
jdbcDriverName
Name of JDBC driver as reported by java.sql.DatabaseMetaData.
|
StringProperty |
jdbcDrivers
The "aspen.test.jdbc.drivers" property holds
a comma-separated list of class names to be used as JDBC drivers.
|
IntegerProperty |
jdbcDriverVersionMajor
Major version of driver as reported by java.sql.DatabaseMetaData.
|
IntegerProperty |
jdbcDriverVersionMinor
Minor version of driver as reported by java.sql.DatabaseMetaData.
|
IntegerProperty |
jdbcStressColsPerQuery
The "aspen.test.jdbc.stress.colsPerQuery" property specifies
the maximum number of columns per query
during JDBC driver stress tests.
|
IntegerProperty |
jdbcStressStmtsPerConn
The "aspen.test.jdbc.stress.stmtsPerConn" property specifies
the maximum number of simultaneously open statements per connection
during JDBC driver stress tests.
|
StringProperty |
keyPassword
With SSL on, use this password to open up the key file.
|
LongProperty |
maximumStreamSize
The long property aspen.ddl.maximumRowSize is the maximum width that
aspen streams can be declared as.
|
StringProperty |
mdrImplementationType
The "org.eigenbase.enki.implementationType" property describes the
engine used to hold metadata.
|
StringProperty |
mdrModelExt
The "aspen.catalog.modelextname" property holds
the model extension name of the Aspen model in the repository.
|
StringProperty |
mdrPersistenceDir
The "org.netbeans.mdr.persistence.Dir" property holds
the name of the directory where the Netbeans repository looks for a
repository file.
|
BooleanProperty |
nexusDeadlockDetection
The property aspen.nexus.deadlockDetection controls
whether runtime diamond detection is performed.
|
IntegerProperty |
nexusMaximumBufferExpansion
The property aspen.nexus.maximumBufferExpansion controls how many
buffers can be allocated when a nexus has one output in overflow
and one in underflow.
|
PersistentStringProperty |
nodeIdentifier
The property "aspen.sdp.node.identifier" allows Aspen nodes to determine
and persist their unique node identifier.
|
IntegerProperty |
nodeRedundancy
The property "aspen.node.redundancy" tells Aspen control nodes how
many RMPs must crash before a distributed Aspen loses tuples.
|
BooleanProperty |
onProtocolErrorThrowException
The property "aspen.sdp.throwOnProtocolError"
If true and protocol decoding becomes mis-synchronized,
throw an exception.
|
BooleanProperty |
pluginPollPunct |
StringProperty |
productName
Name of the product as reported by java.sql.DatabaseMetaData.
|
StringProperty |
propertiesUrl
The "aspen.properties.url" property holds the URL of the
properties file loaded at boot time.
|
BooleanProperty |
pumpManagerStartPumpsAtBoot
At s-Server startup, pumpManager starts all enabled pumps in the catalog
Regardless of this propery, Pump Manager will always start error stream
at s-server startup time.
|
StringProperty |
reposUrl
The "aspen.test.repos.url" property holds the URL of the
XML repository file used for testing,
default value "file:demo/repository.xml".
|
StringProperty |
rmpTempDir
The "aspen.rmp.temp" property holds the name of a
temporary directory for Aspen RMPs.
|
DoubleProperty |
sched_memoryChecker_memory_shutdownlimitRatio
Max ratio for determining the
low memory condition.
|
StringProperty |
sched_memoryChecker_memory_type
Memory type for the checking, either "ram" or "total" (ie.
|
DoubleProperty |
sched_memoryChecker_memory_warninglimitRatio
Max ratio for determining the
low memory condition.
|
BooleanProperty |
sched_memoryChecker_shutdown_enabled
Enable/disable memory checker
|
BooleanProperty |
sched_memoryChecker_warning_enabled
Enable/disable memory checker
|
BooleanProperty |
schedAddSlowCalcs
Slow Calcs are a trick for testing the scheduler.
|
IntegerProperty |
schedAddSlowCalcsNCalcs
How many Slow Calcs to add after each real Calc
|
IntegerProperty |
schedAddSlowCalcsNPasses
How many times each Slow Calc loops over a block of busywork;
0 means no busywork at all.
|
StringProperty |
schedCheckerPeriod
The scheduler periodically checks for a valid license, and whether to
throttle execution.
|
StringProperty |
schedCheckerSavePeriod
While checking usage, the scheduler keeps a recent history,
and periodically saves it to a file so it can persist past server runs.
|
StringProperty |
schedCheckerThrottle
Target throughput level for throttling, in bytes per day.
|
StringProperty |
schedCheckerThrottleAfter
When throttling is enabled, it occurs when daily input has exceeded this level, in bytes.
|
StringProperty |
schedCheckerThrottleWhen
Circumstance when throttling is possible: never, always, [when usage is]
unreported.
|
StringProperty |
schedCheckerTimezone
Timezone used by usage checker.
|
BooleanProperty |
schedDebugAsserts
Whether to pause on an assert from C code, waiting for gdb to attach.
|
IntegerProperty |
schedDebugBacktrace
Whether to print a backtrace on a debug condition.
|
BooleanProperty |
schedDebugBreak
For the parallel scheduler only, whether to pause on a
debug condition, waiting for gdb to attach.
|
IntegerProperty |
schedDebugDetail
For the parallel scheduler only, level of detil when printing scheduler
state.
|
BooleanProperty |
schedDebugOnStop
Whether to have a debug event when the scheduler is about to stop.
|
StringProperty |
schedDebugPrint
For the parallel scheduler only, where to print scheduler status on a
debug condition.
|
IntegerProperty |
schedDiamondDetectionPeriod
The parallel scheduler has a periodic task that checks for blockages
in stream graph due to diamond patterns.
|
IntegerProperty |
schedHistory
For the parallel scheduler only, each task executor remembers this many
recently completed tasks.
|
IntegerProperty |
schedHistoryDetail
For the parallel scheduler, level of detail in the task history.
|
IntegerProperty |
schedLicenseCheckPeriod
License recheck period (secs).
|
StringProperty |
schedLicensePath
Path used by the server to find license files.
|
BooleanProperty |
schedLicenseUseTrustedStorage
Should the server look in local trusted storage for an installed license
file? False means look only in the schedLicensePath;
Ideal default is true, but local trusted storage disabled per dtbug 2768.
|
StringProperty |
schedNthreads
How many threads dedicated to execution objects.
|
IntegerProperty |
schedOverlookPeriod
The parallel scheduler has a periodic task that checks for overlooked
runnable ExecStreams.
|
BooleanProperty |
schedParallel
The property "aspen.sched.parallel" controls which scheduler version to
use.
|
StringProperty |
schedReporterPeriod
The scheduler periodically send usage reports to a web-service.
|
StringProperty |
schedReporterURL
The scheduler periodically send usage reports to a web-service.
|
DoubleProperty |
schedStatsDiscardAfter
Scheduler keeps entries in graph and stream tables for defunct (removed) graphs
for at least this amount of time [secs].
|
BooleanProperty |
schedStatsMayCountRows
Allows the scheduler to count rows in input/output buffers.
|
DoubleProperty |
schedStatsPeriod
The scheduler traces statistics of open stream graphs, with this period in secs.
|
BooleanProperty |
schedStatsSnapshot
Tells the scheduler to call getSnapshot() when tracing statistics
|
IntegerProperty |
schedTaskTimeout
For the parallel scheduler only, initial value of scheduler's
taskTimeout, in msecs.
|
DoubleProperty |
schedThrottle
For the parallel scheduler, an upper limit to the input and output rate
of every ExecStream and hence of every running statement.
|
BooleanProperty |
schedValidateGraphs
Tells the scheduler to verify the integrity of its stream-graph and stream-node tables
after adding or removing a stream-graph.
|
BooleanProperty |
schedVerbose
When true, the scheduler prints messages to stderr, notably at startup.
|
StringProperty |
scottJdbcUrl
The "aspen.test.scott.jdbc.url" property holds
the URL of the JDBC database which contains the Scott schema (the
old Oracle favorite containing the EMP and DEPT tables),
default "jdbc:hsqldb:/saffron/demo/hsqldb/scott".
|
IntegerProperty |
sdpBlockSize
The property "aspen.sdp.blocksize" allows the configuration of the
SDP block size, in bytes.
|
BooleanProperty |
sdpCompressionEnable
The property "aspen.sdp.tcpListenEnableCompression" Enables Zlib
compression on SDP connections
|
StringProperty |
sdpHost
The property "aspen.sdp.host" sets an optional
hostname (or IP) for SDP.
|
IntegerProperty |
sdpLinkTimeoutMs
The property "aspen.sdp.linkTimeoutMs" sets
Minimum number of milliseconds of idle time on a given Link
before timing out the link on the assumption that the connection is
broken or that the peer has crashed
|
IntegerProperty |
sdpMTU
The property "aspen.sdp.mtu" sets maximum transmission unit(MTU)
, in bytes, for frames within SDP.
|
IntegerProperty |
sdpNumberIoThreads
The property "aspen.sdp.numberIoThreads" sets maximum number of
IO threads used by the SDP network stack
|
IntegerProperty |
sdpNumberProcessingThreads
The property "aspen.sdp.numberProcessingThreads" sets maximum number of
IO threads used by the SDP network stack (only for CPP stack)
|
IntegerProperty |
sdpPort
The property "aspen.sdp.port" sets an optional
port for SDP.
|
IntegerProperty |
sdpPunctPingInterval
The property "aspen.sdp.punctPingInterval" sets the interval in msecs
between "punctuation pings", that is periodic output rowtime bounds
emitted automatically by the XO that implements an INSERT EXPEDITED
statement that has an implicit rowtime.
|
IntegerProperty |
sdpReceiveBlockCount
The property "aspen.sdp.rxblockcount" allows the configuration of the
SDP receive block count.
|
IntegerProperty |
sdpSocketRecvBufferSize
The property "aspen.sdp.socketSendBufferSize" sets maximum number of
bytes in the OSes receiving TCP buffer
|
IntegerProperty |
sdpSocketSendBufferSize
The property "aspen.sdp.socketSendBufferSize" sets maximum number of
bytes in the OSes sending TCP buffer
|
BooleanProperty |
sdpSslEnable
The property "aspen.sdp.tcpListenEnableSSL" Enables SSL/TLSv1.2
encryption on SDP connections
|
DoubleProperty |
sdpStreamWindowHighWaterMarkRatio
The property "aspen.sdp.streamWindowHighWaterMarkRatio"
Defines the ratio of the current window to the maximum window at which
point the window is published.
|
IntegerProperty |
sdpTcpConnectFailSleepMsMax
The property "aspen.sdp.tcpConnectFailSleepMsMax" sets minimum
amount of time to sleep between connection retrys
|
IntegerProperty |
sdpTcpConnectFailSleepMsMin
The property "aspen.sdp.tcpConnectFailSleepMsMin" sets minimum
amount of time to sleep between connection retrys
|
IntegerProperty |
sdpTcpListenFailSleepMs
The property "aspen.sdp.tcpListenFailSleepMs" sets minimum
amount of time to sleep between connection retrys
|
StringProperty |
serverMode
The "aspen.test.server.jvm" property controls where the aspen server is
executed.
|
BooleanProperty |
tcpListenEnableSSL
The property "aspen.sdp.tcpListenEnableSSL" optionally enables SSL
|
BooleanProperty |
tcpTrustAllSSL |
StringProperty |
tempDir
The "aspen.tmp.dir" property holds the name of the directory
under the server home that contains temporary files.
|
StringProperty |
tempTraceDir
The "aspen.tmp.trace.dir" property holds the name of the directory
under the general temp directory specifically meant to hold slices of
trace logs intended to be shipped across the network.
|
BooleanProperty |
testAll
The "aspen.test.all" property controls
whether to run all regression tests, ignoring any other filters.
|
IntegerProperty |
testingPort
The property "aspen.test.port" sets the base port for network TCP/SDP
tests.
|
StringProperty |
testName
The property "aspen.test.Name" is a pattern for
which regression tests to run.
|
BooleanProperty |
testNoisy
The "aspen.test.noisy" property controls
whether to run "noisy" tests, where timestamped entries identifying
each test method are written to the trace log before and after each
individual method is executed.
|
BooleanProperty |
testNoisyStdEcho
The "aspen.test.noisy.stdecho" property controls
whether to echo "noisy" test annotations to stdout and stderr.
|
IntegerProperty |
testNoisyTimeout
The "aspen.test.noisy.timeout" property controls how many minutes
NoisySuite's watchdog timer waits before deciding the tests have hung.
|
IntegerProperty |
testNumRows
The property "aspen.test.numrows" controls some unit tests: it sets the
scale of the test, by setting the number or rows read or written.
|
StringProperty |
testReferenceDir |
BooleanProperty |
testScriptsOnly
The "aspen.test.scripts.only" property controls
whether to run all the unit test or only UnitSql scripts
The default is "false", run all unit tests.
|
BooleanProperty |
testStress
The "aspen.test.stress" property controls
whether to run stress tests (while still honoring other filters).
|
BooleanProperty |
traceSampleFailedRows
The property "aspen.trace.sampleFailedRows" tells fennel how to report
input rows that cause a Calculator errow.
|
BooleanProperty |
traceSampleLateRows
The property "aspen.trace.sampleLateRows" tells fennel how to report late
input rows.
|
StringProperty |
udpAddress
The property "aspen.udp.address" allows nodes to determine which address
they should listen on for UDP connections.
|
IntegerProperty |
udpPort
The property "aspen.udp.port" allows nodes to determine which port they
should listen on for UDP connections.
|
BooleanProperty |
udxCheckMonotonicRowtimes
The property "aspen.udx.checkMonotonicRowtimes" causes the query planner
to add an EnforceRowtimeRel after each UDX call, in order to check that
the output stream of the UDX has non-decreasing (monotonic) rowtimes.
|
BooleanProperty |
useDoubleBuffering
The property aspen.aggregate.useResultBuffering controls
whether or not to use double buffering between xo's that
that don't allocate their own buffers.
|
StringProperty |
userbinDir
The "aspen.userbin.dir" property holds the name of the directory
under the server home that contains user binary files, such as scripts
for post-process cleanup.
|
BooleanProperty |
verify_fail_if_no_peer_cert
With SSL, require the client certificate , reject connection if verification fails
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
expandProperties(java.lang.String value)
Expands property tokens in a string, replacing them with property values,
if defined.
|
static java.lang.String |
getClusterKey() |
java.io.File |
getRmpTempDir() |
java.io.File |
getTempDir() |
java.io.File |
getUserbinDir() |
static AspenProperties |
instance()
Returns the
singleton instance. |
java.lang.String |
interpolate(java.lang.String base) |
void |
populate()
Loads this property set from its source files.
|
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values
public final BooleanProperty pluginPollPunct
public final BooleanProperty testAll
public final BooleanProperty testScriptsOnly
public final BooleanProperty testStress
public final BooleanProperty testNoisy
public final BooleanProperty testNoisyStdEcho
testNoisy
is true
.
The default is "false".public final IntegerProperty testNoisyTimeout
testNoisy
is true
.
The default is 30 mins.public final IntegerProperty testNumRows
public final BooleanProperty inToolContext
public final StringProperty catalogDir
public final StringProperty rmpTempDir
public final StringProperty tempDir
public final StringProperty tempTraceDir
public final StringProperty userbinDir
public final StringProperty customPropertiesUrl
The default value is "aspen.custom.properties". (We default to a non-url "plain" filename to allow later platform-based munging into a properly formed URL.)
public final StringProperty configUrl
The default value is "aspen.config". (We default to a non-url "plain" filename to allow later platform-based munging into a properly formed URL.
public final StringProperty jdbcDrivers
public final StringProperty mdrModelExt
public final StringProperty mdrPersistenceDir
public final StringProperty mdrImplementationType
public final StringProperty propertiesUrl
The default value is "aspen.properties". (We default to a non-url "plain" filename to allow later platform-based munging into properly formed URL.)
public final StringProperty reposUrl
public final StringProperty scottJdbcUrl
public final StringProperty serverMode
public final StringProperty testName
This is a regular expression as defined by
Pattern
.
If this property is specified, only tests whose names match the pattern
in its entirety will be run.
public final StringProperty catalogFile
public final DoubleProperty aggregateMaximumDeadBucketRatio
public final BooleanProperty aggregateUseResultBuffering
public final BooleanProperty nexusDeadlockDetection
public final IntegerProperty nexusMaximumBufferExpansion
public final BooleanProperty useDoubleBuffering
public final LongProperty maximumStreamSize
public final StringProperty sdpHost
public final IntegerProperty sdpPort
public final BooleanProperty tcpListenEnableSSL
public final StringProperty CApath
public final BooleanProperty verify_fail_if_no_peer_cert
public final StringProperty acceptFPs
public final StringProperty keyPassword
public final BooleanProperty tcpTrustAllSSL
public final IntegerProperty sdpMTU
public final IntegerProperty sdpLinkTimeoutMs
public final IntegerProperty sdpNumberIoThreads
public final IntegerProperty sdpNumberProcessingThreads
public final IntegerProperty sdpSocketSendBufferSize
public final IntegerProperty sdpSocketRecvBufferSize
public final IntegerProperty sdpTcpConnectFailSleepMsMin
public final IntegerProperty sdpTcpConnectFailSleepMsMax
public final IntegerProperty sdpTcpListenFailSleepMs
public final BooleanProperty onProtocolErrorThrowException
public final DoubleProperty sdpStreamWindowHighWaterMarkRatio
public final PersistentStringProperty nodeIdentifier
configUrl
and always persisted there.public final IntegerProperty nodeRedundancy
public final BooleanProperty failOnTooFewRmps
public IntegerProperty sdpPunctPingInterval
public final BooleanProperty sdpSslEnable
public final BooleanProperty sdpCompressionEnable
public IntegerProperty testingPort
public final StringProperty udpAddress
public final IntegerProperty udpPort
public StringProperty clusterIdentifier
public BooleanProperty clusterAutojoin
public final IntegerProperty sdpBlockSize
public final IntegerProperty sdpReceiveBlockCount
public final BooleanProperty devMode
public BooleanProperty udxCheckMonotonicRowtimes
public BooleanProperty traceSampleLateRows
public BooleanProperty traceSampleFailedRows
public final BooleanProperty schedParallel
public final StringProperty schedNthreads
public final BooleanProperty schedVerbose
public final DoubleProperty schedThrottle
public final DoubleProperty schedStatsPeriod
public final BooleanProperty schedStatsSnapshot
public final DoubleProperty schedStatsDiscardAfter
public final BooleanProperty schedStatsMayCountRows
public final StringProperty schedCheckerPeriod
public final StringProperty schedCheckerSavePeriod
public final StringProperty schedCheckerTimezone
public final StringProperty schedCheckerThrottle
public final StringProperty schedCheckerThrottleWhen
public final StringProperty schedCheckerThrottleAfter
public final StringProperty schedReporterPeriod
public final StringProperty installCompany
public final StringProperty installEmail
public final StringProperty installAwsaccount_id
public final StringProperty schedReporterURL
public final IntegerProperty schedHistory
public final IntegerProperty schedHistoryDetail
public final StringProperty schedDebugPrint
public final IntegerProperty schedDebugDetail
public final IntegerProperty schedDebugBacktrace
public final BooleanProperty schedDebugOnStop
public final BooleanProperty schedDebugAsserts
public final BooleanProperty schedDebugBreak
public final IntegerProperty schedTaskTimeout
public final BooleanProperty schedValidateGraphs
public final IntegerProperty schedOverlookPeriod
public final IntegerProperty schedDiamondDetectionPeriod
public final StringProperty schedLicensePath
public final BooleanProperty schedLicenseUseTrustedStorage
public final StringProperty sched_memoryChecker_memory_type
public final DoubleProperty sched_memoryChecker_memory_shutdownlimitRatio
public final DoubleProperty sched_memoryChecker_memory_warninglimitRatio
public final BooleanProperty sched_memoryChecker_shutdown_enabled
public final BooleanProperty sched_memoryChecker_warning_enabled
public final IntegerProperty schedLicenseCheckPeriod
public final BooleanProperty schedAddSlowCalcs
public final IntegerProperty schedAddSlowCalcsNCalcs
public final IntegerProperty schedAddSlowCalcsNPasses
public final BooleanProperty pumpManagerStartPumpsAtBoot
public final StringProperty blessedSchemaNames
public final StringProperty blessedPluginNames
public final IntegerProperty jdbcStressStmtsPerConn
public final IntegerProperty jdbcStressColsPerQuery
public final StringProperty productName
public final StringProperty jdbcDriverName
public final IntegerProperty jdbcDriverVersionMajor
public final IntegerProperty jdbcDriverVersionMinor
public final StringProperty testReferenceDir
public static AspenProperties instance()
singleton
instance.public static java.lang.String getClusterKey()
public java.io.File getRmpTempDir()
public java.io.File getTempDir()
public java.io.File getUserbinDir()
public java.lang.String interpolate(java.lang.String base)
public void populate()
public java.lang.String expandProperties(java.lang.String value)
FarragoProperties#expandProperties(String)
.
The Aspen version adds two "special" properties,
ASPEN_HOME
, which is a synonym for the system property
aspen.home.dir
, and ASPEN_CATALOG_DIR
.
value
- String to expandCopyright (C) 2003-2021 SQLstream, Inc.