com.businessobjects.sdk.plugin.admin.docprocessingserveradmin
Interface IDocProcessingCacheAdmin

Deprecated. As of version 12.0. See the BusinessObjects Enterprise SDK Java Developer Guide for information on how to programmatically perform server administration tasks using the new Server Intelligence framework.

public interface IDocProcessingCacheAdmin

The IDocProcessingCacheAdmin interface allows you manage the metrics and properties for the Desktop Intelligence Cache Server.

Method Summary

void	commit() Deprecated. As of version 12.0.
int	getBytesTransferred() Deprecated. As of version 12.0.
int	getCacheSize() Deprecated. As of version 12.0.
int	getCacheSizeUpdate() Deprecated. As of version 12.0.
int	getConnections() 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.
IDocProcessingProcServerConnection[]	getDocProcessingProcServerConnection() Deprecated. As of version 12.0.
long	getDriveSpaceUsed() Deprecated. As of version 12.0.
double	getHitRate() Deprecated. As of version 12.0.
int	getMaxIdleTime() Deprecated. As of version 12.0.
int	getMaxIdleTimeUpdate() Deprecated. As of version 12.0.
int	getMaxThreads() Deprecated. As of version 12.0.
int	getMaxThreadsUpdate() Deprecated. As of version 12.0.
java.lang.String	getObjectDLLName() Deprecated. As of version 12.0.
java.lang.String	getObjectTypeName() 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.
int	getThreads() Deprecated. As of version 12.0.
int	getTotalRequests() Deprecated. As of version 12.0.
boolean	isRefreshAlwaysHitsDB() Deprecated. As of version 12.0.
boolean	isRefreshAlwaysHitsDBUpdate() Deprecated. As of version 12.0.
boolean	isShareData() Deprecated. As of version 12.0.
boolean	isShareDataUpdate() Deprecated. As of version 12.0.
void	setCacheSizeUpdate(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	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.
void	setShareDataUpdate(boolean b) Deprecated. As of version 12.0.

Method Detail

commit

void commit()
            throws SDKException

Deprecated. As of version 12.0.

Commits the updates that have been made to the server's cache expiry time.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDirectoryUpdate

java.lang.String getDirectoryUpdate()
                                    throws SDKException

Deprecated. As of version 12.0.

Returns the Desktop Intelligence Cache Server's directory path.

Returns:

A String containing the 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 Desktop Intelligence Cache Server's directory path. This will take effect once you commit the changes and the Crystal Reports Cache Server is restarted.

Parameters:

s - A String that specifies the Crystal Reports Cache 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 that specifies 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 you commit the changes and the Desktop Intelligence Cache Server is restarted.

Parameters:

n - An int that specifies 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 that contains 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 you commit the changes and the Desktop Intelligence Cache Server is restarted.

Parameters:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCacheSizeUpdate

int getCacheSizeUpdate()
                       throws SDKException

Deprecated. As of version 12.0.

Returns the cache size in KB.

Returns:

An int that specifies 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 Desktop Intelligence Cache Server is restarted.

Parameters:

n - An int that specifies the new cache size in KB.

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 the database, and false otherwise.

Returns:

A boolean indicating whether the viewer refresh always hits the 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 the viewer to refresh when it hits the database. Set to false if you do not want this option enabled. This will take effect once you commit the changes and the Desktop Intelligence Cache Server is restarted.

Parameters:

s - A boolean to let viewer refresh when it 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 number of minutes that the server will process data before the data is refreshed and given to a client.

Returns:

An int that contains the number of minutes that the server will process data before the data is refreshed and given to a client.

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 number of minutes that the server will process data before the data is refreshed and given to a client. This will take effect once you commit the changes and the Desktop Intelligence Cache Server is restarted.

Parameters:

n - An int that contains the number of minutes that the server will process data before the data is refreshed.

Throws:

SDKException - This is thrown if the process is unsuccessful

isShareDataUpdate

boolean isShareDataUpdate()
                          throws SDKException

Deprecated. As of version 12.0.

Returns a boolean that indicates if the cache server's default behaviour is to share documents. The share documents feature allows different users to view the same document without separate requests to the database. The share documents feature will increase performance and scalability by reducing requests to the database.

Throws:

SDKException - This is thrown if the process is unsuccessful

setShareDataUpdate

void setShareDataUpdate(boolean b)
                        throws SDKException

Deprecated. As of version 12.0.

Sets the cache server's default share document behaviour. The share documents feature allows different users to view the same document without separate requests to the database. The share documents behaviour will increase performance and scalability by reducing requests to the database.

Parameters:

b - A boolean to set the server's default share document behaviour.

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 Desktop Intelligence Cache Server's current directory path.

Returns:

A String that contains the Cache 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 a cache server will allow.

Returns:

An int that specifies 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 that specifies the maximum time in minutes before an idle job is closed.

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 of the server in KB.

Returns:

An int that specifies the current cache size in KB.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isRefreshAlwaysHitsDB

boolean isRefreshAlwaysHitsDB()
                              throws SDKException

Deprecated. As of version 12.0.

Returns true if the viewer refreshes when it hits database, false otherwise.

Returns:

A boolean that indicates whether the viewer will refresh when it 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 number of minutes that the server will process data before the data is refreshed and given to a client.

Returns:

An int that contains the number of minutes that the server will process data before the data is refreshed.

Throws:

SDKException - This is thrown if the process is unsuccessful

isShareData

boolean isShareData()
                    throws SDKException

Deprecated. As of version 12.0.

Returns true if the server's default behaviour is to share documents.

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 Desktop Intelligence Cache Server(s).

Returns:

An int that specifies the total number of current connections from the Desktop Intelligence 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 Desktop Intelligence Cache Server(s) requests in the queue that are waiting to be processed.

Returns:

An int that specifies the number of Desktop Intelligence 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 that specifies 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 by the cache server.

Returns:

An int that specifies 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 that specifies the total number of bytes transferred in KB.

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 Desktop Intelligence Cache Server.

Returns:

A long that specifies 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 Desktop Intelligence Cache Server's cache.

Returns:

A double that specifies the rate at which requests can be fulfilled by the Cache Server's cache.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDocProcessingProcServerConnection

IDocProcessingProcServerConnection[] getDocProcessingProcServerConnection()
                                                                          throws SDKException

Deprecated. As of version 12.0.

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

Returns:

An array that contains a collection of Page Servers connected to the current

Throws:

SDKException - This is thrown if the process is unsuccessful.

getObjectTypeName

java.lang.String getObjectTypeName()
                                   throws SDKException

Deprecated. As of version 12.0.

Returns the document type specific for the Server

Returns:

A String that specifies the document type.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getObjectDLLName

java.lang.String getObjectDLLName()
                                  throws SDKException

Deprecated. As of version 12.0.

Returns the dll name specific for the Server

Returns:

A String that specifies the dll name.

Throws:

SDKException - This is thrown if the process is unsuccessful.