com.persistit.mxbeans

Interface ManagementMXBean

All Known Subinterfaces:

Management

@MXBean
public interface ManagementMXBean

Interface for a service object that exposes information about the Persistit environment. With this public API, embedding applications can query performance metrics and resources within Persistit that are not exposed by the normal access methods. For example, this class provides methods that enumerate the volumes currently mounted, the size and effectiveness of buffer pool components, and many other items that may be useful in tuning and managing Persistit.

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	MXBEAN_NAME

Method Summary

Modifier and Type	Method and Description
String	execute(String commandLine) Use a simple command-line processor to invoke a task.
void	flushAndForce() Flush and sync all dirty data in Persistit by invoking Persistit.flush() and Persistit.force().
long	getCommittedTransactionCount() Return the aggregate number of transactions committed since Persistit was initialized
String	getCopyright() Return the copyright notice for the current Persistit instance.
String	getDefaultCommitPolicy()
long	getElapsedTime() Return the elapsed time since startup in milliseconds
int	getRmiPort() Return the port on which a local RMI server has been registered, or -1 if not registered.
long	getRollbackCount() Return the aggregate number of transaction rollback events since Persistit was initialized
long	getStartTime() Return the system time at which Persistit was initialized.
String	getVersion() Return the version name of the current Persistit instance.
Management.VolumeInfo[]	getVolumes() Return an array of information of all volumes that Persistit knows about, or null if there are none.
boolean	isInitialized() Indicate whether Persistit is currently in the initialized state.
boolean	isShutdownSuspended() Indicate whether Persistit will suspend its shutdown activities on invocation of Persistit.close().
boolean	isUpdateSuspended() Indicate whether Persistit is suspending all update operations.
String	launch(String commandLine) Use a simple command-line processor to start a task.
void	setDefaultCommitPolicy(String policyName) Modify the current default CommitPolicy.
void	setShutdownSuspended(boolean suspended) Control whether Persistit will suspend its shutdown activities on invocation of Persistit.close().
void	setUpdateSuspended(boolean suspended) Control whether Persistit will suspend all update operations.
String	transactionReport(int max)
Management.VolumeInfo	volumeByName(String volumeName) Query information about a specific volume from it's name.

Field Detail

MXBEAN_NAME

static final String MXBEAN_NAME

See Also:

Constant Field Values

Method Detail

isInitialized

boolean isInitialized()
               throws RemoteException

Indicate whether Persistit is currently in the initialized state.

Returns:

The state

Throws:

RemoteException

getVersion

String getVersion()
           throws RemoteException

Return the version name of the current Persistit instance.

Returns:

the version name

Throws:

RemoteException

getCopyright

String getCopyright()
             throws RemoteException

Return the copyright notice for the current Persistit instance.

Returns:

the copyright notice

Throws:

RemoteException

getStartTime

long getStartTime()
           throws RemoteException

Return the system time at which Persistit was initialized.

Returns:

start time, in milliseconds since January 1, 1970 00:00:00 GMT.

Throws:

RemoteException

getElapsedTime

long getElapsedTime()
             throws RemoteException

Return the elapsed time since startup in milliseconds

Returns:

elapsed time in milliseconds

Throws:

RemoteException

getRmiPort

int getRmiPort()
        throws RemoteException

Return the port on which a local RMI server has been registered, or -1 if not registered.

Returns:

the port

Throws:

RemoteException

getCommittedTransactionCount

long getCommittedTransactionCount()
                           throws RemoteException

Return the aggregate number of transactions committed since Persistit was initialized

Returns:

total number of transactions committed

Throws:

RemoteException

getRollbackCount

long getRollbackCount()
               throws RemoteException

Return the aggregate number of transaction rollback events since Persistit was initialized

Returns:

total number of transactions rolled back

Throws:

RemoteException

getVolumes

Management.VolumeInfo[] getVolumes()
                            throws RemoteException

Return an array of information of all volumes that Persistit knows about, or null if there are none.

Returns:

array of volumes

Throws:

RemoteException

transactionReport

String transactionReport(int max)
                  throws RemoteException

Parameters:

max - Maximum number of transactions to report on.

Returns:

Report on the max longest-running transactions.

Throws:

RemoteException

getDefaultCommitPolicy

String getDefaultCommitPolicy()
                       throws RemoteException

Returns:

the name of the current default CommitPolicy

Throws:

RemoteException

setDefaultCommitPolicy

void setDefaultCommitPolicy(String policyName)
                     throws RemoteException

Modify the current default CommitPolicy. The policy name must be one of "hard", "group" or "commit".

Parameters:

policyName - name of the CommitPolicy to set.

Throws:

RemoteException

isShutdownSuspended

boolean isShutdownSuspended()
                     throws RemoteException

Indicate whether Persistit will suspend its shutdown activities on invocation of Persistit.close(). This flag is intended for use by management tools that need to keep Persistit open even when the application has requested it to close so that the final state of the Persistit environment can be examined.

Returns:

true if Persistit will wait when attempting to close; false if the close operation will not be suspended.

Throws:

RemoteException

setShutdownSuspended

void setShutdownSuspended(boolean suspended)
                   throws RemoteException

Control whether Persistit will suspend its shutdown activities on invocation of Persistit.close(). This flag is intended for use by management tools that need to keep Persistit open even when the application has requested it to close so that the final state of the Persistit environment can be examined.

Parameters:

suspended - true to specify that Persistit will wait when attempting to close; otherwise false.

Throws:

RemoteException

isUpdateSuspended

boolean isUpdateSuspended()
                   throws RemoteException

Indicate whether Persistit is suspending all update operations. When enabled, Persistit will indefinitely delay each Thread that attempts to perform an update operation.

Returns:

true if Persistit will suspend any attempt to update a Volume; otherwise false.

Throws:

RemoteException

setUpdateSuspended

void setUpdateSuspended(boolean suspended)
                 throws RemoteException

Control whether Persistit will suspend all update operations. When enabled, Persistit will delay each Thread that attempts to perform an update operation indefinitely.

Parameters:

suspended -

Throws:

RemoteException

flushAndForce

void flushAndForce()
            throws RemoteException

Flush and sync all dirty data in Persistit by invoking Persistit.flush() and Persistit.force().

Throws:

RemoteException

execute

String execute(String commandLine)
        throws RemoteException

Use a simple command-line processor to invoke a task. Allows task invocation to be scripted through a command-line JMX client. This method runs the Task, which in some cases may take a long time. In contrast, the launch(String) method initiates the task in a new thread and returns immediately.

Parameters:

commandLine -

Returns:

The final status of the Task, as a String

Throws:

RemoteException

launch

String launch(String commandLine)
       throws RemoteException

Use a simple command-line processor to start a task. Allows task invocation to be scripted through a command-line JMX client. This method starts the task in a new thread and returns immediately. In contrast, the execute(String) method completes the task before returning.

Parameters:

commandLine -

Returns:

The taskId, as a String

Throws:

RemoteException

volumeByName

Management.VolumeInfo volumeByName(String volumeName)
                            throws RemoteException

Query information about a specific volume from it's name.

Parameters:

volumeName - name of the volume to lookup

Returns:

information about the volume, or null if none found

Throws:

RemoteException