EnvironmentImpl (starrocks-bdb-je 18.3.17 API)

java.lang.Object
- com.sleepycat.je.dbi.EnvironmentImpl

All Implemented Interfaces:

EnvConfigObserver

Direct Known Subclasses:

RepImpl
```
public class EnvironmentImpl
extends Object
implements EnvConfigObserver
```
Underlying Environment implementation. There is a single instance for any database environment opened by the application.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EnvironmentImpl.MBeanRegistrar` To support platforms that do not have any javax.management classes, we load JEMonitor dynamically to ensure that there are no explicit references to com.sleepycat.je.jmx.*.

Field Summary

Fields
Modifier and Type	Field and Description
`protected DbConfigManager`	`configManager`
`protected DbTree`	`dbMapTree`
`protected Environment`	`envInternal`
`protected Logger`	`envLogger`
`protected Formatter`	`formatter`
`protected boolean`	`needRepConvert`
`protected StartupTracker`	`startupTracker`
`protected Integer`	`statKey`
`protected StatManager`	`statManager`
`static boolean`	`USE_JAVA5_ADLER32`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`EnvironmentImpl(File envHome, EnvironmentConfig envConfig, EnvironmentImpl sharedCacheEnv)`
`protected`	`EnvironmentImpl(File envHome, EnvironmentConfig envConfig, EnvironmentImpl sharedCacheEnv, RepConfigProxy repConfigProxy)` Create a database environment to represent the data in envHome.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abnormalClose()` Used by error handling to forcibly close an environment, and by tests to close an environment to simulate a crash.
`void`	`addConfigObserver(EnvConfigObserver o)` Adds an observer of mutable config changes.
`boolean`	`addDbBackup(DbBackup backup)` For replicated environments only; just return true for a standalone environment.
`void`	`addToCompressorQueue(BIN bin)` Tells the asynchronous IN compressor thread about a BIN with a deleted entry.
`void`	`addToCompressorQueue(Collection<BINReference> binRefs)` Tells the asynchronous IN compressor thread about a collections of BINReferences with deleted entries.
`boolean`	`allowBlindOps()`
`boolean`	`allowBlindPuts()`
`protected void`	`appendException(PrintWriter pw, Exception e, String doingWhat)`
`VLSN`	`assignVLSNs(LogEntry entry)` Computes and assigns VLSNs as needed to this log item for a replicated log record.
`void`	`awaitVLSNConsistency()` Ensure that the in-memory vlsn index encompasses all logged entries before it is flushed to disk.
`void`	`checkDiskLimitViolation()` Uses cached disk usage info to determine whether disk space limits are currently violated.
`void`	`checkIfInvalid()`
`void`	`checkImmutablePropsForEquality(Properties handleConfigProps)` Throws an exception if an immutable property is changed.
`void`	`checkOpen()`
`void`	`checkRecordExtinctionAvailable()` Checks that using the record extinction feature.
`void`	`checkRulesForExistingEnv(boolean dbTreeReplicatedBit, boolean dbTreePreserveVLSN)` Check whether this environment can be opened on an existing environment directory.
`void`	`checkTTLAvailable()` Checks that writing records with a TTL is allowed.
`void`	`clearedCachedFileChecksum(String fileName)` Clears the cached checksum for a file when it may be overwritten (e.g., entries may be erased).
`EnvironmentConfig`	`cloneConfig()` Clones the current configuration.
`EnvironmentMutableConfig`	`cloneMutableConfig()` Clones the current mutable configuration.
`void`	`close()` Decrements the reference count and closes the environment when it reaches zero.
`void`	`close(boolean doCheckpoint)` Decrements the reference count and closes the environment when it reaches zero.
`void`	`closeAfterInvalid()`
`void`	`closeHandlers()`
`Provisional`	`coordinateWithCheckpoint(DatabaseImpl dbImpl, int targetLevel, IN parent)` Coordinates an eviction with an in-progress checkpoint and returns whether provisional logging is needed.
`OperationFailureException`	`createDatabasePreemptedException(String msg, String dbName, Database db)` For replicated environments only; only the overridden method should ever be called.
`protected Environment`	`createInternalEnvironment()` Is overridden in RepImpl to create a ReplicatedEnvironment.
`OperationFailureException`	`createLockPreemptedException(Locker locker, Throwable cause)` For replicated environments only; only the overridden method should ever be called.
`OperationFailureException`	`createLogOverwriteException(String msg)` For replicated environments only; only the overridden method should ever be called.
`Txn`	`createReplayTxn(long txnId)` For replicated environments only; only the overridden method should ever be called.
`ThreadLocker`	`createRepThreadLocker()` For replicated environments only; only the overridden method should ever be called.
`Txn`	`createRepTxn(TransactionConfig config, long mandatedId)` For replicated environments only; only the overridden method should ever be called.
`Txn`	`createRepUserTxn(TransactionConfig config)` For replicated environments only; only the overridden method should ever be called.
`StatManager`	`createStatManager()`
`void`	`criticalEviction(boolean backgroundIO)` Performs critical eviction if necessary.
`void`	`daemonEviction(boolean backgroundIO)` Do eviction if the memory budget is over.
`static void`	`decThreadLocalReferenceCount()`
`void`	`doCloseAfterInvalid()` This method must be called while synchronized on DbEnvPool.
`void`	`envConfigUpdate(DbConfigManager mgr, EnvironmentMutableConfig newConfig)` Respond to config updates.
`boolean`	`expiresWithin(int expiration, boolean hours, long withinMs)` Returns whether a given expiration time precedes the current system time plus withinMs, i.e., the expiration time will pass within withinMs, or earlier.
`boolean`	`expiresWithin(long expirationTime, long withinMs)` Same as `expiresWithin(int, boolean, long)` but with a single expirationTime param.
`boolean`	`finishInit(EnvironmentConfig envConfig)` Initialize the environment, including running recovery, if it is not already initialized.
`void`	`flushLog(boolean fsync)` Flush the log buffers and write to the log, and optionally fsync.
`long`	`forceLogFileFlip()` Flip the log to a new file, forcing an fsync.
`void`	`fullyInitialized()` Called after initialization is fully complete, including joinGroup in a replicated environment.
`static int`	`getAdler32ChunkSize()`
`boolean`	`getAllowRepConvert()` True if ReplicationConfig set allowConvert as true.
`protected int`	`getAppOpenCount()` Returns the count of environment handles that were opened explicitly by the application.
`protected int`	`getBackupCount()` Returns a count of the number of in-progress DbBackups.
`BackupManager`	`getBackupManager()`
`boolean`	`getCacheVLSN()` Returns true if the VLSN is both preserved and cached.
`Checkpointer`	`getCheckpointer()`
`ClassLoader`	`getClassLoader()`
`Cleaner`	`getCleaner()`
`int`	`getCompactMaxKeyLength()` Returns EnvironmentConfig.TREE_COMPACT_MAX_KEY_LENGTH.
`DbConfigManager`	`getConfigManager()` Returns the config manager for the current base configuration.
`Handler`	`getConfiguredHandler()`
`ReplicaConsistencyPolicy`	`getConsistencyPolicy(String propValue)` Allows standalone JE code to construct a consistency policy using the CONSISTENCY_POLICY property value format.
`ConsoleHandler`	`getConsoleHandler()`
`DataEraser`	`getDataEraser()`
`DataVerifier`	`getDataVerifier()`
`boolean`	`getDbEviction()` Returns whether DB/MapLN eviction is enabled.
`DbTree`	`getDbTree()`
`boolean`	`getDeadlockDetection()`
`long`	`getDeadlockDetectionDelay()`
`ReplicaConsistencyPolicy`	`getDefaultConsistencyPolicy()` Returns the default consistency policy for this EnvironmentImpl.
`protected String`	`getDiagnosticsClassName()`
`boolean`	`getDidFullThreadDump()`
`String`	`getDiskLimitViolation()` Uses cached disk usage info to determine whether disk space limits are currently violated.
`PreloadConfig`	`getDupConvertPreloadConfig()`
`long`	`getEndOfLog()` Returns the end of the log.
`File`	`getEnvironmentHome()` Get the environment home directory.
`Evictor`	`getEvictor()`
`ExceptionListener`	`getExceptionListener()`
`ExpirationProfile`	`getExpirationProfile()` Returns the ExpirationProfile.
`boolean`	`getExposeUserData()`
`ExtinctionScanner`	`getExtinctionScanner()`
`ExtinctionFilter.ExtinctionStatus`	`getExtinctionState(DatabaseImpl db, byte[] key)` Returns whether the given key in the given DB is extinct (can be purged by the cleaner) according to the extinction filter.
`ExtinctionFilter.ExtinctionStatus`	`getExtinctionState(String dbName, boolean dups, boolean isInternalDb, byte[] key)`
`static ExtinctionFilter.ExtinctionStatus`	`getExtinctionStatus(DatabaseImpl priDb, DatabaseEntry priKey)` Returns the extinction status for the purpose of adding to an exception message.
`FileHandler`	`getFileHandler()`
`FileManager`	`getFileManager()`
`FileProtector`	`getFileProtector()` Returns the FileProtector.
`INCompressor`	`getINCompressor()` Return the incompressor.
`int`	`getINCompressorQueueSize()`
`INList`	`getInMemoryINs()`
`Environment`	`getInternalEnvHandle()`
`EnvironmentFailureException`	`getInvalidatingException()`
`AtomicReference<EnvironmentFailureException>`	`getInvalidatingExceptionReference()`
`boolean`	`getIsMaster()` Returns whether this is a replicated environment that is the master, else false.
`int`	`getLatchTimeoutMs()` Returns EnvironmentConfig.ENV_LATCH_TIMEOUT.
`long`	`getLockTimeout()`
`LogFlusher`	`getLogFlusher()`
`Logger`	`getLogger()`
`LogManager`	`getLogManager()`
`int`	`getMaxEmbeddedLN()`
`MemoryBudget`	`getMemoryBudget()`
`MetadataStore`	`getMetadataStore()`
`protected String`	`getMonitorClassName()`
`String`	`getName()` Get an environment name, for tagging onto logging and debug message.
`boolean`	`getNoComparators()`
`String`	`getNodeName()` Get the node name if this is a replicated environment or else return null.
`NodeSequence`	`getNodeSequence()`
`OffHeapCache`	`getOffHeapCache()`
`String`	`getOptionalNodeName()` Named "optional" because the nodeName property in EnvironmentConfig is optional may be null.
`boolean`	`getPreserveVLSN()` Returns true if the VLSN is preserved as the record version.
`ProgressListener<RecoveryProgress>`	`getRecoveryProgressListener()`
`int`	`getReplayFreeDiskPercent()` Returns the deprecated HA REPLAY_FREE_DISK_PERCENT parameter, or zero if this is not an HA env.
`long`	`getReplayTxnTimeout()`
`Collection<StatGroup>`	`getRepStatGroups(StatsConfig config, Integer statkey)`
`ReservedFilesAutoRepair`	`getReservedFilesAutoRepair()`
`long`	`getRootLsn()`
`ReentrantReadWriteLock`	`getSecondaryAssociationLock()` Returns the shared secondary association latch.
`boolean`	`getSharedCache()`
`StartupTracker`	`getStartupTracker()`
`SortedSet<String>`	`getStatCaptureProjections()`
`static int`	`getThreadLocalReferenceCount()`
`AtomicLongStat`	`getThroughputStat(StatDefinition def)`
`int`	`getTtlClockTolerance()` Returns `EnvironmentParams.ENV_TTL_CLOCK_TOLERANCE`.
`int`	`getTtlLnPurgeDelay()` Returns `EnvironmentParams.ENV_TTL_LN_PURGE_DELAY`.
`int`	`getTtlMaxTxnTime()` Returns `EnvironmentParams.ENV_TTL_MAX_TXN_TIME`.
`TxnManager`	`getTxnManager()`
`long`	`getTxnTimeout()`
`UtilizationProfile`	`getUtilizationProfile()` Returns the UtilizationProfile.
`UtilizationTracker`	`getUtilizationTracker()` Returns the UtilizationTracker.
`VLSNRecoveryProxy`	`getVLSNProxy()`
`void`	`handleRestoreRequired(RestoreRequired restoreRequired)` Recovery encountered a RestoreRequired marker file, so recovery is halted and some intervention must be taken.
`boolean`	`hasExtinctionFilter()`
`void`	`incBinDeltaDeletes()`
`void`	`incBinDeltaGets()`
`void`	`incBinDeltaInserts()`
`void`	`incBinDeltaUpdates()`
`void`	`incDeleteFailOps(DatabaseImpl dbImpl)`
`void`	`incDeleteOps(DatabaseImpl dbImpl)`
`void`	`incInsertFailOps(DatabaseImpl dbImpl)`
`void`	`incInsertOps(DatabaseImpl dbImpl)`
`void`	`incPositionOps(DatabaseImpl dbImpl)`
`void`	`incRelatchesRequired()`
`void`	`incRootSplits()`
`void`	`incSearchFailOps(DatabaseImpl dbImpl)`
`void`	`incSearchOps(DatabaseImpl dbImpl)`
`static void`	`incThreadLocalReferenceCount()`
`void`	`incUpdateOps(DatabaseImpl dbImpl)`
`protected DbConfigManager`	`initConfigManager(EnvironmentConfig envConfig, RepConfigProxy repParams)` Create a config manager that holds the configuration properties that have been passed in.
`protected void`	`initConfigParams(EnvironmentConfig envConfig, RepConfigProxy repConfigProxy)` Init configuration params during environment creation.
`protected Formatter`	`initFormatter()`
`void`	`invalidate(EnvironmentFailureException e)` Invalidate the environment.
`void`	`invalidate(Error e)` Invalidate the environment when a Java Error is thrown.
`void`	`invokeCheckpoint(CheckpointConfig config, String invokingSource)` Invoke a checkpoint programmatically.
`int`	`invokeCleaner(boolean cleanMultipleFiles)`
`void`	`invokeCompressor()` Invoke a compress programmatically.
`void`	`invokeEvictor()`
`boolean`	`isArbiter()` Return true if this environment is used as an Arbiter.
`boolean`	`isClosed()`
`boolean`	`isClosing()`
`boolean`	`isDbLoggingDisabled()`
`boolean`	`isExpirationEnabled()` Returns `EnvironmentParams.ENV_EXPIRATION_ENABLED`.
`boolean`	`isExpired(int expiration, boolean hours)` Returns whether a given expiration time precedes the current system time, i.e., the expiration time has passed.
`boolean`	`isExpired(long expirationTime)` Returns whether a given expiration time precedes the current system time, i.e., the expiration time has passed.
`boolean`	`isInInit()`
`boolean`	`isMaster()`
`boolean`	`isMemOnly()`
`boolean`	`isNoLocking()`
`boolean`	`isReadOnly()`
`boolean`	`isRepConverted()` True if this environment is converted from non-replicated to replicated.
`boolean`	`isReplicated()` Return true if this environment is part of a replication group.
`boolean`	`isTransactional()`
`boolean`	`isValid()`
`void`	`lazyCompress(IN in)`
`void`	`lazyCompress(IN in, boolean compressDirtySlots)`
`EnvironmentStats`	`loadStats(StatsConfig config)` Retrieve and return stat information.
`EnvironmentStats`	`loadStatsInternal(StatsConfig config)` Retrieve and return stat information.
`LockStats`	`lockStat(StatsConfig config)` Retrieve lock statistics
`void`	`logMapTreeRoot()` Logs the map tree root and saves the LSN.
`void`	`logMapTreeRoot(long ifBeforeLsn)` Logs the map tree root, but only if its current LSN is before the ifBeforeLsn parameter or ifBeforeLsn is NULL_LSN.
`String`	`makeDaemonThreadName(String daemonName)`
`static boolean`	`maybeForceYield()` For stress testing.
`boolean`	`mayNotWrite()` When a EnvironmentFailureException occurs or the environment is closed, further writing can cause log corruption.
`boolean`	`needRepConvert()`
`void`	`noteBackupCopyFilesCount(int count)` Note the number of files copied to the archive by the most recent automatic backup.
`void`	`noteBackupCopyFilesMs(long timeMs)` Note the total amount of time in milliseconds taken to copy files to the archive by the most recent automatic backup.
`void`	`open()` Not much to do, mark state.
`protected void`	`postCheckpointClose(boolean checkpointed)` Release any resources from a subclass that need to be released after the closing checkpoint.
`protected void`	`postRecoveryConversion()` Called after recovery but before any other initialization.
`void`	`preCheckpointEndFlush()` Do any work that must be done before the checkpoint end is written, as as part of the checkpoint process.
`PreloadStats`	`preload(DatabaseImpl[] dbImpls, PreloadConfig config)`
`void`	`preRecoveryCheckpointInit(RecoveryInfo recoveryInfo)`
`void`	`readMapTreeFromLog(long rootLsn)` Set the mapping tree from the log.
`void`	`registerMBean(Environment env)` JE MBean registration is performed during Environment creation so that the MBean has access to the Environment API which is not available from EnvironmentImpl.
`void`	`registerVLSN(LogItem logItem)`
`void`	`removeConfigObserver(EnvConfigObserver o)` Removes an observer of mutable config changes.
`void`	`removeDbBackup(DbBackup backup)` For replicated environments only; do nothing for a standalone environment.
`void`	`requestShutdownDaemons()`
`protected DbConfigManager`	`resetConfigManager(EnvironmentConfig newConfig)` Make a new config manager that has all the properties needed.
`void`	`resetLoggingLevel(String changedLoggerName, Level level)` Reset the logging level for specified loggers in a JE environment.
`void`	`rewriteMapTreeRoot(long cleanerTargetLsn)` Force a rewrite of the map tree root if required.
`void`	`setBackgroundSleepHook(TestHook<?> hook)`
`void`	`setDidFullThreadDump(boolean val)`
`void`	`setLockTimeout(long timeout)`
`void`	`setMutableConfig(EnvironmentMutableConfig config)` Changes the mutable config properties that are present in the given config, and notifies all config observer.
`void`	`setReplicaLatestVLSNSeq(long seq)`
`protected void`	`setupClose(PrintWriter errors)` Release any resources from a subclass that need to be released before close is called on regular environment components.
`void`	`shutdownDaemons()` Ask all daemon threads to shut down.
`void`	`sleepAfterBackgroundIO()` If the sleep backlog is non-zero (set by updateBackgroundReads or updateBackgroundWrites), sleep for the configured interval and decrement the backlog.
`long`	`specialEviction()` Performs special eviction (eviction other than standard IN eviction) for this environment.
`boolean`	`tryTruncateVlsnHead(VLSN deleteEnd, long deleteFileNum)` Truncate the head of the VLSNIndex to unprotect the given file, if possible.
`boolean`	`tryVlsnHeadTruncate(long bytesNeeded)` Truncate the head of the VLSNIndex to allow file deletion, if possible.
`Txn`	`txnBegin(Transaction parent, TransactionConfig txnConfig)` Transactional services.
`TransactionStats`	`txnStat(StatsConfig config)` Retrieve txn statistics
`void`	`updateBackgroundReads(int nReads)` If a background read limit has been configured and that limit is exceeded when the cumulative total is incremented by the given number of reads, increment the sleep backlog to cause a sleep to occur.
`void`	`updateBackgroundWrites(int writeSize, int logBufferSize)` If a background write limit has been configured and that limit is exceeded when the given amount written is added to the cumulative total, increment the sleep backlog to cause a sleep to occur.
`boolean`	`useOffHeapChecksums()`
`void`	`verify(VerifyConfig config)`
`void`	`verifyCursors()`
`boolean`	`wasInvalidated()` Returns true if the environment is currently invalid or was invalidated and closed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - needRepConvert
```
protected boolean needRepConvert
```
  - dbMapTree
```
protected DbTree dbMapTree
```
  - configManager
```
protected DbConfigManager configManager
```
  - envLogger
```
protected final Logger envLogger
```
  - statManager
```
protected final StatManager statManager
```
  - startupTracker
```
protected final StartupTracker startupTracker
```
  - USE_JAVA5_ADLER32
```
public static final boolean USE_JAVA5_ADLER32
```
  - formatter
```
protected final Formatter formatter
```
  - envInternal
```
protected Environment envInternal
```
  - statKey
```
protected Integer statKey
```
- Constructor Detail
  - EnvironmentImpl
```
public EnvironmentImpl(File envHome,
                       EnvironmentConfig envConfig,
                       EnvironmentImpl sharedCacheEnv)
                throws EnvironmentNotFoundException,
                       EnvironmentLockedException
```
    Throws:
    
    EnvironmentNotFoundException
    
    EnvironmentLockedException
  - EnvironmentImpl
```
protected EnvironmentImpl(File envHome,
                          EnvironmentConfig envConfig,
                          EnvironmentImpl sharedCacheEnv,
                          RepConfigProxy repConfigProxy)
                   throws EnvironmentNotFoundException,
                          EnvironmentLockedException
```
    Create a database environment to represent the data in envHome. dbHome. Properties from the je.properties file in that directory are used to initialize the system wide property bag. Properties passed to this method are used to influence the open itself.
    
    Parameters:
    
    envHome - absolute path of the database environment home directory
    
    envConfig - is the configuration to be used. It's already had the je.properties file applied, and has been validated.
    
    sharedCacheEnv - if non-null, is another environment that is sharing the cache with this environment; if null, this environment is not sharing the cache or is the first environment to share the cache.
    
    Throws:
    
    DatabaseException - on all other failures
    
    IllegalArgumentException - via Environment ctor.
    
    EnvironmentNotFoundException
    
    EnvironmentLockedException
- Method Detail
  - initConfigManager
```
protected DbConfigManager initConfigManager(EnvironmentConfig envConfig,
                                            RepConfigProxy repParams)
```
    Create a config manager that holds the configuration properties that have been passed in. These properties are already validated, and have had the proper order of precedence applied; that is, the je.properties file has been applied. The configuration properties need to be available before the rest of environment creation proceeds. This method is overridden by replication environments.
    
    Parameters:
    
    envConfig - is the environment configuration to use
    
    repParams - are the replication configurations to use. In this case, the Properties bag has been extracted from the configuration instance, to avoid crossing the compilation firewall.
  - initConfigParams
```
protected void initConfigParams(EnvironmentConfig envConfig,
                                RepConfigProxy repConfigProxy)
```
    Init configuration params during environment creation. This method is overridden by RepImpl to get init params also. This allows certain rep params to be accessed from the EnvironmentImpl constructor using methods such as getPreserveVLSN. The overridden method calls this method first.
    
    Parameters:
    
    repConfigProxy - unused
  - finishInit
```
public boolean finishInit(EnvironmentConfig envConfig)
                   throws DatabaseException
```
    Initialize the environment, including running recovery, if it is not already initialized. Note that this method should be called even when opening additional handles for an already initialized environment. If initialization is still in progress then this method will block until it is finished.
    
    Returns:
    
    true if we are opening the first handle for this environment and recovery is run (when ENV_RECOVERY is configured to true); false if we are opening an additional handle and recovery is not run.
    
    Throws:
    
    DatabaseException
  - fullyInitialized
```
public void fullyInitialized()
```
    Called after initialization is fully complete, including joinGroup in a replicated environment. At this point, writes are allowed on a master.
  - createInternalEnvironment
```
protected Environment createInternalEnvironment()
```
    Is overridden in RepImpl to create a ReplicatedEnvironment.
  - registerMBean
```
public void registerMBean(Environment env)
                   throws DatabaseException
```
    JE MBean registration is performed during Environment creation so that the MBean has access to the Environment API which is not available from EnvironmentImpl. This precludes registering MBeans in EnvironmentImpl.finishInit.
    
    Throws:
    
    DatabaseException
  - getMonitorClassName
```
protected String getMonitorClassName()
```
  - getDiagnosticsClassName
```
protected String getDiagnosticsClassName()
```
  - getDefaultConsistencyPolicy
```
public ReplicaConsistencyPolicy getDefaultConsistencyPolicy()
```
    Returns the default consistency policy for this EnvironmentImpl. When a Txn is created directly for internal use, the default consistency is needed. For example, SyncDB uses this method. This method returns null for a standalone Environment, and returns the default consistency policy for a ReplicatedEnvironment.
  - getConsistencyPolicy
```
public ReplicaConsistencyPolicy getConsistencyPolicy(String propValue)
```
    Allows standalone JE code to construct a consistency policy using the CONSISTENCY_POLICY property value format. This method returns null for a standalone Environment, and returns the given consistency policy for a ReplicatedEnvironment.
  - getEndOfLog
```
public long getEndOfLog()
```
    Returns the end of the log. Returned value is a Lsn if it's a standalone Environment, otherwise it's a VLSN.
  - getRepStatGroups
```
public Collection<StatGroup> getRepStatGroups(StatsConfig config,
                                              Integer statkey)
```
  - getStatCaptureProjections
```
public SortedSet<String> getStatCaptureProjections()
```
  - createStatManager
```
public StatManager createStatManager()
```
  - envConfigUpdate
```
public void envConfigUpdate(DbConfigManager mgr,
                            EnvironmentMutableConfig newConfig)
```
    Respond to config updates.
    
    Specified by:
    
    envConfigUpdate in interface EnvConfigObserver
  - getINCompressor
```
public INCompressor getINCompressor()
```
    Return the incompressor. In general, don't use this directly because it's easy to forget that the incompressor can be null at times (i.e during the shutdown procedure. Instead, wrap the functionality within this class, like lazyCompress.
  - getFileProtector
```
public FileProtector getFileProtector()
```
    Returns the FileProtector.
  - getUtilizationTracker
```
public UtilizationTracker getUtilizationTracker()
```
    Returns the UtilizationTracker.
  - getUtilizationProfile
```
public UtilizationProfile getUtilizationProfile()
```
    Returns the UtilizationProfile.
  - getExpirationProfile
```
public ExpirationProfile getExpirationProfile()
```
    Returns the ExpirationProfile.
  - getCompactMaxKeyLength
```
public int getCompactMaxKeyLength()
```
    Returns EnvironmentConfig.TREE_COMPACT_MAX_KEY_LENGTH.
  - getLatchTimeoutMs
```
public int getLatchTimeoutMs()
```
    Returns EnvironmentConfig.ENV_LATCH_TIMEOUT.
  - getTtlClockTolerance
```
public int getTtlClockTolerance()
```
    Returns EnvironmentParams.ENV_TTL_CLOCK_TOLERANCE.
  - getTtlMaxTxnTime
```
public int getTtlMaxTxnTime()
```
    Returns EnvironmentParams.ENV_TTL_MAX_TXN_TIME.
  - getTtlLnPurgeDelay
```
public int getTtlLnPurgeDelay()
```
    Returns EnvironmentParams.ENV_TTL_LN_PURGE_DELAY.
  - updateBackgroundReads
```
public void updateBackgroundReads(int nReads)
```
    If a background read limit has been configured and that limit is exceeded when the cumulative total is incremented by the given number of reads, increment the sleep backlog to cause a sleep to occur. Called by background activities such as the cleaner after performing a file read operation.
    
    See Also:
    
    sleepAfterBackgroundIO()
  - updateBackgroundWrites
```
public void updateBackgroundWrites(int writeSize,
                                   int logBufferSize)
```
    If a background write limit has been configured and that limit is exceeded when the given amount written is added to the cumulative total, increment the sleep backlog to cause a sleep to occur. Called by background activities such as the checkpointer and evictor after performing a file write operation.
    The number of writes is estimated by dividing the bytes written by the log buffer size. Since the log write buffer is shared by all writers, this is the best approximation possible.
    
    See Also:
    
    sleepAfterBackgroundIO()
  - sleepAfterBackgroundIO
```
public void sleepAfterBackgroundIO()
```
    If the sleep backlog is non-zero (set by updateBackgroundReads or updateBackgroundWrites), sleep for the configured interval and decrement the backlog.
    If two threads call this method and the first call causes a sleep, the call by the second thread will block until the first thread's sleep interval is over. When the call by the second thread is unblocked, if another sleep is needed then the second thread will sleep again. In other words, when lots of sleeps are needed, background threads may backup. This is intended to give foreground threads a chance to "catch up" when background threads are doing a lot of IO.
  - setBackgroundSleepHook
```
public void setBackgroundSleepHook(TestHook<?> hook)
```
  - logMapTreeRoot
```
public void logMapTreeRoot()
                    throws DatabaseException
```
    Logs the map tree root and saves the LSN.
    
    Throws:
    
    DatabaseException
  - logMapTreeRoot
```
public void logMapTreeRoot(long ifBeforeLsn)
                    throws DatabaseException
```
    Logs the map tree root, but only if its current LSN is before the ifBeforeLsn parameter or ifBeforeLsn is NULL_LSN.
    
    Throws:
    
    DatabaseException
  - rewriteMapTreeRoot
```
public void rewriteMapTreeRoot(long cleanerTargetLsn)
                        throws DatabaseException
```
    Force a rewrite of the map tree root if required.
    
    Throws:
    
    DatabaseException
  - getRootLsn
```
public long getRootLsn()
```
    Returns:
    
    the mapping tree root LSN.
  - readMapTreeFromLog
```
public void readMapTreeFromLog(long rootLsn)
                        throws DatabaseException
```
    Set the mapping tree from the log. Called during recovery.
    
    Throws:
    
    DatabaseException
  - addToCompressorQueue
```
public void addToCompressorQueue(BIN bin)
```
    Tells the asynchronous IN compressor thread about a BIN with a deleted entry.
  - addToCompressorQueue
```
public void addToCompressorQueue(Collection<BINReference> binRefs)
```
    Tells the asynchronous IN compressor thread about a collections of BINReferences with deleted entries.
  - lazyCompress
```
public void lazyCompress(IN in)
```
  - lazyCompress
```
public void lazyCompress(IN in,
                         boolean compressDirtySlots)
```
  - resetLoggingLevel
```
public void resetLoggingLevel(String changedLoggerName,
                              Level level)
```
    Reset the logging level for specified loggers in a JE environment.
    
    Throws:
    
    IllegalArgumentException - via JEDiagnostics.OP_RESET_LOGGING
  - initFormatter
```
protected Formatter initFormatter()
```
  - getConsoleHandler
```
public ConsoleHandler getConsoleHandler()
```
  - getFileHandler
```
public FileHandler getFileHandler()
```
  - getConfiguredHandler
```
public Handler getConfiguredHandler()
```
  - closeHandlers
```
public void closeHandlers()
```
  - open
```
public void open()
```
    Not much to do, mark state.
  - invalidate
```
public void invalidate(EnvironmentFailureException e)
```
    Invalidate the environment. Done when a fatal exception (EnvironmentFailureException) is thrown.
  - getInvalidatingException
```
public EnvironmentFailureException getInvalidatingException()
```
  - getInvalidatingExceptionReference
```
public AtomicReference<EnvironmentFailureException> getInvalidatingExceptionReference()
```
  - invalidate
```
public void invalidate(Error e)
```
    Invalidate the environment when a Java Error is thrown.
  - wasInvalidated
```
public boolean wasInvalidated()
```
    Returns true if the environment is currently invalid or was invalidated and closed.
  - isValid
```
public boolean isValid()
```
    Returns:
    
    true if environment is fully open (not being constructed and not closed), and has not been invalidated by an EnvironmentFailureException.
  - isInInit
```
public boolean isInInit()
```
    Returns:
    
    true if environment is still in init
  - isClosing
```
public boolean isClosing()
```
    Returns:
    
    true if close has begun, although the state may still be open.
  - isClosed
```
public boolean isClosed()
```
  - mayNotWrite
```
public boolean mayNotWrite()
```
    When a EnvironmentFailureException occurs or the environment is closed, further writing can cause log corruption.
  - checkIfInvalid
```
public void checkIfInvalid()
                    throws EnvironmentFailureException
```
    Throws:
    
    EnvironmentFailureException
  - checkOpen
```
public void checkOpen()
               throws DatabaseException
```
    Throws:
    
    DatabaseException
  - close
```
public void close()
           throws DatabaseException
```
    Decrements the reference count and closes the environment when it reaches zero. A checkpoint is always performed when closing.
    
    Throws:
    
    DatabaseException
  - close
```
public void close(boolean doCheckpoint)
           throws DatabaseException
```
    Decrements the reference count and closes the environment when it reaches zero. A checkpoint when closing is optional.
    
    Throws:
    
    DatabaseException
  - abnormalClose
```
public void abnormalClose()
                   throws DatabaseException
```
    Used by error handling to forcibly close an environment, and by tests to close an environment to simulate a crash. Database handles do not have to be closed before calling this method. A checkpoint is not performed.
    
    Throws:
    
    DatabaseException
  - appendException
```
protected void appendException(PrintWriter pw,
                               Exception e,
                               String doingWhat)
```
  - setupClose
```
protected void setupClose(PrintWriter errors)
                   throws DatabaseException
```
    Release any resources from a subclass that need to be released before close is called on regular environment components.
    
    Throws:
    
    DatabaseException
  - postCheckpointClose
```
protected void postCheckpointClose(boolean checkpointed)
                            throws DatabaseException
```
    Release any resources from a subclass that need to be released after the closing checkpoint.
    
    Parameters:
    
    checkpointed - if true, a checkpoint as issued before the close
    
    Throws:
    
    DatabaseException
  - postRecoveryConversion
```
protected void postRecoveryConversion()
```
    Called after recovery but before any other initialization. Is overridden by ReplImpl to convert user defined databases to replicated after doing recovery.
  - closeAfterInvalid
```
public void closeAfterInvalid()
                       throws DatabaseException
```
    Throws:
    
    DatabaseException
  - doCloseAfterInvalid
```
public void doCloseAfterInvalid()
```
    This method must be called while synchronized on DbEnvPool.
  - getAppOpenCount
```
protected int getAppOpenCount()
```
    Returns the count of environment handles that were opened explicitly by the application. Because the internal environment handle is not included in the openCount, this method is currently equivalent to getOpenCount.
    
    Returns:
    
    the count of open application handles
  - getBackupCount
```
protected int getBackupCount()
```
    Returns a count of the number of in-progress DbBackups.
  - getThreadLocalReferenceCount
```
public static int getThreadLocalReferenceCount()
```
  - incThreadLocalReferenceCount
```
public static void incThreadLocalReferenceCount()
```
  - decThreadLocalReferenceCount
```
public static void decThreadLocalReferenceCount()
```
  - getDidFullThreadDump
```
public boolean getDidFullThreadDump()
```
  - setDidFullThreadDump
```
public void setDidFullThreadDump(boolean val)
```
  - getNoComparators
```
public boolean getNoComparators()
```
  - invokeCheckpoint
```
public void invokeCheckpoint(CheckpointConfig config,
                             String invokingSource)
```
    Invoke a checkpoint programmatically. Note that only one checkpoint may run at a time.
  - coordinateWithCheckpoint
```
public Provisional coordinateWithCheckpoint(DatabaseImpl dbImpl,
                                            int targetLevel,
                                            IN parent)
```
    Coordinates an eviction with an in-progress checkpoint and returns whether provisional logging is needed.
    
    Returns:
    
    the provisional status to use for logging the target.
  - flushLog
```
public void flushLog(boolean fsync)
```
    Flush the log buffers and write to the log, and optionally fsync. [#19111]
  - forceLogFileFlip
```
public long forceLogFileFlip()
                      throws DatabaseException
```
    Flip the log to a new file, forcing an fsync. Return the LSN of the trace record in the new file.
    
    Throws:
    
    DatabaseException
  - invokeCompressor
```
public void invokeCompressor()
```
    Invoke a compress programmatically. Note that only one compress may run at a time.
  - invokeEvictor
```
public void invokeEvictor()
```
  - invokeCleaner
```
public int invokeCleaner(boolean cleanMultipleFiles)
```
    Throws:
    
    UnsupportedOperationException - if read-only or mem-only.
  - requestShutdownDaemons
```
public void requestShutdownDaemons()
```
  - shutdownDaemons
```
public void shutdownDaemons()
```
    Ask all daemon threads to shut down.
  - isNoLocking
```
public boolean isNoLocking()
```
  - isTransactional
```
public boolean isTransactional()
```
  - isReadOnly
```
public boolean isReadOnly()
```
  - isMemOnly
```
public boolean isMemOnly()
```
  - getOptionalNodeName
```
public String getOptionalNodeName()
```
    Named "optional" because the nodeName property in EnvironmentConfig is optional may be null. getName() should almost always be used instead for messages, exceptions, etc.
  - makeDaemonThreadName
```
public String makeDaemonThreadName(String daemonName)
```
  - getDbEviction
```
public boolean getDbEviction()
```
    Returns whether DB/MapLN eviction is enabled.
  - getAdler32ChunkSize
```
public static int getAdler32ChunkSize()
```
  - getSharedCache
```
public boolean getSharedCache()
```
  - allowBlindOps
```
public boolean allowBlindOps()
```
  - allowBlindPuts
```
public boolean allowBlindPuts()
```
  - getMaxEmbeddedLN
```
public int getMaxEmbeddedLN()
```
  - txnBegin
```
public Txn txnBegin(Transaction parent,
                    TransactionConfig txnConfig)
             throws DatabaseException
```
    Transactional services.
    
    Throws:
    
    DatabaseException
  - getLogManager
```
public LogManager getLogManager()
```
  - getLogFlusher
```
public LogFlusher getLogFlusher()
```
  - getDataVerifier
```
public DataVerifier getDataVerifier()
```
  - getFileManager
```
public FileManager getFileManager()
```
  - getDbTree
```
public DbTree getDbTree()
```
  - getMetadataStore
```
public MetadataStore getMetadataStore()
```
  - getConfigManager
```
public DbConfigManager getConfigManager()
```
    Returns the config manager for the current base configuration.
    The configuration can change, but changes are made by replacing the config manager object with a enw one. To use a consistent set of properties, call this method once and query the returned manager repeatedly for each property, rather than getting the config manager via this method for each property individually.
  - getNodeSequence
```
public NodeSequence getNodeSequence()
```
  - cloneConfig
```
public EnvironmentConfig cloneConfig()
```
    Clones the current configuration.
  - cloneMutableConfig
```
public EnvironmentMutableConfig cloneMutableConfig()
```
    Clones the current mutable configuration.
  - checkImmutablePropsForEquality
```
public void checkImmutablePropsForEquality(Properties handleConfigProps)
                                    throws IllegalArgumentException
```
    Throws an exception if an immutable property is changed.
    
    Throws:
    
    IllegalArgumentException
  - setMutableConfig
```
public void setMutableConfig(EnvironmentMutableConfig config)
                      throws DatabaseException
```
    Changes the mutable config properties that are present in the given config, and notifies all config observer.
    
    Throws:
    
    DatabaseException
  - resetConfigManager
```
protected DbConfigManager resetConfigManager(EnvironmentConfig newConfig)
```
    Make a new config manager that has all the properties needed. More complicated for subclasses.
  - getExceptionListener
```
public ExceptionListener getExceptionListener()
```
  - addConfigObserver
```
public void addConfigObserver(EnvConfigObserver o)
```
    Adds an observer of mutable config changes.
  - removeConfigObserver
```
public void removeConfigObserver(EnvConfigObserver o)
```
    Removes an observer of mutable config changes.
  - getInMemoryINs
```
public INList getInMemoryINs()
```
  - getTxnManager
```
public TxnManager getTxnManager()
```
  - getCheckpointer
```
public Checkpointer getCheckpointer()
```
  - getCleaner
```
public Cleaner getCleaner()
```
  - getDataEraser
```
public DataEraser getDataEraser()
```
  - getBackupManager
```
public BackupManager getBackupManager()
```
  - getReservedFilesAutoRepair
```
public ReservedFilesAutoRepair getReservedFilesAutoRepair()
```
  - getMemoryBudget
```
public MemoryBudget getMemoryBudget()
```
  - getDiskLimitViolation
```
public String getDiskLimitViolation()
```
    Uses cached disk usage info to determine whether disk space limits are currently violated. This method simply returns a volatile field. The cached information is updated frequently enough to prevent violating the limits by a large amount.
    
    Returns:
    
    a non-null message (appropriate for an exception) if a disk limit is currently violated, else null.
  - checkDiskLimitViolation
```
public void checkDiskLimitViolation()
                             throws DiskLimitException
```
    Uses cached disk usage info to determine whether disk space limits are currently violated. This method simply checks a volatile field. The cached information is updated frequently enough to prevent violating the limits by a large amount.
    
    Throws:
    
    DiskLimitException - if a disk limit is currently violated.
  - getLogger
```
public Logger getLogger()
```
    Returns:
    
    environment Logger, for use in debugging output.
  - isDbLoggingDisabled
```
public boolean isDbLoggingDisabled()
```
  - verify
```
public void verify(VerifyConfig config)
            throws DatabaseException
```
    Throws:
    
    DatabaseException
  - verifyCursors
```
public void verifyCursors()
                   throws DatabaseException
```
    Throws:
    
    DatabaseException
  - getExposeUserData
```
public boolean getExposeUserData()
```
  - loadStats
```
public EnvironmentStats loadStats(StatsConfig config)
                           throws DatabaseException
```
    Retrieve and return stat information.
    
    Throws:
    
    DatabaseException
  - loadStatsInternal
```
public EnvironmentStats loadStatsInternal(StatsConfig config)
                                   throws DatabaseException
```
    Retrieve and return stat information.
    
    Throws:
    
    DatabaseException
  - incSearchOps
```
public void incSearchOps(DatabaseImpl dbImpl)
```
  - incSearchFailOps
```
public void incSearchFailOps(DatabaseImpl dbImpl)
```
  - incPositionOps
```
public void incPositionOps(DatabaseImpl dbImpl)
```
  - incInsertOps
```
public void incInsertOps(DatabaseImpl dbImpl)
```
  - incInsertFailOps
```
public void incInsertFailOps(DatabaseImpl dbImpl)
```
  - incUpdateOps
```
public void incUpdateOps(DatabaseImpl dbImpl)
```
  - incDeleteOps
```
public void incDeleteOps(DatabaseImpl dbImpl)
```
  - incDeleteFailOps
```
public void incDeleteFailOps(DatabaseImpl dbImpl)
```
  - incRootSplits
```
public void incRootSplits()
```
  - incRelatchesRequired
```
public void incRelatchesRequired()
```
  - incBinDeltaGets
```
public void incBinDeltaGets()
```
  - incBinDeltaInserts
```
public void incBinDeltaInserts()
```
  - incBinDeltaUpdates
```
public void incBinDeltaUpdates()
```
  - incBinDeltaDeletes
```
public void incBinDeltaDeletes()
```
  - addDbBackup
```
public boolean addDbBackup(DbBackup backup)
```
    For replicated environments only; just return true for a standalone environment.
  - removeDbBackup
```
public void removeDbBackup(DbBackup backup)
```
    For replicated environments only; do nothing for a standalone environment.
  - noteBackupCopyFilesCount
```
public void noteBackupCopyFilesCount(int count)
```
    Note the number of files copied to the archive by the most recent automatic backup.
    
    Parameters:
    
    count - the number of files copied
  - noteBackupCopyFilesMs
```
public void noteBackupCopyFilesMs(long timeMs)
```
    Note the total amount of time in milliseconds taken to copy files to the archive by the most recent automatic backup.
    
    Parameters:
    
    timeMs - the total copy time in milliseconds
  - lockStat
```
public LockStats lockStat(StatsConfig config)
                   throws DatabaseException
```
    Retrieve lock statistics
    
    Throws:
    
    DatabaseException
  - txnStat
```
public TransactionStats txnStat(StatsConfig config)
```
    Retrieve txn statistics
  - getINCompressorQueueSize
```
public int getINCompressorQueueSize()
```
  - getStartupTracker
```
public StartupTracker getStartupTracker()
```
  - getEnvironmentHome
```
public File getEnvironmentHome()
```
    Get the environment home directory.
  - getInternalEnvHandle
```
public Environment getInternalEnvHandle()
```
  - getName
```
public String getName()
```
    Get an environment name, for tagging onto logging and debug message. Useful for multiple environments in a JVM, or for HA.
  - getNodeName
```
public String getNodeName()
```
    Get the node name if this is a replicated environment or else return null.
  - getIsMaster
```
public boolean getIsMaster()
```
    Returns whether this is a replicated environment that is the master, else false.
  - getTxnTimeout
```
public long getTxnTimeout()
```
  - getLockTimeout
```
public long getLockTimeout()
```
  - setLockTimeout
```
public void setLockTimeout(long timeout)
```
  - getDeadlockDetection
```
public boolean getDeadlockDetection()
```
  - getDeadlockDetectionDelay
```
public long getDeadlockDetectionDelay()
```
  - getReplayTxnTimeout
```
public long getReplayTxnTimeout()
```
  - getSecondaryAssociationLock
```
public ReentrantReadWriteLock getSecondaryAssociationLock()
```
    Returns the shared secondary association latch.
  - getOffHeapCache
```
public OffHeapCache getOffHeapCache()
```
    Returns:
    
    null if no off-heap cache is configured.
  - useOffHeapChecksums
```
public boolean useOffHeapChecksums()
```
  - isExpirationEnabled
```
public boolean isExpirationEnabled()
```
    Returns EnvironmentParams.ENV_EXPIRATION_ENABLED.
  - isExpired
```
public boolean isExpired(int expiration,
                         boolean hours)
```
    Returns whether a given expiration time precedes the current system time, i.e., the expiration time has passed.
  - isExpired
```
public boolean isExpired(long expirationTime)
```
    Returns whether a given expiration time precedes the current system time, i.e., the expiration time has passed.
  - expiresWithin
```
public boolean expiresWithin(int expiration,
                             boolean hours,
                             long withinMs)
```
    Returns whether a given expiration time precedes the current system time plus withinMs, i.e., the expiration time will pass within withinMs, or earlier. If withinMs is negative, this is whether the expiration time passed withinMs ago, or earlier.
  - expiresWithin
```
public boolean expiresWithin(long expirationTime,
                             long withinMs)
```
    Same as expiresWithin(int, boolean, long) but with a single expirationTime param.
  - getExtinctionScanner
```
public ExtinctionScanner getExtinctionScanner()
```
  - getExtinctionStatus
```
public static ExtinctionFilter.ExtinctionStatus getExtinctionStatus(DatabaseImpl priDb,
                                                                    DatabaseEntry priKey)
```
    Returns the extinction status for the purpose of adding to an exception message. Null is returned if either param is null.
  - getExtinctionState
```
public ExtinctionFilter.ExtinctionStatus getExtinctionState(DatabaseImpl db,
                                                            byte[] key)
```
    Returns whether the given key in the given DB is extinct (can be purged by the cleaner) according to the extinction filter.
  - getExtinctionState
```
public ExtinctionFilter.ExtinctionStatus getExtinctionState(String dbName,
                                                            boolean dups,
                                                            boolean isInternalDb,
                                                            byte[] key)
```
  - hasExtinctionFilter
```
public boolean hasExtinctionFilter()
```
  - getEvictor
```
public Evictor getEvictor()
```
  - criticalEviction
```
public void criticalEviction(boolean backgroundIO)
```
    Performs critical eviction if necessary. Is called before and after each cursor operation. We prefer to have the application thread do as little eviction as possible, to reduce the impact on latency, so critical eviction has an explicit set of criteria for determining when this should run. WARNING: The action performed here should be as inexpensive as possible, since it will impact app operation latency. Unconditional synchronization must not be performed, since that would introduce a new synchronization point for all app threads. An overriding method must call super.criticalEviction. No latches are held or synchronization is in use when this method is called.
  - daemonEviction
```
public void daemonEviction(boolean backgroundIO)
```
    Do eviction if the memory budget is over. Called by JE daemon threads that do not have the same latency concerns as application threads.
  - specialEviction
```
public long specialEviction()
```
    Performs special eviction (eviction other than standard IN eviction) for this environment. This method is called once per eviction batch to give other components an opportunity to perform eviction. For a shared cached, it is called for only one environment (in rotation) per batch. An overriding method must call super.specialEviction and return the sum of the long value it returns and any additional amount of budgeted memory that is evicted. No latches are held when this method is called, but it is called while synchronized on the evictor.
    
    Returns:
    
    the number of bytes evicted from the JE cache.
  - maybeForceYield
```
public static boolean maybeForceYield()
```
    For stress testing. Should only ever be called from an assert.
  - isReplicated
```
public boolean isReplicated()
```
    Return true if this environment is part of a replication group.
  - isArbiter
```
public boolean isArbiter()
```
    Return true if this environment is used as an Arbiter.
  - getPreserveVLSN
```
public boolean getPreserveVLSN()
```
    Returns true if the VLSN is preserved as the record version. Always false in a standalone environment. Overridden by RepImpl.
  - getCacheVLSN
```
public boolean getCacheVLSN()
```
    Returns true if the VLSN is both preserved and cached. Always false in a standalone environment. Overridden by RepImpl.
  - getAllowRepConvert
```
public boolean getAllowRepConvert()
```
    True if ReplicationConfig set allowConvert as true. Standalone environment is prohibited from doing a conversion, return false.
  - isRepConverted
```
public boolean isRepConverted()
```
    True if this environment is converted from non-replicated to replicated.
  - needRepConvert
```
public boolean needRepConvert()
```
  - assignVLSNs
```
public VLSN assignVLSNs(LogEntry entry)
```
    Computes and assigns VLSNs as needed to this log item for a replicated log record. This method must be invoked under the LWL to ensure that the VLSNs it generates are correctly serialized with respect to their locations in the log. The method must be invoked before any calls are made to determine the log entry size, since some of the underlying values used to determine the size of the entry will only be finalized after this call has completed. This method is only invoked when the log is being written as the master, since the replica merely reuses the VLSN values computed by the master. Since this method is being written under the LWL it must not block.
    
    Parameters:
    
    entry - the log entry, an in/out argument: the entry is modified with an updated DTVLSN for commit and abort log entries.
    
    Returns:
    
    a non-null VLSN for all replicated log items
  - getVLSNProxy
```
public VLSNRecoveryProxy getVLSNProxy()
```
  - isMaster
```
public boolean isMaster()
```
  - preRecoveryCheckpointInit
```
public void preRecoveryCheckpointInit(RecoveryInfo recoveryInfo)
```
  - registerVLSN
```
public void registerVLSN(LogItem logItem)
```
  - tryVlsnHeadTruncate
```
public boolean tryVlsnHeadTruncate(long bytesNeeded)
```
    Truncate the head of the VLSNIndex to allow file deletion, if possible.
  - tryTruncateVlsnHead
```
public boolean tryTruncateVlsnHead(VLSN deleteEnd,
                                   long deleteFileNum)
```
    Truncate the head of the VLSNIndex to unprotect the given file, if possible.
  - clearedCachedFileChecksum
```
public void clearedCachedFileChecksum(String fileName)
```
    Clears the cached checksum for a file when it may be overwritten (e.g., entries may be erased).
  - preCheckpointEndFlush
```
public void preCheckpointEndFlush()
```
    Do any work that must be done before the checkpoint end is written, as as part of the checkpoint process.
  - createReplayTxn
```
public Txn createReplayTxn(long txnId)
```
    For replicated environments only; only the overridden method should ever be called.
  - createRepThreadLocker
```
public ThreadLocker createRepThreadLocker()
```
    For replicated environments only; only the overridden method should ever be called.
  - createRepUserTxn
```
public Txn createRepUserTxn(TransactionConfig config)
```
    For replicated environments only; only the overridden method should ever be called.
  - createRepTxn
```
public Txn createRepTxn(TransactionConfig config,
                        long mandatedId)
```
    For replicated environments only; only the overridden method should ever be called.
  - createLockPreemptedException
```
public OperationFailureException createLockPreemptedException(Locker locker,
                                                              Throwable cause)
```
    For replicated environments only; only the overridden method should ever be called.
  - createDatabasePreemptedException
```
public OperationFailureException createDatabasePreemptedException(String msg,
                                                                  String dbName,
                                                                  Database db)
```
    For replicated environments only; only the overridden method should ever be called.
  - createLogOverwriteException
```
public OperationFailureException createLogOverwriteException(String msg)
```
    For replicated environments only; only the overridden method should ever be called.
  - getReplayFreeDiskPercent
```
public int getReplayFreeDiskPercent()
```
    Returns the deprecated HA REPLAY_FREE_DISK_PERCENT parameter, or zero if this is not an HA env.
  - checkRulesForExistingEnv
```
public void checkRulesForExistingEnv(boolean dbTreeReplicatedBit,
                                     boolean dbTreePreserveVLSN)
                              throws UnsupportedOperationException
```
    Check whether this environment can be opened on an existing environment directory.
    
    Parameters:
    
    dbTreePreserveVLSN -
    
    Throws:
    
    UnsupportedOperationException - via Environment ctor.
  - awaitVLSNConsistency
```
public void awaitVLSNConsistency()
```
    Ensure that the in-memory vlsn index encompasses all logged entries before it is flushed to disk. A No-Op for non-replicated systems. [#19754]
  - getThroughputStat
```
public AtomicLongStat getThroughputStat(StatDefinition def)
```
  - preload
```
public PreloadStats preload(DatabaseImpl[] dbImpls,
                            PreloadConfig config)
                     throws DatabaseException
```
    Throws:
    
    DatabaseException
  - getRecoveryProgressListener
```
public ProgressListener<RecoveryProgress> getRecoveryProgressListener()
```
  - getClassLoader
```
public ClassLoader getClassLoader()
```
  - getDupConvertPreloadConfig
```
public PreloadConfig getDupConvertPreloadConfig()
```
  - checkTTLAvailable
```
public void checkTTLAvailable()
```
    Checks that writing records with a TTL is allowed.
    
    Throws:
    
    IllegalStateException - if any node in the group is less than TTL.MIN_JE_VERSION.
  - checkRecordExtinctionAvailable
```
public void checkRecordExtinctionAvailable()
```
    Checks that using the record extinction feature.
    
    Throws:
    
    IllegalStateException - if any node in the group is less than ExtinctionScanner.MIN_JE_VERSION.
  - handleRestoreRequired
```
public void handleRestoreRequired(RestoreRequired restoreRequired)
```
    Recovery encountered a RestoreRequired marker file, so recovery is halted and some intervention must be taken.
    
    Parameters:
    
    restoreRequired - getFailureType() is used to indicate the how the environment can be healed.
  - setReplicaLatestVLSNSeq
```
public void setReplicaLatestVLSNSeq(long seq)
```

Class EnvironmentImpl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

needRepConvert

dbMapTree

configManager

envLogger

statManager

startupTracker

USE_JAVA5_ADLER32

formatter

envInternal

statKey

Constructor Detail

EnvironmentImpl

EnvironmentImpl

Method Detail

initConfigManager

initConfigParams

finishInit

fullyInitialized

createInternalEnvironment

registerMBean

getMonitorClassName

getDiagnosticsClassName

getDefaultConsistencyPolicy

getConsistencyPolicy

getEndOfLog

getRepStatGroups

getStatCaptureProjections

createStatManager

envConfigUpdate

getINCompressor

getFileProtector

getUtilizationTracker

getUtilizationProfile

getExpirationProfile

getCompactMaxKeyLength

getLatchTimeoutMs

getTtlClockTolerance

getTtlMaxTxnTime

getTtlLnPurgeDelay

updateBackgroundReads

updateBackgroundWrites

sleepAfterBackgroundIO

setBackgroundSleepHook

logMapTreeRoot

logMapTreeRoot

rewriteMapTreeRoot

getRootLsn

readMapTreeFromLog

addToCompressorQueue

addToCompressorQueue

lazyCompress

lazyCompress

resetLoggingLevel

initFormatter

getConsoleHandler

getFileHandler

getConfiguredHandler

closeHandlers

open

invalidate

getInvalidatingException

getInvalidatingExceptionReference

invalidate

wasInvalidated

isValid

isInInit

isClosing

isClosed

mayNotWrite

checkIfInvalid

checkOpen

close

close