Copyright © TIBCO Software Inc. All Rights Reserved

getInstanceStatus()

Purpose

This method returns information related to the current status of a repository instance.

It includes the number of clients and nodes, and also the current commit number for the specified instance.

The Total number of connections made until now return value counts the number of connections which have been made by any clients since the instance had started.

To retrieve the names of available instances, use getInstanceInfos().

Exceptions

This method throws exceptions:

•	If the client does not specify the instance name.

•	If the specified instance is not available on this server.

Type

Open, Synchronous, IMPACT_INFO

Parameters

 

Name	Description
Instance name	Name of the instance you are interested in.

Returns

 

Name	Description
Instance name	Name of the instance.
Number of currently connected read-only clients	Number of read-only clients that are connecting to the specified repository instance.
Number of currently connected read-write clients	Number of read-write clients that are connecting to the specified repository.
Total number of connections made until now	Number of connections which have been made by any clients since the instance started.
Total number of nodes	Total number of nodes in the specified repository instance.
Number of locked nodes	Number of the instance’s nodes that are locked by all repository clients.
Commit number of instance	Number of commits made on the specified repository instance since its creation.

Copyright © TIBCO Software Inc. All Rights Reserved