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

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 IDocProcessingProcAdmin

The IDocProcessingProcAdmin interface allows you manage the metrics and properties for the Desktop Intelligence 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.
java.lang.String	getDirectory() Deprecated. As of version 12.0.
java.lang.String	getDirectoryUpdate() Deprecated. As of version 12.0.
int	getFailedRequests() Deprecated. As of version 12.0.
int	getMaxChildProcesses() Deprecated. As of version 12.0.
int	getMaxIdleTime() Deprecated. As of version 12.0.
int	getMaxIdleTimeUpdate() Deprecated. As of version 12.0.
int	getMaxLifetimeJobsPerChild() Deprecated. As of version 12.0.
int	getMaxLifetimeJobsPerChildUpdate() Deprecated. As of version 12.0.
int	getMaxNumPrestartedChildren() Deprecated. As of version 12.0.
int	getMaxNumPrestartedChildrenUpdate() 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.
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	setDirectoryUpdate(java.lang.String s) Deprecated. As of version 12.0.
void	setMaxIdleTimeUpdate(int n) Deprecated. As of version 12.0.
void	setMaxLifetimeJobsPerChildUpdate(int n) Deprecated. As of version 12.0.
void	setMaxNumPrestartedChildrenUpdate(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.
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 Page 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 Page Server's directory path. This will take effect once you commit the changes and the Crystal Reports Page Server is restarted.

Parameters:

s - A String that specifies the Desktop Intelligence Page Server 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 Page 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 Page 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.

isRefreshAlwaysHitsDBUpdate

boolean isRefreshAlwaysHitsDBUpdate()
                                    throws SDKException

Deprecated. As of version 12.0.

Returns true if the viewer refresh always hits the database and 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.

Sets 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 you commit the changes and the Desktop Intelligence Page Server is restarted.

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 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 since data was 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 number of minutes that the server will process data before the data is refreshed and given to a client.

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 the maximum number of minutes before processing a request is stopped.

Returns:

An int that contains 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 a request is stopped.

This will take effect once you commit the changes and the Desktop Intelligence Page Server is restarted.

For more information on performance, see "Modifying Desktop Intelligence Page Server performance settings" in the BusinessObjects Enterprise Administrator's Guide.

Parameters:

n - An int that contains the maximum number of minutes before processing a request is stopped.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxNumPrestartedChildrenUpdate

int getMaxNumPrestartedChildrenUpdate()
                                      throws SDKException

Deprecated. As of version 12.0.

Gets the number of report engines that can be preloaded and waiting for user requests.

Returns:

An int that contains the number of report engines.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMaxNumPrestartedChildrenUpdate

void setMaxNumPrestartedChildrenUpdate(int n)
                                       throws SDKException

Deprecated. As of version 12.0.

Sets the number of report engines that can be preloaded and waiting for user requests.

Parameters:

n - An int that contains the maximum number of report engines to be preloaded.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxLifetimeJobsPerChildUpdate

int getMaxLifetimeJobsPerChildUpdate()
                                     throws SDKException

Deprecated. As of version 12.0.

Gets the maximum number of actions performed by each report engine before it is closed.

Returns:

An int that contains the maximum number of actions that each report engine can perform.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMaxLifetimeJobsPerChildUpdate

void setMaxLifetimeJobsPerChildUpdate(int n)
                                      throws SDKException

Deprecated. As of version 12.0.

Sets the maximum number of actions performed by each report engine before it is closed.

Parameters:

n - An int that contains the maximum number of actions that each report engine can perform.

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 behaviour will increase performance and scalability by reducing requests to the database.

Returns:

A boolean that indicates whether the cache server's behaviour is to share documents.

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 behaviour to share documents. 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 that indicates whether the cache server's behaviour is to share documents.

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 Page Server's current directory path.

Returns:

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

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 refresh always hits a database and false otherwise.

Returns:

A boolean that indicates whether the viewer refresh always hits a 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 that contains 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 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 maximum number of minutes before processing a request is stopped.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxNumPrestartedChildren

int getMaxNumPrestartedChildren()
                                throws SDKException

Deprecated. As of version 12.0.

Gets the number of report engines that can be preloaded and waiting for user requests.

Returns:

An int that contains the number of report engines that are preloaded.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxLifetimeJobsPerChild

int getMaxLifetimeJobsPerChild()
                               throws SDKException

Deprecated. As of version 12.0.

Gets the maximum number of actions performed by each report engine before it is closed.

Returns:

An int that contains the maximum number of actions that each report engine can perform.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isShareData

boolean isShareData()
                    throws SDKException

Deprecated. As of version 12.0.

Returns a boolean that indicates whether the cache server's default behaviour is to share documents.

Returns:

A boolean that indicates whether the cache server's 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 to the Desktop Intelligence Cache Server(s).

Returns:

An int that specifies the total number of current connections to 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 specifyies 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 threads that are currently being processed.

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

getObjectTypeName

java.lang.String getObjectTypeName()
                                   throws SDKException

Deprecated. As of version 12.0.

Returns the document type for the document.

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 cache dll name.

Returns:

A String that specifies the cache dll name.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFailedRequests

int getFailedRequests()
                      throws SDKException

Deprecated. As of version 12.0.

Returns the number of requests that have failed in the core.

Returns:

An int that specifies the number of failed requests.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxChildProcesses

int getMaxChildProcesses()
                         throws SDKException

Deprecated. As of version 12.0.

Return the maximum number of children that can exist at a given time.

Returns:

An int that specifies the maximum number of children that can exist.

Throws:

SDKException - This is thrown if the process is unsuccessful.