com.crystaldecisions.sdk.plugin.admin.cachepageserveradmin
Interface ICacheServerAdmin

All Superinterfaces:

IPageServerAdmin

Deprecated. As of version 12.0.

public interface ICacheServerAdmin
extends IPageServerAdmin

This interface provides metrics and administration for the Crystal Reports Cache Server. It stores information about the maximum processing threads, the maximum cache size, the minutes before an idle job is closed, the location of the cache files, the total threads running, the number of requests served, the number of bytes transferred, the cache hit rate, the number of current connections, and the number of requests that are queued. You can also retrieve the collection of Crystal Reports Page Servers that the Crystal Reports Cache Server has connections to, and the number of connections made to the Page Server(s). This interface allows you to set the directory for the Crystal Reports Cache Server, the maximum idle time before a job is closed, and the maximum number of simultaneous processing threads allowed by the Crystal Reports Cache Server.

Method Summary

int	getCacheSize() Deprecated. As of version 12.0.
int	getCacheSizeUpdate() Deprecated. As of version 12.0.
long	getDriveSpaceUsed() Deprecated. As of version 12.0.
double	getHitRate() Deprecated. As of version 12.0.
IPageServerConnection[]	getPageServerConnection() Deprecated. As of version 12.0.
int	getRefresh() Deprecated. As of version 12.0.
int	getRefreshUpdate() Deprecated. As of version 12.0.
boolean	isDbAlwaysHitOnRefresh() Deprecated. As of version 12.0.
boolean	isDbAlwaysHitOnRefreshUpdate() Deprecated. As of version 12.0.
void	setCacheSizeUpdate(int n) Deprecated. As of version 12.0.
void	setDbAlwaysHitOnRefreshUpdate(boolean s) Deprecated. As of version 12.0.
void	setRefreshUpdate(int n) Deprecated. As of version 12.0.

Methods inherited from interface com.crystaldecisions.sdk.plugin.admin.cachepageserveradmin.IPageServerAdmin

commit, getBytesTransferred, getConnections, getDBRecordNum, getDBRecordNumUpdate, getDirectory, getDirectoryUpdate, getMaxIdleTime, getMaxIdleTimeUpdate, getMaxProcessingTime, getMaxProcessingTimeUpdate, getMaxThreads, getMaxThreadsUpdate, getQueuedRequests, getServerLoad, getThreads, getTotalRequests, isAutomaticDBDisconnect, isAutomaticDBDisconnectUpdate, isRefreshAlwaysHitsDB, isRefreshAlwaysHitsDBUpdate, setAutomaticDBDisconnectUpdate, setDBRecordNumUpdate, setDirectoryUpdate, setMaxIdleTimeUpdate, setMaxProcessingTimeUpdate, setMaxThreadsUpdate, setRefreshAlwaysHitsDBUpdate

Method Detail

getCacheSizeUpdate

int getCacheSizeUpdate()
                       throws SDKException

Deprecated. As of version 12.0.

Returns the cache size in KB.

Returns:

An int specifying the cache size in KB.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCacheSizeUpdate

void setCacheSizeUpdate(int n)
                        throws SDKException

Deprecated. As of version 12.0.

Sets the cache size in KB. This will take effect once the Crystal Reports Cache Server is restarted.

Parameters:

n - An int specifying the new cache size in KB.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getRefreshUpdate

int getRefreshUpdate()
                     throws SDKException

Deprecated. As of version 12.0.

Returns the amount of time in minutes before a shareable report will refresh from the database. This returns the value that will take effect once the Crystal Reports Cache Server is restarted.

Specified by:

getRefreshUpdate in interface IPageServerAdmin

Returns:

An int specifying the amount of time in minutes before a shareable report will refresh from the database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setRefreshUpdate

void setRefreshUpdate(int n)
                      throws SDKException

Deprecated. As of version 12.0.

Sets the amount of time in minutes before a shareable report will refresh from the database. This will take effect once the Crystal Reports Cache Server is restarted.

Specified by:

setRefreshUpdate in interface IPageServerAdmin

Parameters:

n - An int specifying the amount of time in minutes before a shareable report will refresh from the database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isDbAlwaysHitOnRefreshUpdate

boolean isDbAlwaysHitOnRefreshUpdate()
                                     throws SDKException

Deprecated. As of version 12.0.

Returns whether or not a request to refresh the report from the viewer will always hit the database. This returns the value that will take effect once the Crystal Reports Cache Server is restarted.

Returns:

A boolean specifying whether or not a request to refresh the report from the viewer will always hit the database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDbAlwaysHitOnRefreshUpdate

void setDbAlwaysHitOnRefreshUpdate(boolean s)
                                   throws SDKException

Deprecated. As of version 12.0.

Sets whether or not a request to refresh the report from the viewer will always hit the database. This will take effect once the Crystal Reports Cache Server is restarted.

Parameters:

s - A boolean specifying whether or not a request to refresh the report from the viewer will always hit the database. This will either be true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCacheSize

int getCacheSize()
                 throws SDKException

Deprecated. As of version 12.0.

Returns the current cache size in KB.

Returns:

An int specifying the current cache size in KB.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getRefresh

int getRefresh()
               throws SDKException

Deprecated. As of version 12.0.

Returns the amount of time in minutes before a shareable report will refresh from the database.

Specified by:

getRefresh in interface IPageServerAdmin

Returns:

An int specifying the amount of time in minutes before a shareable report will refresh from the database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isDbAlwaysHitOnRefresh

boolean isDbAlwaysHitOnRefresh()
                               throws SDKException

Deprecated. As of version 12.0.

Returns whether or not a request to refresh the report from the viewer will always hit the database.

Returns:

A boolean specifying whether or not a request to refresh the report from the viewer will always hit the database.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDriveSpaceUsed

long getDriveSpaceUsed()
                       throws SDKException

Deprecated. As of version 12.0.

Returns the amount of disk space, in KB, used by the Crystal Reports Cache Server.

Returns:

A long specifying the amount of disk space, in KB, used by the Crystal Reports Cache Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getHitRate

double getHitRate()
                  throws SDKException

Deprecated. As of version 12.0.

Returns the rate at which requests can be fulfilled by the Crystal Reports Cache Server's cache.

Returns:

A double specifying the rate at which requests can be fulfilled by the Crystal Reports Cache Server's cache.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPageServerConnection

IPageServerConnection[] getPageServerConnection()
                                                throws SDKException

Deprecated. As of version 12.0.

Returns the collection of Crystal Reports Page Servers connected to the current Crystal Reports Cache Server.

Returns:

An array containing the collection of Crystal Reports Page Servers connected to the current Crystal Reports Cache Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.