Uses of Class
org.apache.jackrabbit.oak.api.jmx.Description

Packages that use Description

Package	Description
org.apache.jackrabbit.oak.api.jmx
org.apache.jackrabbit.oak.plugins.blob
org.apache.jackrabbit.oak.plugins.blob.migration
org.apache.jackrabbit.oak.plugins.document
org.apache.jackrabbit.oak.query.stats
org.apache.jackrabbit.oak.segment.standby.jmx

Uses of Description in org.apache.jackrabbit.oak.api.jmx

Methods in org.apache.jackrabbit.oak.api.jmx with annotations of type Description

Modifier and Type	Method	Description
String	IndexStatsMBean.abortAndPause()
@NotNull CompositeData	RepositoryManagementMBean.cancelRevisionGC()	Cancel a running revision garbage collection operation.
@NotNull CompositeData	RepositoryManagementMBean.cancelRevisionGCForRole(String role)	Cancel a running revision garbage collection operation for a given role.
String	IndexStatsMBean.forceIndexLaneCatchup(String confirmationMessage)
String	QueryEngineSettingsMBean.getAutoOptionsMappingJson()	Get the automatic query options mapping.
@NotNull CompositeData	RepositoryManagementMBean.getBackupStatus()	Backup status
@NotNull CompositeData	RepositoryManagementMBean.getDataStoreGCStatus()	Data store garbage collection status
boolean	QueryEngineSettingsMBean.getFailTraversal()	Whether queries that don't use an index will fail (throw an exception).
long	QueryEngineSettingsMBean.getLimitInMemory()	Get the limit on how many nodes a query may read at most into memory, for "order by" and "distinct" queries.
long	QueryEngineSettingsMBean.getLimitReads()	Get the limit on how many nodes a query may read at most (raw read operations, including skipped nodes).
int	QueryEngineSettingsMBean.getPrefetchCount()	Get the prefetch count.
@NotNull CompositeData	RepositoryManagementMBean.getPropertyIndexAsyncReindexStatus()	Asynchronous Property Index reindexing status
String	QueryEngineSettingsMBean.getQueryValidatorJson()
@NotNull CompositeData	RepositoryManagementMBean.getRestoreStatus()	Restore status
@NotNull CompositeData	RepositoryManagementMBean.getRevisionGCStatus()	Revision garbage collection status
@NotNull CompositeData	RepositoryManagementMBean.getRevisionGCStatusForRole(String role)	Revision garbage collection status for a given role.
String	RepositoryManagementMBean.getSessionSaveDelayerConfig()	Get the Session.save() delay configuration.
boolean	QueryEngineSettingsMBean.isFastQuerySize()	Whether the query result size should return an estimation for large queries.
@NotNull TabularData	RepositoryManagementMBean.refreshAllSessions()	Refresh all currently open sessions.
String	IndexStatsMBean.releaseLeaseForPausedLane()
void	InferenceMBean.setConfigJson(String path, String configJson)
void	QueryEngineSettingsMBean.setIgnoredClassNamesInCallTrace(@NotNull String[] classNames)	Set or remove java package/class names which are ignored from finding the invoking class for queries.
void	QueryEngineSettingsMBean.setQueryValidatorPattern(String key, String pattern, String comment, boolean failQuery)	Set or remove a query validator pattern.
void	RepositoryManagementMBean.setSessionSaveDelayerConfig(String config)	Set the Session.save() delay configuration.
void	QueryEngineSettingsMBean.setStrictPathRestriction(String pathRestriction)	Whether path restrictions of indexes (excludedPaths / includedPaths) are taken into account during query execution, for Lucene indexes.
@NotNull CompositeData	RepositoryManagementMBean.startBackup()	Initiate a backup operation.
@NotNull CompositeData	RepositoryManagementMBean.startDataStoreGC(boolean markOnly)	Initiate a data store garbage collection operation
@NotNull CompositeData	RepositoryManagementMBean.startPropertyIndexAsyncReindex()	Initiate a reindex operation for the property indexes marked for reindexing
@NotNull CompositeData	RepositoryManagementMBean.startRestore()	Initiate a restore operation.
@NotNull CompositeData	RepositoryManagementMBean.startRevisionGC()	Initiate a revision garbage collection operation
@NotNull CompositeData	RepositoryManagementMBean.startRevisionGCForRole(String role)	Initiate a revision garbage collection operation

Method parameters in org.apache.jackrabbit.oak.api.jmx with annotations of type Description

Modifier and Type	Method	Description
String	IndexStatsMBean.forceIndexLaneCatchup(String confirmationMessage)
boolean	IndexerMBean.importIndex(String indexDirPath)
boolean	IndexerMBean.importIndex(String indexDirPath, boolean ignoreLocalLock)
boolean	IndexerMBean.importIndex(String indexDirPath, boolean ignoreLocalLock)
void	InferenceMBean.setConfigJson(String path, String configJson)
void	InferenceMBean.setConfigJson(String path, String configJson)
void	QueryEngineSettingsMBean.setIgnoredClassNamesInCallTrace(@NotNull String[] classNames)	Set or remove java package/class names which are ignored from finding the invoking class for queries.
void	QueryEngineSettingsMBean.setQueryValidatorPattern(String key, String pattern, String comment, boolean failQuery)	Set or remove a query validator pattern.
void	QueryEngineSettingsMBean.setQueryValidatorPattern(String key, String pattern, String comment, boolean failQuery)	Set or remove a query validator pattern.
void	QueryEngineSettingsMBean.setQueryValidatorPattern(String key, String pattern, String comment, boolean failQuery)	Set or remove a query validator pattern.
void	QueryEngineSettingsMBean.setQueryValidatorPattern(String key, String pattern, String comment, boolean failQuery)	Set or remove a query validator pattern.
void	IndexStatsMBean.splitIndexingTask(String paths, String newIndexTaskName)	Splits the current indexing tasks into 2, indexes that are passed in as an input will have their 'async' property updated to newIndexTaskName.
void	IndexStatsMBean.splitIndexingTask(String paths, String newIndexTaskName)	Splits the current indexing tasks into 2, indexes that are passed in as an input will have their 'async' property updated to newIndexTaskName.
@NotNull CompositeData	RepositoryManagementMBean.startDataStoreGC(boolean markOnly)	Initiate a data store garbage collection operation

Uses of Description in org.apache.jackrabbit.oak.plugins.blob

Method parameters in org.apache.jackrabbit.oak.plugins.blob with annotations of type Description

Modifier and Type	Method	Description
CompositeData	BlobGCMBean.startBlobGC(boolean markOnly)	Initiate a data store garbage collection operation.
CompositeData	BlobGCMBean.startBlobGC(boolean markOnly, boolean forceBlobIdRetrieve)	Initiate a data store garbage collection operation.
CompositeData	BlobGCMBean.startBlobGC(boolean markOnly, boolean forceBlobIdRetrieve)	Initiate a data store garbage collection operation.

Uses of Description in org.apache.jackrabbit.oak.plugins.blob.migration

Methods in org.apache.jackrabbit.oak.plugins.blob.migration with annotations of type Description

Modifier and Type	Method	Description
@NotNull String	BlobMigrationMBean.startBlobMigration(boolean resume)
@NotNull String	BlobMigrationMBean.stopBlobMigration()

Method parameters in org.apache.jackrabbit.oak.plugins.blob.migration with annotations of type Description

Modifier and Type	Method	Description
@NotNull String	BlobMigrationMBean.startBlobMigration(boolean resume)

Uses of Description in org.apache.jackrabbit.oak.plugins.document

Methods in org.apache.jackrabbit.oak.plugins.document with annotations of type Description

Modifier and Type	Method	Description
String	DocumentNodeStoreMBean.cleanAllCaches()
String	DocumentNodeStoreMBean.cleanIndividualCache(String name)
String	DocumentNodeStoreMBean.createCheckpoint(String revision, long lifetime, boolean force)
long	DocumentNodeStoreMBean.determineServerTimeDifferenceMillis()
int	DocumentNodeStoreMBean.recover(String path, int clusterId)

Method parameters in org.apache.jackrabbit.oak.plugins.document with annotations of type Description

Modifier and Type	Method	Description
String	DocumentNodeStoreMBean.cleanIndividualCache(String name)
String	DocumentNodeStoreMBean.createCheckpoint(String revision, long lifetime, boolean force)
String	DocumentNodeStoreMBean.createCheckpoint(String revision, long lifetime, boolean force)
String	DocumentNodeStoreMBean.createCheckpoint(String revision, long lifetime, boolean force)
int	DocumentNodeStoreMBean.recover(String path, int clusterId)
int	DocumentNodeStoreMBean.recover(String path, int clusterId)

Uses of Description in org.apache.jackrabbit.oak.query.stats

Methods in org.apache.jackrabbit.oak.query.stats with annotations of type Description

Modifier and Type	Method	Description
String	QueryStatsMBean.asJson()
TabularData	QueryStatsMBean.getPopularQueries()
TabularData	QueryStatsMBean.getSlowQueries()	Get the slow queries.
void	QueryStatsMBean.resetStats()
void	QueryStatsMBean.setCaptureStackTraces(boolean captureStackTraces)	Whether to capture a thread dump in addition to the thread name.

Uses of Description in org.apache.jackrabbit.oak.segment.standby.jmx

Methods in org.apache.jackrabbit.oak.segment.standby.jmx with annotations of type Description

Modifier and Type	Method	Description
int	ClientStandbyStatusMBean.calcFailedRequests()
int	ClientStandbyStatusMBean.calcSecondsSinceLastSuccess()
void	ClientStandbyStatusMBean.cleanup()
int	ClientStandbyStatusMBean.getFailedRequests()
String	ObservablePartnerMBean.getLastRequest()
@Nullable String	ObservablePartnerMBean.getLastSeenTimestamp()
@NotNull String	StandbyStatusMBean.getMode()
@NotNull String	ObservablePartnerMBean.getName()
String	ObservablePartnerMBean.getRemoteAddress()
int	ObservablePartnerMBean.getRemotePort()
int	ClientStandbyStatusMBean.getSecondsSinceLastSuccess()
String	StandbyStatusMBean.getStatus()
long	ClientStandbyStatusMBean.getSyncEndTimestamp()
long	ClientStandbyStatusMBean.getSyncStartTimestamp()
long	ObservablePartnerMBean.getTransferredBinaries()
long	ObservablePartnerMBean.getTransferredBinariesBytes()
long	ObservablePartnerMBean.getTransferredSegmentBytes()
long	ObservablePartnerMBean.getTransferredSegments()
boolean	StandbyStatusMBean.isRunning()
void	StandbyStatusMBean.start()
void	StandbyStatusMBean.stop()