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


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()
           Commits to the CMS any changes that are made to the file server.
 double getAvailableDiskPercent()
           Returns the available disk space as a percentage of the host machines total disk space.
 double getAvailableDiskSpace()
           Returns the available disk space on the host machine in bytes.
 double getBytesSent()
           Returns the number of bytes being read from the File Repository Server.
 double getBytesWritten()
           Returns the number of bytes being written to the File Repository Server.
 int getClientConnections()
           Returns the number of active client connections to the File Repository Server.
 double getDiskSpaceLeft()
           Returns the amount of disk space left on the host machine in bytes.
 java.lang.String getHostname()
           Returns the name of the host machine that the File Repository Service is running on.
 IFRSAdminFile[] getListActiveFiles()
           Returns the collection of active files on the File Repository Server.
 int getMaxIdleTime()
           Returns the maximum time in minutes for file resources before they are cleaned by the File Repository Server.
 int getMaxIdleTimeUpdate()
           Returns the maximum idle time allowed for file resources before they are cleaned by the File Repository Server.
 java.lang.String getRootDirectory()
           Returns the root directory of the File Repository Server.
 double getTotalDiskSpace()
           Returns the total disk space of the host machine in bytes.
 void setMaxIdleTimeUpdate(int n)
           Sets the maximum idle time allowed for file resources before they are cleaned by the File Repository Server.
 void setRootDirectory(java.lang.String s)
           Sets the root directory of the File Repository Server.
 

Method Detail

getRootDirectory

public java.lang.String getRootDirectory()
                                  throws SDKException

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

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

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

public int getMaxIdleTime()
                   throws SDKException

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

public void commit()
            throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getHostname

public java.lang.String getHostname()
                             throws SDKException

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

public double getBytesWritten()
                       throws SDKException

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

public double getBytesSent()
                    throws SDKException

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

public IFRSAdminFile[] getListActiveFiles()
                                   throws SDKException

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

public int getClientConnections()
                         throws SDKException

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

public double getAvailableDiskSpace()
                             throws SDKException

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

public double getDiskSpaceLeft()
                        throws SDKException

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

public double getTotalDiskSpace()
                         throws SDKException

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

public double getAvailableDiskPercent()
                               throws SDKException

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

public int getMaxIdleTimeUpdate()
                         throws SDKException

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

public void setMaxIdleTimeUpdate(int n)
                          throws SDKException

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.