Package wt.fv

Interface FvService

All Known Implementing Classes:

StandardFvService

@RemoteInterface
public interface FvService

The FvService service presents an interface (accessible also in the client) to the functions provided in the server by the StandardFvService.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
FileFolder	addFolder(Vault vault, FileFolder folder)	Add a folder to a given vault.
FvHost	addHostToSite(Site site, FvHost host)	Adds the given host to the give site.
Vault	addVaultToSite(Site site, Vault vault)	Adds the given vault to the given site.
Vector	getAllRevaultableItems(Vault vault, Vector queryInfo, int pageSize)	Get all revaultable items from the given vault with streamId is at least "startingStreamId".
FvMount	mountFolder(FvHost host, FileFolder folder, String path)	Mounts a folder to a given host.
FvMount	mountFolder(FvHost host, FileFolder folder, String path, boolean local)	Deprecated. use mountFolder(FvHost, FileFolder, String) instead.
FvMount	mountFolderOnCluster(FvHost host, FileFolder folder, String path)	Mounts a folder to cluster configuration.
FvMount	mountFolderOnCluster(FvHost host, FileFolder folder, String path, boolean local)	Deprecated. use mountFolderOnCluster(FvHost, FileFolder, String) instead.
void	unmountFolder(FvHost host, FileFolder folder)	Unmount the specified folder from a given host.
void	updateMount(FvMount mnt, String newPath)	Update the mount path of a specifix mount.

Method Details

addFolder

FileFolder addFolder(Vault vault,
 FileFolder folder)
              throws WTException

Add a folder to a given vault. The specified folder's number will define an order in which the folder is going to be used in a vault.

Specifying a number that already exists for a given vault results in shifting vaults to make a room for a new one.

Specifying -1 results in adding a folder to the end of the list.

Supported API: true

Parameters:

vault -

folder -

Returns:

FileFolder

Throws:

WTException

mountFolder

FvMount mountFolder(FvHost host,
 FileFolder folder,
 String path)
             throws WTPropertyVetoException,
WTException

Mounts a folder to a given host.

Supported API: true

Parameters:

host -

folder -

path -

Returns:

FvMount

Throws:

WTPropertyVetoException

WTException

mountFolder

@Deprecated
FvMount mountFolder(FvHost host,
 FileFolder folder,
 String path,
 boolean local)
             throws WTPropertyVetoException,
WTException

Deprecated.

use mountFolder(FvHost, FileFolder, String) instead.

Mounts a folder to a given host. A folder can be mounted as local to no more than one host.

Supported API: true

Parameters:

host -

folder -

path -

local -

Returns:

FvMount

Throws:

WTPropertyVetoException

WTException

unmountFolder

void unmountFolder(FvHost host,
 FileFolder folder)
            throws WTException

Unmount the specified folder from a given host.

Supported API: true

Parameters:

host -

folder -

Throws:

WTException

updateMount

void updateMount(FvMount mnt,
 String newPath)
          throws WTException

Update the mount path of a specifix mount. To update the mount on a cluster the mount corresponding to the defaultHost needs to be passed in.

Supported API: true

Parameters:

host -

folder -

Throws:

WTException

addHostToSite

FvHost addHostToSite(Site site,
 FvHost host)
              throws WTException

Adds the given host to the give site.

Supported API: true

Parameters:

site -

host -

Returns:

FvHost

Throws:

WTException

addVaultToSite

Vault addVaultToSite(Site site,
 Vault vault)
              throws WTException

Adds the given vault to the given site.

Supported API: true

Parameters:

site -

vault -

Returns:

Vault

Throws:

WTException

getAllRevaultableItems

Vector getAllRevaultableItems(Vault vault,
 Vector queryInfo,
 int pageSize)
                       throws WTException,
WTPropertyVetoException

Get all revaultable items from the given vault with streamId is at least "startingStreamId". The "pageSize" is the maximum number of items to be sent to client per RMI request, which is configurable at client's side.

Supported API: true

Parameters:

vault -

queryInfo - The information about the query information passed and updated between client and server. The first entry is Long, representing only the Streamed objects whose streamId is at least this number for the content holder class as in the last element of the Vector.

pageSize -

Returns:

Vector

Throws:

WTException

WTPropertyVetoException

mountFolderOnCluster

FvMount mountFolderOnCluster(FvHost host,
 FileFolder folder,
 String path)
                      throws WTPropertyVetoException,
WTException

Mounts a folder to cluster configuration.

Supported API: true

Parameters:

host - - HostType must be Cluster or Default

folder -

path -

Returns:

FvMount

Throws:

WTPropertyVetoException

WTException

mountFolderOnCluster

@Deprecated
FvMount mountFolderOnCluster(FvHost host,
 FileFolder folder,
 String path,
 boolean local)
                      throws WTPropertyVetoException,
WTException

Deprecated.

use mountFolderOnCluster(FvHost, FileFolder, String) instead.

Mounts a folder to cluster configuration.

Supported API: true

Parameters:

host - - HostType must be Cluster or Default

folder -

path -

Returns:

FvMount

Throws:

WTPropertyVetoException

WTException