Package com.tangosol.persistence

Interface PersistenceManagerMBean

  • public interface PersistenceManagerMBean
    Standard MBean interface that exposes management attributes and operations relating to a PartitionedService configured with on-demand or active persistence.

    Each persistence-enabled PartitionedService registers a single instance of this MBean bound to a JMX name of the form: "Coherence:type=Persistence,service={ServiceName},responsibility=PersistenceCoordinator"

    Since:
    Coherence 12.2.1
    Author:
    rhl 2013.05.07

    • Field Detail

      • PERSISTENCE_COORDINATOR

        static final String PERSISTENCE_COORDINATOR
        String representation of the responsibility of PersistenceCoordinator.
        See Also:
        Constant Field Values

      • CREATE_SNAPSHOT_BEGIN

        static final String CREATE_SNAPSHOT_BEGIN
        Notification type for the start of snapshot creation.
        See Also:
        Constant Field Values

      • CREATE_SNAPSHOT_END

        static final String CREATE_SNAPSHOT_END
        Notification type for the end of snapshot creation.
        See Also:
        Constant Field Values

      • RECOVER_SNAPSHOT_BEGIN

        static final String RECOVER_SNAPSHOT_BEGIN
        Notification type for the start of recovering from a snapshot.
        See Also:
        Constant Field Values

      • RECOVER_SNAPSHOT_END

        static final String RECOVER_SNAPSHOT_END
        Notification type for the end of recovering from a snapshot.
        See Also:
        Constant Field Values

      • REMOVE_SNAPSHOT_BEGIN

        static final String REMOVE_SNAPSHOT_BEGIN
        Notification type for the start of removing a snapshot.
        See Also:
        Constant Field Values

      • REMOVE_SNAPSHOT_END

        static final String REMOVE_SNAPSHOT_END
        Notification type for the end of removing a snapshot.
        See Also:
        Constant Field Values

      • ARCHIVE_SNAPSHOT_BEGIN

        static final String ARCHIVE_SNAPSHOT_BEGIN
        Notification type for the start of archiving a snapshot.
        See Also:
        Constant Field Values

      • ARCHIVE_SNAPSHOT_END

        static final String ARCHIVE_SNAPSHOT_END
        Notification type for the end of archiving a snapshot.
        See Also:
        Constant Field Values

      • RETRIEVE_ARCHIVED_SNAPSHOT_BEGIN

        static final String RETRIEVE_ARCHIVED_SNAPSHOT_BEGIN
        Notification type for the start of retrieving an archived snapshot.
        See Also:
        Constant Field Values

      • RETRIEVE_ARCHIVED_SNAPSHOT_END

        static final String RETRIEVE_ARCHIVED_SNAPSHOT_END
        Notification type for the end of retrieving an archiving snapshot.
        See Also:
        Constant Field Values

      • REMOVE_ARCHIVED_SNAPSHOT_BEGIN

        static final String REMOVE_ARCHIVED_SNAPSHOT_BEGIN
        Notification type for the start of purging (removing) an archived snapshot.
        See Also:
        Constant Field Values

      • REMOVE_ARCHIVED_SNAPSHOT_END

        static final String REMOVE_ARCHIVED_SNAPSHOT_END
        Notification type for the end of purging (removing) an archived snapshot.
        See Also:
        Constant Field Values

      • RECOVER_DISALLOWED

        static final String RECOVER_DISALLOWED
        Notification type for the recovery being disallowed by the quorum.
        See Also:
        Constant Field Values

    • Method Detail

      • getCoordinatorId

        int getCoordinatorId()
        Return the node id of the persistence coordinator.
        Returns:
        current persistence coordinator node id

      • getOperationStatus

        String getOperationStatus()
        Return the status of the current operation issued by the persistence coordinator.
        Returns:
        the status of the current operation issued by the persistence coordinator

      • isIdle

        boolean isIdle()
        Specifies whether or not the persistence coordinator is idle.
        Returns:
        true if the persistence coordinator is idle

      • getSnapshots

        String[] getSnapshots()
        Return a list of snapshots that are available for recovery.
        Returns:
        a list of snapshots that are available for recovery

      • createSnapshot

        void createSnapshot​(String sName)
        Create a snapshot of the service with the specified name.
        Parameters:
        sName - the snapshot name to create

      • recoverSnapshot

        void recoverSnapshot​(String sName)
        Recover the snapshot that was previously created with the specified name.

        Note: the entire service is recovered from persisted state therefore transient caches are reset.

        Parameters:
        sName - the snapshot name to recover

      • removeSnapshot

        void removeSnapshot​(String sName)
        Remove the snapshot that was previously created with the specified name.
        Parameters:
        sName - the snapshot name to remove

      • archiveSnapshot

        void archiveSnapshot​(String sName)
        Archive the snapshot to a centralized location.
        Parameters:
        sName - the snapshot name to archive

      • retrieveArchivedSnapshot

        void retrieveArchivedSnapshot​(String sName)
        Retrieve the archived snapshot from a centralized location.
        Parameters:
        sName - the snapshot name to archive

      • removeArchivedSnapshot

        void removeArchivedSnapshot​(String sName)
        Purge the archived snapshot from a centralized location.
        Parameters:
        sName - the snapshot name to purge

      • forceRecovery

        void forceRecovery()
        Proceed with recovery despite the dynamic quorum policy objections.

      • listArchivedSnapshots

        String[] listArchivedSnapshots()
        Return a list of archived snapshots that the configured archiver knows about. If none exist, an empty String[] will be returned.
        Returns:
        a String[] of known archived snapshots

      • listArchivedSnapshotStores

        String[] listArchivedSnapshotStores​(String sName)
        Return a list of stores for a given archived snapshot.
        Parameters:
        sName - the snapshot name to list stores for
        Returns:
        a String[] of known stores for the archived snapshot