com.hp.ucmdb.api.snapshots

Interface SnapshotService

public interface SnapshotService

Snapshots services.

Since:

8.0

Method Summary

Modifier and Type	Method and Description
QuerySnapshotCompareResult	compareQuerySnapshotAgainstCurrent(SnapshotHeader snapshotHeader) Returns the topology representing the snapshot identified by the given snapshot header and the topology of the "current" version of the same TQL.
QuerySnapshotCompareResult	compareQuerySnapshots(SnapshotHeader snapshotHeader1, SnapshotHeader snapshotHeader2) Returns the topologies representing the two snapshots identified by the snapshot headers.
ViewSnapshotCompareResult	compareViewSnapshotAgainstCurrent(SnapshotHeader snapshotHeader) Returns the view result representing the snapshot identified by the given snapshot header and the view result of the "current" version of the same view.
ViewSnapshotCompareResult	compareViewSnapshots(SnapshotHeader snapshotHeader1, SnapshotHeader snapshotHeader2) Returns the view result representing the snapshot identified by the given snapshot header and the view result of the "current" version of the same view.
Collection<SnapshotHeader>	getAllSnapshotHeaders() Returns all the snapshots headers.
SnapshotsFactory	getFactory()
Snapshot	getSnapshot(SnapshotHeader snapshotHeader) Returns the topology for the snapshot header.
Collection<SnapshotHeader>	getSnapshotHeaders(SnapshotFilter filter) Returns all snapshots according to the filter.
void	saveSnapshot(String tqlName, SnapshotContext snapshotContext) Save the snapshot for the specified TQL.
void	saveViewSnapshot(String viewName, SnapshotContext snapshotContext) Save the snapshot for the given view.

Method Detail

getFactory

SnapshotsFactory getFactory()

saveSnapshot

void saveSnapshot(String tqlName,
                  SnapshotContext snapshotContext)

Save the snapshot for the specified TQL.

saveViewSnapshot

@NotFinalAPI
void saveViewSnapshot(String viewName,
                                   SnapshotContext snapshotContext)

Save the snapshot for the given view. A view by the given name must exist in the UCMDB.

When this method returns, the snapshot may still be unsaved. To verify that the snapshot is saved, use the getSnapshotHeaders(com.hp.ucmdb.api.snapshots.SnapshotFilter) method.

getSnapshotHeaders

Collection<SnapshotHeader> getSnapshotHeaders(SnapshotFilter filter)

Returns all snapshots according to the filter.

getAllSnapshotHeaders

Collection<SnapshotHeader> getAllSnapshotHeaders()

Returns all the snapshots headers.

getSnapshot

Snapshot getSnapshot(SnapshotHeader snapshotHeader)

Returns the topology for the snapshot header.

Parameters:

snapshotHeader -

Returns:

compareViewSnapshots

@NotFinalAPI
ViewSnapshotCompareResult compareViewSnapshots(SnapshotHeader snapshotHeader1,
                                                            SnapshotHeader snapshotHeader2)

Returns the view result representing the snapshot identified by the given snapshot header and the view result of the "current" version of the same view.

If both snapshots are "view snapshot"s, both of the same view, and the query version embedded in the snapshots is the same as the current query version of the view, then the view results are folded according to the current view folding definition. Otherwise, a default folding definition is used.

Parameters:

snapshotHeader1 - the first snapshot.

snapshotHeader2 - the second snapshot.

Returns:

a ViewSnapshotCompareResult, holding the snapshot information and view results.

compareViewSnapshotAgainstCurrent

@NotFinalAPI
ViewSnapshotCompareResult compareViewSnapshotAgainstCurrent(SnapshotHeader snapshotHeader)

Returns the view result representing the snapshot identified by the given snapshot header and the view result of the "current" version of the same view.

If the snapshot is a "view snapshot" of the given view name, and the query version embedded in the snapshot is the same as the current query version of the view, then the view results is folded according to the current view folding definition. Otherwise, a default folding definition is used.

If the UCMDB does not contain either a view with the same name as the snapshot header view (if view information is available) or a query with the same name as the snapshot header query, an exception is thrown.

Parameters:

snapshotHeader - the snapshot to compare.

Returns:

a ViewSnapshotCompareResult, holding the snapshot information and view results.

compareQuerySnapshots

@NotFinalAPI
QuerySnapshotCompareResult compareQuerySnapshots(SnapshotHeader snapshotHeader1,
                                                              SnapshotHeader snapshotHeader2)

Returns the topologies representing the two snapshots identified by the snapshot headers.

Also returns a flag indicating whether both topologies originated from exactly the same query (same query version for the query and all the queries it depends on).

Parameters:

snapshotHeader1 - the first snapshot.

snapshotHeader2 - the second snapshot.

Returns:

a QuerySnapshotCompareResult, holding the snapshot information and query results.

compareQuerySnapshotAgainstCurrent

@NotFinalAPI
QuerySnapshotCompareResult compareQuerySnapshotAgainstCurrent(SnapshotHeader snapshotHeader)

Returns the topology representing the snapshot identified by the given snapshot header and the topology of the "current" version of the same TQL.

Also returns a flag that indicates of both topologies originated from exactly the same query (same query version for the query and all the queries it depends on).

If the UCMDB does not contain a query with the same name as the snapshot header query, exception is thrown.

Parameters:

snapshotHeader - the snapshot to compare.

Returns:

a QuerySnapshotCompareResult, holding the snapshot information and query results.