com.crystaldecisions.sdk.plugin.admin.apsadmin
Interface IAPSAdmin

Deprecated. As of version 12.0.

public interface IAPSAdmin

This interface allows you to retrieve the metrics specific to an 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	getAPSBuildDate() Deprecated. As of version 12.0.
java.lang.String	getAPSDatabaseName() Deprecated. As of version 12.0.
java.lang.String	getAPSDatabaseServerName() Deprecated. As of version 12.0.
java.lang.String	getAPSDatabaseUserName() Deprecated. As of version 12.0.
java.lang.String	getAPSDataSourceName() Deprecated. As of version 12.0.
java.lang.String	getAPSPrivateBuildNumber() Deprecated. As of version 12.0.
java.lang.String	getAPSProductVersion() Deprecated. As of version 12.0.
java.lang.String	getAPSResourceVersion() Deprecated. As of version 12.0.
java.lang.String[]	getClusterMembers() Deprecated. As of version 12.0.
int	getFailedJobs() Deprecated. As of version 12.0.
int	getLicensesConcurrent() Deprecated. As of version 12.0.
int	getLicensesNamedUsers() Deprecated. As of version 12.0.
int	getLicensesProcessors() Deprecated. As of version 12.0.
int	getPendingJobs() Deprecated. As of version 12.0.
int	getRunningJobs() Deprecated. As of version 12.0.
int	getSuccessJobs() Deprecated. As of version 12.0.
int	getUserConnectedConcurrent() Deprecated. As of version 12.0.
int	getUserConnectedNamedUsers() Deprecated. As of version 12.0.
int	getUserExistingConcurrent() Deprecated. As of version 12.0.
int	getUserExistingNamedUsers() Deprecated. As of version 12.0.
int	getUserTokenConnections() Deprecated. As of version 12.0.
int	getWaitingJobs() Deprecated. As of version 12.0.

Method Detail

getClusterMembers

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

Deprecated. As of version 12.0.

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

int getFailedJobs()
                  throws SDKException

Deprecated. As of version 12.0.

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

int getPendingJobs()
                   throws SDKException

Deprecated. As of version 12.0.

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

int getRunningJobs()
                   throws SDKException

Deprecated. As of version 12.0.

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

int getSuccessJobs()
                   throws SDKException

Deprecated. As of version 12.0.

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

int getWaitingJobs()
                   throws SDKException

Deprecated. As of version 12.0.

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

int getLicensesConcurrent()
                          throws SDKException

Deprecated. As of version 12.0.

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

int getLicensesNamedUsers()
                          throws SDKException

Deprecated. As of version 12.0.

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

int getLicensesProcessors()
                          throws SDKException

Deprecated. As of version 12.0.

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.

getAPSBuildDate

java.lang.String getAPSBuildDate()
                                 throws SDKException

Deprecated. As of version 12.0.

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.

getAPSDatabaseName

java.lang.String getAPSDatabaseName()
                                    throws SDKException

Deprecated. As of version 12.0.

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.

getAPSDatabaseServerName

java.lang.String getAPSDatabaseServerName()
                                          throws SDKException

Deprecated. As of version 12.0.

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.

getAPSDatabaseUserName

java.lang.String getAPSDatabaseUserName()
                                        throws SDKException

Deprecated. As of version 12.0.

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.

getAPSDataSourceName

java.lang.String getAPSDataSourceName()
                                      throws SDKException

Deprecated. As of version 12.0.

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.

getAPSPrivateBuildNumber

java.lang.String getAPSPrivateBuildNumber()
                                          throws SDKException

Deprecated. As of version 12.0.

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.

getAPSProductVersion

java.lang.String getAPSProductVersion()
                                      throws SDKException

Deprecated. As of version 12.0.

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.

getAPSResourceVersion

java.lang.String getAPSResourceVersion()
                                       throws SDKException

Deprecated. As of version 12.0.

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

int getUserConnectedConcurrent()
                               throws SDKException

Deprecated. As of version 12.0.

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

int getUserConnectedNamedUsers()
                               throws SDKException

Deprecated. As of version 12.0.

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

int getUserExistingConcurrent()
                              throws SDKException

Deprecated. As of version 12.0.

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

int getUserExistingNamedUsers()
                              throws SDKException

Deprecated. As of version 12.0.

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

int getUserTokenConnections()
                            throws SDKException

Deprecated. As of version 12.0.

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.