com.ibm.ia.runtime.management

Interface DataLoadManagerMXBean

@MXBean
public interface DataLoadManagerMXBean

The interface used to restore persisted data for the server and bring the system out of PRELOAD.

The MXBean is available on the servers hosting the runtime, using the object name com.ibm.ia:type=CISDataLoader.

This MXBean is required when persistence is configured and the system is being started or restarted following a shutdown.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MXBEAN_OBJECT_NAME The object name by which a JMX client can find the DataLoadManagerMXBean

Method Summary

Methods

Modifier and Type	Method and Description
double	checkLoadProgress() Returns a percentage representing the number of data batches that have been loaded into the system
boolean	isGridOnline() Determines if the Grid State is ONLINE.
boolean	isLoadComplete() Determines if loading of data has finished
int	loadData() Asynchronous call to begin restoring the persisted data into the system.
boolean	setGridOnline() Sets the Grid State to ONLINE from PRELOAD.

Field Detail

MXBEAN_OBJECT_NAME

static final java.lang.String MXBEAN_OBJECT_NAME

The object name by which a JMX client can find the DataLoadManagerMXBean

See Also:

Constant Field Values

Method Detail

loadData

int loadData()
             throws java.lang.IllegalStateException

Asynchronous call to begin restoring the persisted data into the system. Data held in the database is stored in batches, the batch size is determined by the "batchLimit" property of the server configuration.

Return details:
0 or above: This represents the number of batches being restored.
-1: The system is not configured for persistence.
-2: A load has already been started. Additional loads are not supported.

Throws:

java.lang.IllegalStateException - Thrown when the server encounters a fatal error

Returns:

The number of batches that will be restored

checkLoadProgress

double checkLoadProgress()
                         throws java.lang.IllegalStateException

Returns a percentage representing the number of data batches that have been loaded into the system

Throws:

java.lang.IllegalStateException - Thrown when the server encounters a fatal error

Returns:

A double representing % of batches completed

setGridOnline

boolean setGridOnline()
                      throws java.lang.IllegalStateException

Sets the Grid State to ONLINE from PRELOAD. If the original Grid State is anything but PRELOAD, the Grid State remains unchanged.

Throws:

java.lang.IllegalStateException - Thrown when the server encounters a fatal error

Returns:

A boolean indicating if the system is now online.

isGridOnline

boolean isGridOnline()
                     throws java.lang.IllegalStateException

Determines if the Grid State is ONLINE.

Throws:

java.lang.IllegalStateException - Thrown when the server encounters a fatal error

Returns:

A boolean

isLoadComplete

boolean isLoadComplete()
                       throws java.lang.IllegalStateException

Determines if loading of data has finished

Throws:

java.lang.IllegalStateException - Thrown when the server encounters a fatal error

Returns:

If data load has completed