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

All Known Subinterfaces:

ICacheServerAdmin

Deprecated. As of version 12.0.

public interface IPageServerAdmin

This interface provides metrics and administration for the Crystal Reports Server. It stores information about the maximum number of simultaneous processing threads, the current number of processing threads running, the location of temp files, the number of minutes before an idle job is closed, the number of current connections, the number of requests queued, the total number of requests served, and the total bytes transferred. Management includes setting the directory for the Crystal Reports Page Server, the maximum idle time before a job is closed, and the maximum number of simultaneous processing threads allowed by the Crystal Reports Page Server.

Method Summary

void	commit() Deprecated. As of version 12.0.
int	getBytesTransferred() Deprecated. As of version 12.0.
int	getConnections() Deprecated. As of version 12.0.
int	getDBRecordNum() Deprecated. As of version 12.0.
int	getDBRecordNumUpdate() Deprecated. As of version 12.0.
java.lang.String	getDirectory() Deprecated. As of version 12.0.
java.lang.String	getDirectoryUpdate() Deprecated. As of version 12.0.
int	getMaxIdleTime() Deprecated. As of version 12.0.
int	getMaxIdleTimeUpdate() Deprecated. As of version 12.0.
int	getMaxProcessingTime() Deprecated. As of version 12.0.
int	getMaxProcessingTimeUpdate() Deprecated. As of version 12.0.
int	getMaxThreads() Deprecated. As of version 12.0.
int	getMaxThreadsUpdate() Deprecated. As of version 12.0.
int	getQueuedRequests() Deprecated. As of version 12.0.
int	getRefresh() Deprecated. As of version 12.0.
int	getRefreshUpdate() Deprecated. As of version 12.0.
java.lang.String	getServerLoad() Deprecated. As of version 12.0. This method has been deprecated. The Crystal Reports Page/Cache Server no longer provides this metric.
int	getThreads() Deprecated. As of version 12.0.
int	getTotalRequests() Deprecated. As of version 12.0.
boolean	isAutomaticDBDisconnect() Deprecated. As of version 12.0.
boolean	isAutomaticDBDisconnectUpdate() Deprecated. As of version 12.0.
boolean	isRefreshAlwaysHitsDB() Deprecated. As of version 12.0.
boolean	isRefreshAlwaysHitsDBUpdate() Deprecated. As of version 12.0.
void	setAutomaticDBDisconnectUpdate(boolean s) Deprecated. As of version 12.0.
void	setDBRecordNumUpdate(int n) Deprecated. As of version 12.0.
void	setDirectoryUpdate(java.lang.String s) Deprecated. As of version 12.0.
void	setMaxIdleTimeUpdate(int n) Deprecated. As of version 12.0.
void	setMaxProcessingTimeUpdate(int n) Deprecated. As of version 12.0.
void	setMaxThreadsUpdate(int n) Deprecated. As of version 12.0.
void	setRefreshAlwaysHitsDBUpdate(boolean s) Deprecated. As of version 12.0.
void	setRefreshUpdate(int n) Deprecated. As of version 12.0.

Method Detail

getDirectoryUpdate

java.lang.String getDirectoryUpdate()
                                    throws SDKException

Deprecated. As of version 12.0.

Returns the Crystal Reports Page Server's directory path.

Returns:

A String containing the Crystal Reports Page Server's directory path.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDirectoryUpdate

void setDirectoryUpdate(java.lang.String s)
                        throws SDKException

Deprecated. As of version 12.0.

Sets the Crystal Reports Page Server's directory path. This will take effect once the Crystal Reports Page Server is restarted.

Parameters:

s - A String specifying the Crystal Reports Page Server's directory path.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxThreadsUpdate

int getMaxThreadsUpdate()
                        throws SDKException

Deprecated. As of version 12.0.

Returns the maximum number of simultaneous processing threads.

Returns:

An int specifying the maximum number of simultaneous processing threads.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMaxThreadsUpdate

void setMaxThreadsUpdate(int n)
                         throws SDKException

Deprecated. As of version 12.0.

Sets the maximum number of simultaneous processing threads. This will take effect once the Crystal Reports Page Server is restarted. To do this you must first commit the changes and then restart the Crystal Reports Page Server. Restart the server through the SDK using the manageServer method. You can also restart the server through the Central Configuration Manager or the Central Management Console.

Parameters:

n - An int specifying the maximum number of simultaneous threads.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxIdleTimeUpdate

int getMaxIdleTimeUpdate()
                         throws SDKException

Deprecated. As of version 12.0.

Returns the maximum time in minutes before an idle job is closed.

Returns:

An int containing the maximum time in minutes before an idle job is closed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMaxIdleTimeUpdate

void setMaxIdleTimeUpdate(int n)
                          throws SDKException

Deprecated. As of version 12.0.

Sets the maximum time in minutes before an idle job is closed. This will take effect once the Crystal Reports Page Server is restarted. To do this you must first commit the changes and then restart the Crystal Reports Page Server. Restart the server through the SDK using the manageServer method. You can also restart the server through the Central Configuration Manager or the Central Management Console.

Parameters:

n - An int containing the maximum time in minutes before an idle job is closed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDBRecordNumUpdate

int getDBRecordNumUpdate()
                         throws SDKException

Deprecated. As of version 12.0.

Returns the maximum number of database records to read, 0 is unlimited

Returns:

An int containing the maximum number of database records to read, 0 is unlimited

Throws:

SDKException - This is thrown if the process is unsuccessful

setDBRecordNumUpdate

void setDBRecordNumUpdate(int n)
                          throws SDKException

Deprecated. As of version 12.0.

Sets the maximum number of database records to read; 0 is unlimited. This will take effect once the Crystal Reports Page Server is restarted. To do this you must first commit the changes and then restart the Crystal Reports Page Server. Restart the server through the SDK using the manageServer method. You can also restart the server through the Central Configuration Manager or the Central Management Console.

Parameters:

n - An int containing the maximum number of database records to read, 0 is unlimited

Throws:

SDKException - This is thrown if the process is unsuccessful

isRefreshAlwaysHitsDBUpdate

boolean isRefreshAlwaysHitsDBUpdate()
                                    throws SDKException

Deprecated. As of version 12.0.

Returns true if viewer refresh always hits database. False otherwise.

Returns:

A boolean indicating whether viewer refresh always hits database.

Throws:

SDKException - This is thrown if the process is unsuccessful

setRefreshAlwaysHitsDBUpdate

void setRefreshAlwaysHitsDBUpdate(boolean s)
                                  throws SDKException

Deprecated. As of version 12.0.

Set to true if you want to let the viewer refresh when it hits the database. Set to False if you do not want this option enabled. This will take effect once the Crystal Reports Page Server is restarted. To do this you must first commit the changes and then restart the Crystal Reports Page Server. Restart the server through the SDK using the manageServer method. You can also restart the server through the Central Configuration Manager or the Central Management Console.

Parameters:

s - A boolean to let viewer refresh hits the database

Throws:

SDKException - This is thrown if the process is unsuccessful

getRefreshUpdate

int getRefreshUpdate()
                     throws SDKException

Deprecated. As of version 12.0.

Returns the oldest processed data given to a client in minutes.

Returns:

An int containing the oldest processed data given to a client in minutes.

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 oldest processed data given to a client in minutes. This will take effect once the Crystal Reports Page Server is restarted. To do this you must first commit the changes and then restart the Crystal Reports Page Server. Restart the server through the SDK using the manageServer method. You can also restart the server through the Central Configuration Manager or the Central Management Console.

Parameters:

n - An int containing the oldest processed data given to a client in minutes.

Throws:

SDKException - This is thrown if the process is unsuccessful

getMaxProcessingTimeUpdate

int getMaxProcessingTimeUpdate()
                               throws SDKException

Deprecated. As of version 12.0.

Returns maximum minutes before processing is stopped.

Returns:

An int containing the maximum minutes before processing is stopped.

Throws:

SDKException - This is thrown if the process is unsuccessful

setMaxProcessingTimeUpdate

void setMaxProcessingTimeUpdate(int n)
                                throws SDKException

Deprecated. As of version 12.0.

Sets the maximum number of minutes before processing is stopped. This will take effect once the Crystal Reports Page Server is restarted. To do this you must first commit the changes and then restart the Crystal Reports Page Server. Restart the server through the SDK using the manageServer method. You can also restart the server through the Central Configuration Manager or the Central Management Console.

Parameters:

n - An int containing the maximum minutes before processing is stopped.

Throws:

SDKException - This is thrown if the process is unsuccessful

isAutomaticDBDisconnectUpdate

boolean isAutomaticDBDisconnectUpdate()
                                      throws SDKException

Deprecated. As of version 12.0.

Returns a boolean that indicates whether the Crystal Reports Page Server automatically disconnects from the database after all records have been retrieved.

Returns:

true if the Crystal Reports Page Server automatically disconnects from the database after all records have been retrieved, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful

setAutomaticDBDisconnectUpdate

void setAutomaticDBDisconnectUpdate(boolean s)
                                    throws SDKException

Deprecated. As of version 12.0.

Sets a boolean that indicates whether the Crystal Reports Page Server automatically disconnects from the database after all records have been retrieved. This will take effect once the Crystal Reports Page Server is restarted. To do this you must first commit the changes and then restart the Crystal Reports Page Server. Restart the server through the SDK using the manageServer method. You can also restart the server through the Central Configuration Manager or the Central Management Console.

Parameters:

s - A boolean that specifies whether the server automatically disconnects from the database after all records have been retrieved.

Throws:

SDKException - This is thrown if the process is unsuccessful

commit

void commit()
            throws SDKException

Deprecated. As of version 12.0.

Commits to the CMS any changes that are made to the Crystal Reports Page Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDirectory

java.lang.String getDirectory()
                              throws SDKException

Deprecated. As of version 12.0.

Returns the Crystal Reports Page Server's current directory path.

Returns:

A String containing the Page Server's current directory path.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxThreads

int getMaxThreads()
                  throws SDKException

Deprecated. As of version 12.0.

Returns the maximum number of simultaneous processing threads.

Returns:

An int specifying the maximum number of simultaneous processing threads.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxIdleTime

int getMaxIdleTime()
                   throws SDKException

Deprecated. As of version 12.0.

Returns the maximum time in minutes before an idle job is closed.

Returns:

An int specifying the maximum time in minutes before an idle job is closed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getConnections

int getConnections()
                   throws SDKException

Deprecated. As of version 12.0.

Returns the total number of current connections from the Crystal Reports Cache Server(s).

Returns:

An int specifying the total number of current connections from the Crystal Reports Cache Server(s).

Throws:

SDKException - This is thrown if the process is unsuccessful.

getQueuedRequests

int getQueuedRequests()
                      throws SDKException

Deprecated. As of version 12.0.

Returns the number of Crystal Reports Cache Server(s) requests in the queue that are waiting to be processed.

Returns:

An int specifying the number of Crystal Reports Cache Server(s) requests in the queue that are waiting to be processed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getThreads

int getThreads()
               throws SDKException

Deprecated. As of version 12.0.

Returns the current number of processing threads that are running.

Returns:

An int specifying the number of threads that are running.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getTotalRequests

int getTotalRequests()
                     throws SDKException

Deprecated. As of version 12.0.

Returns the total number of requests served.

Returns:

An int specifying the total number of requests served.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getBytesTransferred

int getBytesTransferred()
                        throws SDKException

Deprecated. As of version 12.0.

Returns the total number of bytes transferred in KB.

Returns:

An int specifying the total number of bytes transferred in KB.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getServerLoad

java.lang.String getServerLoad()
                               throws SDKException

Deprecated. As of version 12.0. This method has been deprecated. The Crystal Reports Page/Cache Server no longer provides this metric.

Returns the current load on the Crystal Reports Page Server.

Returns:

A String containing the current server load.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDBRecordNum

int getDBRecordNum()
                   throws SDKException

Deprecated. As of version 12.0.

Returns the maximum number of database records to read, 0 is unlimited

Returns:

An int containing the maximum number of database records to read, 0 is unlimited

Throws:

SDKException - This is thrown if the process is unsuccessful

isRefreshAlwaysHitsDB

boolean isRefreshAlwaysHitsDB()
                              throws SDKException

Deprecated. As of version 12.0.

Returns true if viewer refresh always hits database. False otherwise.

Returns:

A boolean indicating whether viewer refresh always hits database.

Throws:

SDKException - This is thrown if the process is unsuccessful

getRefresh

int getRefresh()
               throws SDKException

Deprecated. As of version 12.0.

Returns the oldest processed data given to a client in minutes.

Returns:

An int containing the oldest processed data given to a client in minutes.

Throws:

SDKException - This is thrown if the process is unsuccessful

getMaxProcessingTime

int getMaxProcessingTime()
                         throws SDKException

Deprecated. As of version 12.0.

Returns maximum minutes before processing is stopped.

Returns:

An int containing the maximum minutes before processing is stopped.

Throws:

SDKException - This is thrown if the process is unsuccessful

isAutomaticDBDisconnect

boolean isAutomaticDBDisconnect()
                                throws SDKException

Deprecated. As of version 12.0.

Returns true if report job automatically disconnects from database and disconnects when it is closed. Returns false if report job stays connected to database until it is closed.

Returns:

A boolean indicating if automatic disconnect is in use.

Throws:

SDKException - This is thrown if the process is unsuccessful