@ProviderType public interface RepositoryManagementMBean
The status of an operation is represented by a CompositeData
instance consisting at least of the items code
, id
,
and message
. Implementations are free to add further items.
The code
item is an integer encoding the current status of
the respective operation. Valid values and its semantics are:
0
: Operation not available. For example
because the system does not implement the operation or the
system is in a state where it does not allow the operation to
be carried out (e.g. the operation is already running). The
message
should give further indication of the exact
reason.1
: Status not available. Usually because
there was no prior attempt to start the operation. The
message
should give further indication of the exact
reason.2
: Operation initiated. The message
should give further information of when the operation was
initiated. This status mean that the operation will be performed
some time in the future without impacting overall system behaviour
and that no further status updates will be available until this
operation is performed next time.3
: Operation running.4
: Operation succeeded. The message
should
give further information on how long the operation took to
complete.5
: Operation failed. The message
should give
further information on the reason for the failure.
In all cases the message
may provide additional information
that might be useful in the context of the operation.
The id
is an identifier for the invocation of an operation.
It is reported as a part of the status for clients to relate the
status to invocation. -1
is returned when not available.
Modifier and Type | Interface and Description |
---|---|
static class |
RepositoryManagementMBean.StatusCode
Enum whose ordinals correspond to the status codes.
|
Modifier and Type | Method and Description |
---|---|
@NotNull CompositeData |
cancelRevisionGC()
Cancel a running revision garbage collection operation.
|
@NotNull CompositeData |
cancelRevisionGCForRole(String role)
Cancel a running revision garbage collection operation for a given role.
|
@Nullable String |
checkpoint(long lifetime)
Deprecated.
Use
CheckpointMBean instead |
@NotNull CompositeData |
getBackupStatus()
Backup status
|
@NotNull CompositeData |
getDataStoreGCStatus()
Data store garbage collection status
|
@NotNull CompositeData |
getPropertyIndexAsyncReindexStatus()
Asynchronous Property Index reindexing status
|
@NotNull CompositeData |
getRestoreStatus()
Restore status
|
@NotNull CompositeData |
getRevisionGCStatus()
Revision garbage collection status
|
@NotNull CompositeData |
getRevisionGCStatusForRole(String role)
Revision garbage collection status for a given role.
|
@NotNull TabularData |
refreshAllSessions()
Refresh all currently open sessions.
|
@NotNull CompositeData |
startBackup()
Initiate a backup operation.
|
@NotNull CompositeData |
startDataStoreGC(boolean markOnly)
Initiate a data store garbage collection operation
|
@NotNull CompositeData |
startPropertyIndexAsyncReindex()
Initiate a reindex operation for the property indexes marked for
reindexing
|
@NotNull CompositeData |
startRestore()
Initiate a restore operation.
|
@NotNull CompositeData |
startRevisionGC()
Initiate a revision garbage collection operation
|
@NotNull CompositeData |
startRevisionGCForRole(String role)
Initiate a revision garbage collection operation
|
static final String TYPE
@NotNull @Description(value="Creates a backup of the persistent state of the repository") @NotNull CompositeData startBackup()
@NotNull @Description(value="The status of the ongoing operation, or the terminal status of the last completed backup operation") @NotNull CompositeData getBackupStatus()
@NotNull @Description(value="Restores the repository from a backup") @NotNull CompositeData startRestore()
@NotNull @Description(value="The status of the ongoing operation, or the terminal status of the last completed restore operation") @NotNull CompositeData getRestoreStatus()
@NotNull @Description(value="Initiates a data store garbage collection operation") @NotNull CompositeData startDataStoreGC(@Name(value="markOnly") @Description(value="Set to true to only mark references and not sweep in the mark and sweep operation. This mode is to be used when the underlying BlobStore is shared between multiple different repositories. For all other cases set it to false to perform full garbage collection") boolean markOnly)
markOnly
- whether to only mark references and not sweep in the mark and sweep operation.@NotNull @Description(value="Data store garbage collection status") @NotNull CompositeData getDataStoreGCStatus()
@NotNull @Description(value="Initiates a revision garbage collection operation") @NotNull CompositeData startRevisionGC()
@NotNull @Description(value="Initiates a revision garbage collection operation for a given role") @NotNull CompositeData startRevisionGCForRole(String role)
@NotNull @Description(value="Cancel a running revision garbage collection operation. Does nothing if revision garbage collection is not running.") @NotNull CompositeData cancelRevisionGC()
@NotNull @Description(value="Cancel a running revision garbage collection operation. Does nothing if revision garbage collection is not running.") @NotNull CompositeData cancelRevisionGCForRole(String role)
@NotNull @Description(value="Revision garbage collection status") @NotNull CompositeData getRevisionGCStatus()
@NotNull @Description(value="Revision garbage collection status for a given role") @NotNull CompositeData getRevisionGCStatusForRole(String role)
@Deprecated @Nullable @Nullable String checkpoint(long lifetime)
CheckpointMBean
insteadlifetime
- time (in milliseconds, > 0) that the checkpoint
should remain availablenull
if
the checkpoint could not be set.@NotNull @Description(value="Initiates a reindex operation for the property indexes marked for reindexing") @NotNull CompositeData startPropertyIndexAsyncReindex()
@NotNull @Description(value="Asynchronous Property Index reindexing status") @NotNull CompositeData getPropertyIndexAsyncReindexStatus()
@NotNull @Description(value="Refresh all currently open sessions") @NotNull TabularData refreshAllSessions()
Copyright © 2010 - 2020 Adobe. All Rights Reserved