JournalManagerMXBean (org.openidentityplatform.commons.parent 2.2.3 Documentation)

```
@MXBean
public interface JournalManagerMXBean
```
Management interface to the JournalManager, including journal file names and file positions. Of particular interest are getCurrentAddress() and getBaseAddress(). The difference between these represents the degree to which JOURNAL_COPIER has fallen behind recent updates.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_BLOCK_SIZE` Default size of one journal file (10E9).
`static int`	`DEFAULT_BUFFER_SIZE` Default, minimum and maximum size of journal write buffer.
`static long`	`DEFAULT_COPIER_INTERVAL_MS` Default time interval (in milliseconds) between calls to the journal copier method.
`static int`	`DEFAULT_COPIES_PER_CYCLE` Default value for maximum pages to be copied per cycle.
`static int`	`DEFAULT_COPY_BUFFER_SIZE` Default size of journal read buffer.
`static long`	`DEFAULT_FLUSH_INTERVAL_MS` Default time interval (in milliseconds) between calls to the FileChannel.force() method.
`static String`	`DEFAULT_JOURNAL_FILE_NAME` File name appended when journal path specifies only a directory
`static long`	`DEFAULT_LOG_REPEAT_INTERVAL_MS` Default time interval (in milliseconds) for logging repetitive I/O exceptions on attempts to write to the journal.
`static long`	`DEFAULT_SLOW_IO_ALERT_THRESHOLD_MS` Default threshold time in milliseconds for JournalManager flush operations.
`static int`	`DEFAULT_URGENT_FILE_COUNT_THRESHOLD` Default journal file count at which transactions are throttled to allow copier to catch up.
`static long`	`MAXIMUM_BLOCK_SIZE` Maximum permitted journal file size.
`static int`	`MAXIMUM_BUFFER_SIZE`
`static int`	`MAXIMUM_CONCURRENT_TRANSACTIONS`
`static long`	`MAXIMUM_LOG_REPEAT_INTERVAL_MS`
`static long`	`MAXIMUM_SLOW_ALERT_THRESHOLD_MS`
`static int`	`MAXIMUM_URGENT_FILE_COUNT_THRESHOLD`
`static long`	`MINIMUM_BLOCK_SIZE` Minimum permitted journal file size.
`static int`	`MINIMUM_BUFFER_SIZE`
`static long`	`MINIMUM_LOG_REPEAT_INTERVAL_MS`
`static long`	`MINIMUM_SLOW_ALERT_THRESHOLD_MS`
`static int`	`MINIMUM_URGENT_FILE_COUNT_THRESHOLD`
`static String`	`MXBEAN_NAME`
`static String`	`PATH_FORMAT` Format expression defining the name of a journal file.
`static long`	`ROLLOVER_THRESHOLD` Size at which a completely obsolete journal file can be eliminated.
`static int`	`VERSION` Version number for the journal file format defined in this edition.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`copyBack()`
`void`	`force()`
`long`	`getBaseAddress()`
`long`	`getBlockSize()`
`long`	`getCommitCompletionWaitTime()`
`long`	`getCopiedPageCount()`
`long`	`getCopierInterval()`
`long`	`getCurrentAddress()`
`long`	`getCurrentTimestamp()`
`long`	`getDroppedPageCount()`
`long`	`getFlushInterval()`
`long`	`getJournalCreatedTime()`
`long`	`getJournaledPageCount()`
`String`	`getJournalFilePath()`
`String`	`getLastCopierException()`
`String`	`getLastFlusherException()`
`long`	`getLastValidCheckpointTimeMillis()`
`long`	`getLastValidCheckpointTimestamp()`
`int`	`getLiveTransactionMapSize()`
`int`	`getPageListSize()`
`int`	`getPageMapSize()`
`long`	`getReadPageCount()`
`long`	`getSlowIoAlertThreshold()`
`long`	`getTotalCompletedCommits()`
`int`	`getUrgentFileCountThreshold()`
`boolean`	`isAppendOnly()`
`boolean`	`isClosed()`
`boolean`	`isCopying()`
`boolean`	`isCopyingFast()`
`boolean`	`isIgnoreMissingVolumes()`
`boolean`	`isRollbackPruningEnabled()`
`boolean`	`isWritePagePruningEnabled()`
`void`	`setAppendOnly(boolean appendOnly)`
`void`	`setCopierInterval(long copierInterval)`
`void`	`setCopyingFast(boolean fast)`
`void`	`setFlushInterval(long flushInterval)`
`void`	`setIgnoreMissingVolumes(boolean ignore)`
`void`	`setRollbackPruningEnabled(boolean rollbackPruning)`
`void`	`setSlowIoAlertThreshold(long slowIoAlertThreshold)`
`void`	`setUrgentFileCountThreshold(int threshold)`
`void`	`setWritePagePruningEnabled(boolean rollbackPruning)`
`int`	`urgency()`

- Field Detail
  - MXBEAN_NAME
```
static final String MXBEAN_NAME
```
    See Also:
    
    Constant Field Values
  - VERSION
```
static final int VERSION
```
    Version number for the journal file format defined in this edition. Will change if the journal file format changes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BLOCK_SIZE
```
static final long DEFAULT_BLOCK_SIZE
```
    Default size of one journal file (10E9).
    
    See Also:
    
    Constant Field Values
  - MINIMUM_BLOCK_SIZE
```
static final long MINIMUM_BLOCK_SIZE
```
    Minimum permitted journal file size.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_BLOCK_SIZE
```
static final long MAXIMUM_BLOCK_SIZE
```
    Maximum permitted journal file size.
    
    See Also:
    
    Constant Field Values
  - ROLLOVER_THRESHOLD
```
static final long ROLLOVER_THRESHOLD
```
    Size at which a completely obsolete journal file can be eliminated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUFFER_SIZE
```
static final int DEFAULT_BUFFER_SIZE
```
    Default, minimum and maximum size of journal write buffer.
    
    See Also:
    
    Constant Field Values
  - MINIMUM_BUFFER_SIZE
```
static final int MINIMUM_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - MAXIMUM_BUFFER_SIZE
```
static final int MAXIMUM_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_COPY_BUFFER_SIZE
```
static final int DEFAULT_COPY_BUFFER_SIZE
```
    Default size of journal read buffer.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FLUSH_INTERVAL_MS
```
static final long DEFAULT_FLUSH_INTERVAL_MS
```
    Default time interval (in milliseconds) between calls to the FileChannel.force() method.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COPIER_INTERVAL_MS
```
static final long DEFAULT_COPIER_INTERVAL_MS
```
    Default time interval (in milliseconds) between calls to the journal copier method.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_URGENT_FILE_COUNT_THRESHOLD
```
static final int DEFAULT_URGENT_FILE_COUNT_THRESHOLD
```
    Default journal file count at which transactions are throttled to allow copier to catch up.
    
    See Also:
    
    Constant Field Values
  - MINIMUM_URGENT_FILE_COUNT_THRESHOLD
```
static final int MINIMUM_URGENT_FILE_COUNT_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - MAXIMUM_URGENT_FILE_COUNT_THRESHOLD
```
static final int MAXIMUM_URGENT_FILE_COUNT_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - DEFAULT_COPIES_PER_CYCLE
```
static final int DEFAULT_COPIES_PER_CYCLE
```
    Default value for maximum pages to be copied per cycle.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOG_REPEAT_INTERVAL_MS
```
static final long DEFAULT_LOG_REPEAT_INTERVAL_MS
```
    Default time interval (in milliseconds) for logging repetitive I/O exceptions on attempts to write to the journal. Prevents excessively verbose log on repeated failures.
    
    See Also:
    
    Constant Field Values
  - MINIMUM_LOG_REPEAT_INTERVAL_MS
```
static final long MINIMUM_LOG_REPEAT_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - MAXIMUM_LOG_REPEAT_INTERVAL_MS
```
static final long MAXIMUM_LOG_REPEAT_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SLOW_IO_ALERT_THRESHOLD_MS
```
static final long DEFAULT_SLOW_IO_ALERT_THRESHOLD_MS
```
    Default threshold time in milliseconds for JournalManager flush operations. If a flush operation takes longer than this time, a WARNING message is written to the log.
    
    See Also:
    
    Constant Field Values
  - MINIMUM_SLOW_ALERT_THRESHOLD_MS
```
static final long MINIMUM_SLOW_ALERT_THRESHOLD_MS
```
    See Also:
    
    Constant Field Values
  - MAXIMUM_SLOW_ALERT_THRESHOLD_MS
```
static final long MAXIMUM_SLOW_ALERT_THRESHOLD_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_JOURNAL_FILE_NAME
```
static final String DEFAULT_JOURNAL_FILE_NAME
```
    File name appended when journal path specifies only a directory
    
    See Also:
    
    Constant Field Values
  - PATH_FORMAT
```
static final String PATH_FORMAT
```
    Format expression defining the name of a journal file.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_CONCURRENT_TRANSACTIONS
```
static final int MAXIMUM_CONCURRENT_TRANSACTIONS
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getLiveTransactionMapSize
```
int getLiveTransactionMapSize()
```
  - getPageMapSize
```
int getPageMapSize()
```
  - getPageListSize
```
int getPageListSize()
```
  - getBaseAddress
```
long getBaseAddress()
```
  - getCurrentAddress
```
long getCurrentAddress()
```
  - getBlockSize
```
long getBlockSize()
```
  - isAppendOnly
```
boolean isAppendOnly()
```
  - isIgnoreMissingVolumes
```
boolean isIgnoreMissingVolumes()
```
  - isCopyingFast
```
boolean isCopyingFast()
```
  - setAppendOnly
```
void setAppendOnly(boolean appendOnly)
```
  - setIgnoreMissingVolumes
```
void setIgnoreMissingVolumes(boolean ignore)
```
  - setCopyingFast
```
void setCopyingFast(boolean fast)
```
  - getFlushInterval
```
long getFlushInterval()
```
  - setFlushInterval
```
void setFlushInterval(long flushInterval)
```
  - getCopierInterval
```
long getCopierInterval()
```
  - setCopierInterval
```
void setCopierInterval(long copierInterval)
```
  - isClosed
```
boolean isClosed()
```
  - isCopying
```
boolean isCopying()
```
  - getJournalFilePath
```
String getJournalFilePath()
```
  - getReadPageCount
```
long getReadPageCount()
```
  - getJournaledPageCount
```
long getJournaledPageCount()
```
  - getCopiedPageCount
```
long getCopiedPageCount()
```
  - getDroppedPageCount
```
long getDroppedPageCount()
```
  - getJournalCreatedTime
```
long getJournalCreatedTime()
```
  - getLastValidCheckpointTimestamp
```
long getLastValidCheckpointTimestamp()
```
  - getCurrentTimestamp
```
long getCurrentTimestamp()
```
  - setRollbackPruningEnabled
```
void setRollbackPruningEnabled(boolean rollbackPruning)
```
  - isRollbackPruningEnabled
```
boolean isRollbackPruningEnabled()
```
  - setWritePagePruningEnabled
```
void setWritePagePruningEnabled(boolean rollbackPruning)
```
  - isWritePagePruningEnabled
```
boolean isWritePagePruningEnabled()
```
  - urgency
```
int urgency()
```
  - force
```
void force()
    throws PersistitException
```
    Throws:
    
    PersistitException
  - copyBack
```
void copyBack()
       throws Exception
```
    Throws:
    
    Exception
  - getLastCopierException
```
String getLastCopierException()
```
  - getLastFlusherException
```
String getLastFlusherException()
```
  - getLastValidCheckpointTimeMillis
```
long getLastValidCheckpointTimeMillis()
```
  - getTotalCompletedCommits
```
long getTotalCompletedCommits()
```
  - getCommitCompletionWaitTime
```
long getCommitCompletionWaitTime()
```
  - getSlowIoAlertThreshold
```
long getSlowIoAlertThreshold()
```
  - setSlowIoAlertThreshold
```
void setSlowIoAlertThreshold(long slowIoAlertThreshold)
```
  - getUrgentFileCountThreshold
```
int getUrgentFileCountThreshold()
```
  - setUrgentFileCountThreshold
```
void setUrgentFileCountThreshold(int threshold)
```

Interface JournalManagerMXBean

Field Summary

Method Summary

Field Detail

MXBEAN_NAME

VERSION

DEFAULT_BLOCK_SIZE

MINIMUM_BLOCK_SIZE

MAXIMUM_BLOCK_SIZE

ROLLOVER_THRESHOLD

DEFAULT_BUFFER_SIZE

MINIMUM_BUFFER_SIZE

MAXIMUM_BUFFER_SIZE

DEFAULT_COPY_BUFFER_SIZE

DEFAULT_FLUSH_INTERVAL_MS

DEFAULT_COPIER_INTERVAL_MS

DEFAULT_URGENT_FILE_COUNT_THRESHOLD

MINIMUM_URGENT_FILE_COUNT_THRESHOLD

MAXIMUM_URGENT_FILE_COUNT_THRESHOLD

DEFAULT_COPIES_PER_CYCLE

DEFAULT_LOG_REPEAT_INTERVAL_MS

MINIMUM_LOG_REPEAT_INTERVAL_MS

MAXIMUM_LOG_REPEAT_INTERVAL_MS

DEFAULT_SLOW_IO_ALERT_THRESHOLD_MS

MINIMUM_SLOW_ALERT_THRESHOLD_MS

MAXIMUM_SLOW_ALERT_THRESHOLD_MS

DEFAULT_JOURNAL_FILE_NAME

PATH_FORMAT

MAXIMUM_CONCURRENT_TRANSACTIONS

Method Detail

getLiveTransactionMapSize

getPageMapSize

getPageListSize

getBaseAddress

getCurrentAddress

getBlockSize

isAppendOnly

isIgnoreMissingVolumes

isCopyingFast

setAppendOnly

setIgnoreMissingVolumes

setCopyingFast

getFlushInterval

setFlushInterval

getCopierInterval

setCopierInterval

isClosed

isCopying

getJournalFilePath

getReadPageCount

getJournaledPageCount

getCopiedPageCount

getDroppedPageCount

getJournalCreatedTime

getLastValidCheckpointTimestamp

getCurrentTimestamp

setRollbackPruningEnabled

isRollbackPruningEnabled

setWritePagePruningEnabled

isWritePagePruningEnabled

urgency

force

copyBack

getLastCopierException

getLastFlusherException

getLastValidCheckpointTimeMillis

getTotalCompletedCommits

getCommitCompletionWaitTime

getSlowIoAlertThreshold

setSlowIoAlertThreshold

getUrgentFileCountThreshold

setUrgentFileCountThreshold