com.crystaldecisions.sdk.plugin.admin.wcsadmin
Interface IWCSAdmin

public interface IWCSAdmin

This interface has been deprecated as of BusinessObjects Enterprise XI.

The IWCSAdmin interface helps you monitor the efficiency of the WCS server by providing information on requests to the WCS, time taken by the WCS, and bytes sent by the WCS. You can also manage logging for the WCS and whether or not it uses NT single sign-on.

Method Summary

void	commit() Deprecated.
double	getAverageBytes() Deprecated.
double	getAverageRequestTime() Deprecated.
int	getCurrentRequests() Deprecated.
ILogFields	getLogFields() Deprecated.
java.lang.String	getLogPath() Deprecated.
double	getTotalBytes() Deprecated.
int	getTotalRequests() Deprecated.
double	getTotalTime() Deprecated.
boolean	isLoggingEnabled() Deprecated.
boolean	isSingleSignOn() Deprecated.
void	setLoggingEnabled(boolean loggingEnabled) Deprecated.
void	setLogPath(java.lang.String s) Deprecated.
void	setSingleSignOn(boolean singleSignOn) Deprecated.

Method Detail

isLoggingEnabled

public boolean isLoggingEnabled()
                         throws SDKException

Deprecated.

Returns whether the WCS server will create a log file.

Returns:

true if a log file will be created, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)
                       throws SDKException

Deprecated.

Sets whether the WCS server will create a log file.

Parameters:

loggingEnabled - true if a log file will be created, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLogPath

public java.lang.String getLogPath()
                            throws SDKException

Deprecated.

Returns the path for log files created by the WCS.

Returns:

A String containing the path for log files created by the WCS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setLogPath

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

Deprecated.

Sets the path for log files created by the WCS.

Parameters:

s - A String containing the path for log files created by the WCS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isSingleSignOn

public boolean isSingleSignOn()
                       throws SDKException

Deprecated.

Returns whether or not the WCS accepts NT single sign-on.

Returns:

true if the WCS accepts NT single sign-on, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSingleSignOn

public void setSingleSignOn(boolean singleSignOn)
                     throws SDKException

Deprecated.

Sets whether or not the WCS accepts NT single sign-on.

Parameters:

singleSignOn - true if the WCS accepts NT single sign-on, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getAverageBytes

public double getAverageBytes()
                       throws SDKException

Deprecated.

Returns the average number of bytes per request.

Returns:

A double specifying the average number of bytes per request.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getAverageRequestTime

public double getAverageRequestTime()
                             throws SDKException

Deprecated.

Returns the average time taken per request in seconds.

Returns:

A double specifying the average time taken per request (seconds).

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCurrentRequests

public int getCurrentRequests()
                       throws SDKException

Deprecated.

Returns the total number of current requests.

Returns:

An int specifying the total number of current requests.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getTotalBytes

public double getTotalBytes()
                     throws SDKException

Deprecated.

Returns the total number of bytes sent by the WCS.

Returns:

A double specifying the total number of bytes sent by the WCS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getTotalRequests

public int getTotalRequests()
                     throws SDKException

Deprecated.

Returns the total number of requests sent by the WCS.

Returns:

An int specifying the total number of requests sent by the WCS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getTotalTime

public double getTotalTime()
                    throws SDKException

Deprecated.

Returns the total time taken for all requests sent by the WCS in seconds.

Returns:

A double specifying the total time taken for all requests sent by the WCS (seconds).

Throws:

SDKException - This is thrown if the process is unsuccessful.

commit

public void commit()
            throws SDKException

Deprecated.

Commits to the CMS any changes that are made to the WCS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLogFields

public ILogFields getLogFields()
                        throws SDKException

Deprecated.

Returns the ILogFields collection.

Returns:

An ILogFields representing the LogFields collection.

Throws:

SDKException - This is thrown if the process is unsuccessful.