com.crystaldecisions.sdk.plugin.admin.cmsadmin
Interface ICMSAdmin

public interface ICMSAdmin

This interface allows you to retrieve the metrics specific to a CMS cluster. This information is useful to monitor CMS clusters, and includes metrics on the CMS database, licenses, scheduled jobs, and user connections.

Method Summary

java.lang.String[]	getClusterMembers() Returns a list of CMS machines in the cluster.
java.lang.String	getCMSBuildDate() Returns the build date of the CMS database.
java.lang.String	getCMSDatabaseName() Returns the name of the CMS database.
java.lang.String	getCMSDatabaseServerName() Returns the description of the CMS database.
java.lang.String	getCMSDatabaseUserName() Returns the user name of the CMS database.
java.lang.String	getCMSDataSourceName() Returns the CMS data source name.
java.lang.String	getCMSPrivateBuildNumber() Returns the private build number of the CMS.
java.lang.String	getCMSProductVersion() Returns the product version of the CMS.
java.lang.String	getCMSResourceVersion() Returns the version number of the CMS resource DLL.
int	getFailedJobs() Returns the total number of failed jobs in the cluster.
int	getLicensesConcurrent() Returns the total number of concurrent licenses for the cluster.
int	getLicensesNamedUsers() Returns the total number of named user licenses for the cluster.
int	getLicensesProcessors() Returns the total number of licensed processors for the cluster.
int	getPendingJobs() Returns the number of pending jobs in the cluster.
int	getRunningJobs() Returns the current number of running jobs in the cluster.
int	getSuccessJobs() Returns the number of successful jobs in the cluster.
int	getUserConnectedConcurrent() Returns the total number of connected users with concurrent licensing in the cluster.
int	getUserConnectedNamedUsers() Returns the total number of connected users with named licensing in the cluster.
int	getUserExistingConcurrent() Returns the total number of existing users with concurrent licensing in the cluster.
int	getUserExistingNamedUsers() Returns the total number of existing users with named licensing in the cluster.
int	getUserTokenConnections() Returns the total number of connections made to the cluster by servers using a server connection that does not use a license count.
int	getWaitingJobs() Returns the total number of waiting jobs in the cluster.

Method Detail

getClusterMembers

public java.lang.String[] getClusterMembers()
                                     throws SDKException

Returns a list of CMS machines in the cluster.

Returns:

An array of String objects containing the names of the CMS host machines.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFailedJobs

public int getFailedJobs()
                  throws SDKException

Returns the total number of failed jobs in the cluster.

Returns:

An int specifying the total number of failed jobs in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPendingJobs

public int getPendingJobs()
                   throws SDKException

Returns the number of pending jobs in the cluster.

Returns:

An int specifying the total number of pending jobs in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getRunningJobs

public int getRunningJobs()
                   throws SDKException

Returns the current number of running jobs in the cluster.

Returns:

An int specifying the current number of running jobs in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getSuccessJobs

public int getSuccessJobs()
                   throws SDKException

Returns the number of successful jobs in the cluster.

Returns:

An int specifying the number of successful jobs in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getWaitingJobs

public int getWaitingJobs()
                   throws SDKException

Returns the total number of waiting jobs in the cluster.

Returns:

An int specifying the number of waiting jobs in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLicensesConcurrent

public int getLicensesConcurrent()
                          throws SDKException

Returns the total number of concurrent licenses for the cluster.

Returns:

An int specifying the total number of concurrent licenses for the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLicensesNamedUsers

public int getLicensesNamedUsers()
                          throws SDKException

Returns the total number of named user licenses for the cluster.

Returns:

An int specifying the total number of named user licenses for the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLicensesProcessors

public int getLicensesProcessors()
                          throws SDKException

Returns the total number of licensed processors for the cluster.

Returns:

An int specifying the total number of licensed processors for the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCMSBuildDate

public java.lang.String getCMSBuildDate()
                                 throws SDKException

Returns the build date of the CMS database.

Returns:

A String containing the build date of the CMS database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCMSDatabaseName

public java.lang.String getCMSDatabaseName()
                                    throws SDKException

Returns the name of the CMS database.

Returns:

A String containing the name of the CMS database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCMSDatabaseServerName

public java.lang.String getCMSDatabaseServerName()
                                          throws SDKException

Returns the description of the CMS database.

Returns:

A String containing the description of the CMS database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCMSDatabaseUserName

public java.lang.String getCMSDatabaseUserName()
                                        throws SDKException

Returns the user name of the CMS database.

Returns:

A String containing the user name of the CMS database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCMSDataSourceName

public java.lang.String getCMSDataSourceName()
                                      throws SDKException

Returns the CMS data source name.

Returns:

A String containing the CMS data source name.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCMSPrivateBuildNumber

public java.lang.String getCMSPrivateBuildNumber()
                                          throws SDKException

Returns the private build number of the CMS.

Returns:

A String containing the private build number of the CMS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCMSProductVersion

public java.lang.String getCMSProductVersion()
                                      throws SDKException

Returns the product version of the CMS.

Returns:

A String containing the product version of the CMS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCMSResourceVersion

public java.lang.String getCMSResourceVersion()
                                       throws SDKException

Returns the version number of the CMS resource DLL.

Returns:

A String containing the version number of the CMS resource DLL.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUserConnectedConcurrent

public int getUserConnectedConcurrent()
                               throws SDKException

Returns the total number of connected users with concurrent licensing in the cluster.

Returns:

An int specifying the total number of connected users with concurrent licensing in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUserConnectedNamedUsers

public int getUserConnectedNamedUsers()
                               throws SDKException

Returns the total number of connected users with named licensing in the cluster.

Returns:

An int specifying the total number of connected users with named licensing in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUserExistingConcurrent

public int getUserExistingConcurrent()
                              throws SDKException

Returns the total number of existing users with concurrent licensing in the cluster.

Returns:

An int specifying the total number of existing users with concurrent licensing in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUserExistingNamedUsers

public int getUserExistingNamedUsers()
                              throws SDKException

Returns the total number of existing users with named licensing in the cluster.

Returns:

An int specifying the total number of existing users with named licensing in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUserTokenConnections

public int getUserTokenConnections()
                            throws SDKException

Returns the total number of connections made to the cluster by servers using a server connection that does not use a license count.

Returns:

An int specifying the total number of token connections in the cluster.

Throws:

SDKException - This is thrown if the process is unsuccessful.