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

All Known Subinterfaces:

ICacheServerAdmin

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() Commits to the CMS any changes that are made to the Crystal Reports Page Server.
int	getBytesTransferred() Returns the total number of bytes transferred in KB.
int	getConnections() Returns the total number of current connections from the Crystal Reports Cache Server(s).
int	getDBRecordNum() Returns the maximum number of database records to read, 0 is unlimited
int	getDBRecordNumUpdate() Returns the maximum number of database records to read, 0 is unlimited
java.lang.String	getDirectory() Returns the Crystal Reports Page Server's current directory path.
java.lang.String	getDirectoryUpdate() Returns the Crystal Reports Page Server's directory path.
int	getMaxIdleTime() Returns the maximum time in minutes before an idle job is closed.
int	getMaxIdleTimeUpdate() Returns the maximum time in minutes before an idle job is closed.
int	getMaxProcessingTime() Returns maximum minutes before processing is stopped.
int	getMaxProcessingTimeUpdate() Returns maximum minutes before processing is stopped.
int	getMaxThreads() Returns the maximum number of simultaneous processing threads.
int	getMaxThreadsUpdate() Returns the maximum number of simultaneous processing threads.
int	getQueuedRequests() Returns the number of Crystal Reports Cache Server(s) requests in the queue that are waiting to be processed.
int	getRefresh() Returns the oldest processed data given to a client in minutes.
int	getRefreshUpdate() Returns the oldest processed data given to a client in minutes.
java.lang.String	getServerLoad() Deprecated. This method has been deprecated. The Crystal Reports Page/Cache Server no longer provides this metric.
int	getThreads() Returns the current number of processing threads that are running.
int	getTotalRequests() Returns the total number of requests served.
boolean	isAutomaticDBDisconnect() Returns true if report job automatically disconnects from database and disconnects when it is closed.
boolean	isAutomaticDBDisconnectUpdate() Returns a boolean that indicates whether the Crystal Reports Page Server automatically disconnects from the database after all records have been retrieved.
boolean	isRefreshAlwaysHitsDB() Returns true if viewer refresh always hits database.
boolean	isRefreshAlwaysHitsDBUpdate() Returns true if viewer refresh always hits the database.
void	setAutomaticDBDisconnectUpdate(boolean s) Sets a boolean that indicates whether the Crystal Reports Page Server automatically disconnects from the database after all records have been retrieved.
void	setDBRecordNumUpdate(int n) Sets the maximum number of database records to read; 0 is unlimited.
void	setDirectoryUpdate(java.lang.String s) Sets the Crystal Reports Page Server's directory path.
void	setMaxIdleTimeUpdate(int n) Sets the maximum time in minutes before an idle job is closed.
void	setMaxProcessingTimeUpdate(int n) Sets the maximum number of minutes before processing is stopped.
void	setMaxThreadsUpdate(int n) Sets the maximum number of simultaneous processing threads.
void	setRefreshAlwaysHitsDBUpdate(boolean s) Set to true if you want to let the viewer refresh when it hits the database.
void	setRefreshUpdate(int n) Sets the oldest processed data given to a client in minutes.

Method Detail

getDirectoryUpdate

public java.lang.String getDirectoryUpdate()
                                    throws SDKException

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

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

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

public int getMaxThreadsUpdate()
                        throws SDKException

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

public void setMaxThreadsUpdate(int n)
                         throws SDKException

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. For more information on starting servers, see the BusinessObjects Enterprise Administrator’s Guide.

For more information on performance, see “Modifying Crystal Reports Page Server performance settings” in the BusinessObjects Enterprise Administrator’s Guide.

Parameters:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxIdleTimeUpdate

public int getMaxIdleTimeUpdate()
                         throws SDKException

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

public void setMaxIdleTimeUpdate(int n)
                          throws SDKException

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. For more information on starting servers, see the BusinessObjects Enterprise Administrator’s Guide.

For more information on performance, see “Modifying Crystal Reports Page Server performance settings” in the BusinessObjects Enterprise Administrator’s Guide.

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

public int getDBRecordNumUpdate()
                         throws SDKException

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

public void setDBRecordNumUpdate(int n)
                          throws SDKException

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. For more information on starting servers, see the BusinessObjects Enterprise Administrator’s Guide.

For more information on performance, see “Modifying Crystal Reports Page Server performance settings” in the BusinessObjects Enterprise Administrator’s Guide.

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

public boolean isRefreshAlwaysHitsDBUpdate()
                                    throws SDKException

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

Returns:

A boolean indicating whether viewer refresh always hits database.

Throws:

SDKException - This is thrown if the process is unsuccessful

setRefreshAlwaysHitsDBUpdate

public void setRefreshAlwaysHitsDBUpdate(boolean s)
                                  throws SDKException

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. For more information on starting servers, see the BusinessObjects Enterprise Administrator’s Guide.

For more information on performance, see “Modifying Crystal Reports Page Server performance settings” in the BusinessObjects Enterprise Administrator’s Guide.

Parameters:

s - A boolean to let viewer refresh hits the database

Throws:

SDKException - This is thrown if the process is unsuccessful

getRefreshUpdate

public int getRefreshUpdate()
                     throws SDKException

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

public void setRefreshUpdate(int n)
                      throws SDKException

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. For more information on starting servers, see the BusinessObjects Enterprise Administrator’s Guide.

For more information on performance, see “Modifying Crystal Reports Page Server performance settings” in the BusinessObjects Enterprise Administrator’s Guide.

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

public int getMaxProcessingTimeUpdate()
                               throws SDKException

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

public void setMaxProcessingTimeUpdate(int n)
                                throws SDKException

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. For more information on starting servers, see the BusinessObjects Enterprise Administrator’s Guide.

For more information on performance, see “Modifying Crystal Reports Page Server performance settings” in the BusinessObjects Enterprise Administrator’s Guide.

Parameters:

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

Throws:

SDKException - This is thrown if the process is unsuccessful

isAutomaticDBDisconnectUpdate

public boolean isAutomaticDBDisconnectUpdate()
                                      throws SDKException

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

public void setAutomaticDBDisconnectUpdate(boolean s)
                                    throws SDKException

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. For more information on starting servers, see the BusinessObjects Enterprise Administrator’s Guide.

For more information on performance, see “Modifying Crystal Reports Page Server performance settings” in the BusinessObjects Enterprise Administrator’s Guide.

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

public void commit()
            throws SDKException

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

public java.lang.String getDirectory()
                              throws SDKException

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

public int getMaxThreads()
                  throws SDKException

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

public int getMaxIdleTime()
                   throws SDKException

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

public int getConnections()
                   throws SDKException

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

public int getQueuedRequests()
                      throws SDKException

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

public int getThreads()
               throws SDKException

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

public int getTotalRequests()
                     throws SDKException

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

public int getBytesTransferred()
                        throws SDKException

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

public java.lang.String getServerLoad()
                               throws SDKException

Deprecated. 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

public int getDBRecordNum()
                   throws SDKException

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

public boolean isRefreshAlwaysHitsDB()
                              throws SDKException

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

public int getRefresh()
               throws SDKException

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

public int getMaxProcessingTime()
                         throws SDKException

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

public boolean isAutomaticDBDisconnect()
                                throws SDKException

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