com.crystaldecisions.sdk.plugin.admin.fileserveradmin
Interface IFileServerAdmin

Deprecated. As of version 12.0.

public interface IFileServerAdmin

This interface provides the general metrics for the file servers and allows you to retrieve the collection of active files on the server. You can also set the server's maximum idle time and root directory. The server can be an Input server or an Output server.

Method Summary

void	commit() Deprecated. As of version 12.0. Commit the Job Server InfoObject to save any changes.
double	getAvailableDiskPercent() Deprecated. As of version 12.0.
double	getAvailableDiskSpace() Deprecated. As of version 12.0.
double	getBytesSent() Deprecated. As of version 12.0.
double	getBytesWritten() Deprecated. As of version 12.0.
int	getClientConnections() Deprecated. As of version 12.0.
double	getDiskSpaceLeft() Deprecated. As of version 12.0.
java.lang.String	getHostname() Deprecated. As of version 12.0.
IFRSAdminFile[]	getListActiveFiles() Deprecated. As of version 12.0.
int	getMaxIdleTime() Deprecated. As of version 12.0.
int	getMaxIdleTimeUpdate() Deprecated. As of version 12.0.
java.lang.String	getRootDirectory() Deprecated. As of version 12.0.
double	getTotalDiskSpace() Deprecated. As of version 12.0.
void	setMaxIdleTimeUpdate(int n) Deprecated. As of version 12.0.
void	setRootDirectory(java.lang.String s) Deprecated. As of version 12.0.

Method Detail

getRootDirectory

java.lang.String getRootDirectory()
                                  throws SDKException

Deprecated. As of version 12.0.

Returns the root directory of the File Repository Server.

Returns:

A String specifying the root directory of the FRS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setRootDirectory

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

Deprecated. As of version 12.0.

Sets the root directory of the File Repository Server.

Parameters:

s - A String specifying the root directory of the FRS.

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 for file resources before they are cleaned by the File Repository Server.

Returns:

An int specifying the maximum time in minutes for file resources before they are cleaned by the File Repository Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

commit

void commit()
            throws SDKException

Deprecated. As of version 12.0. Commit the Job Server InfoObject to save any changes.

Commits to the CMS any changes that are made to the file server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getHostname

java.lang.String getHostname()
                             throws SDKException

Deprecated. As of version 12.0.

Returns the name of the host machine that the File Repository Service is running on.

Returns:

A String containing the name of the host machine that the File Repository Service is running on.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getBytesWritten

double getBytesWritten()
                       throws SDKException

Deprecated. As of version 12.0.

Returns the number of bytes being written to the File Repository Server.

Returns:

A double specifying the number of bytes being written to the File Repository Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getBytesSent

double getBytesSent()
                    throws SDKException

Deprecated. As of version 12.0.

Returns the number of bytes being read from the File Repository Server.

Returns:

A double specifying the number of bytes being read from the File Repository Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getListActiveFiles

IFRSAdminFile[] getListActiveFiles()
                                   throws SDKException

Deprecated. As of version 12.0.

Returns the collection of active files on the File Repository Server.

Returns:

An array of IFRSAdminFile objects containing the active files on the FRS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getClientConnections

int getClientConnections()
                         throws SDKException

Deprecated. As of version 12.0.

Returns the number of active client connections to the File Repository Server.

Returns:

An int specifying the number of active client connections to the FRS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getAvailableDiskSpace

double getAvailableDiskSpace()
                             throws SDKException

Deprecated. As of version 12.0.

Returns the available disk space on the host machine in bytes.

Returns:

A double specifying the available disk space on the host machine in bytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDiskSpaceLeft

double getDiskSpaceLeft()
                        throws SDKException

Deprecated. As of version 12.0.

Returns the amount of disk space left on the host machine in bytes.

Returns:

A double specifying the amount of disk space left on the host machine in bytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getTotalDiskSpace

double getTotalDiskSpace()
                         throws SDKException

Deprecated. As of version 12.0.

Returns the total disk space of the host machine in bytes.

Returns:

A double specifying the total disk space of the host machine in bytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getAvailableDiskPercent

double getAvailableDiskPercent()
                               throws SDKException

Deprecated. As of version 12.0.

Returns the available disk space as a percentage of the host machines total disk space.

Returns:

A double specifying the available disk space as a percentage of the host machine's total disk space.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMaxIdleTimeUpdate

int getMaxIdleTimeUpdate()
                         throws SDKException

Deprecated. As of version 12.0.

Returns the maximum idle time allowed for file resources before they are cleaned by the File Repository Server.

Returns:

An int specifying the maximum idle time allowed for file resources before they are cleaned by the FRS.

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 idle time allowed for file resources before they are cleaned by the File Repository Server. This will take effect once the File Repository Server is restarted.

Parameters:

n - An int specifying the maximum idle time allowed for file resources before they are cleaned by the FRS.

Throws:

SDKException - This is thrown if the process is unsuccessful.