blackboard.platform.monitor.system
Interface SystemSnapshotService


public interface SystemSnapshotService

The SystemSnapshotService provides a service interface for generating and accessing system snapshots. A snapshot is unique by the time it's generated. See SystemSnapshot for details on what is included in the snapshot file. Snapshot files are stored in the Blackboard logs directory, under the monitor subdirectory.

Since:
Bb 9.1
See Also:
SystemSnapshot

Method Summary
 SystemSnapshot createSnapshot()
          Create a new snapshot.
 SystemSnapshot createSnapshot(MonitorEvent<?> event)
          Create a new snapshot based on a particular monitor event.
 SystemSnapshot getSnapshot(java.util.Calendar time)
          Lookup a specific snapshot based on the time it was generated.
 java.util.List<SystemSnapshot> getSnapshots()
          Get a list of all of the current snapshots stored on the systen, sorted by time, newest first.
 

Method Detail

createSnapshot

SystemSnapshot createSnapshot()
                              throws java.io.IOException
Create a new snapshot.

Returns:
A reference object pointing to the snapshot file.
Throws:
java.io.IOException - Thrown if there is a problem writing the snapshot file.

createSnapshot

SystemSnapshot createSnapshot(MonitorEvent<?> event)
                              throws java.io.IOException
Create a new snapshot based on a particular monitor event. The monitor event will be included in the system information file for reference.

Returns:
A reference object pointing to the snapshot file.
Throws:
java.io.IOException - Thrown if there is a problem writing the snapshot file.

getSnapshots

java.util.List<SystemSnapshot> getSnapshots()
Get a list of all of the current snapshots stored on the systen, sorted by time, newest first.

Returns:
A sorted list of available snapshots, newest first.

getSnapshot

SystemSnapshot getSnapshot(java.util.Calendar time)
                           throws java.io.FileNotFoundException
Lookup a specific snapshot based on the time it was generated. If there is no snapshot for that time, this will throw a FileNotFoundException.

Parameters:
time - The time the snapshot was generated.
Returns:
The snapshot reference
Throws:
java.io.FileNotFoundException - If the snapshot can't be found.


Copyright 2011 Blackboard, Inc. All Rights Reserved.