wt.fv
Class FvServiceFwd

java.lang.Object
  wt.fv.FvServiceFwd

All Implemented Interfaces:

FvService, RemoteAccess, Serializable

public class FvServiceFwd

extends Object

implements RemoteAccess, FvService, Serializable

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

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	FC_RESOURCE
(package private) static boolean	SERVER

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

FvServiceFwd()

Method Summary

FvFolder	addFolder(FvVault vault, FvFolder folder) Add a folder to a given vault.
FvHost	addHostToSite(Site site, FvHost host) Adds the given host to the give site.
FvPolicyRule	addPolicyRule(FvPolicyRule rule) Adds a policy rule.
Vault	addVaultToSite(Site site, Vault vault) Adds the given vault to the given site.
DeletedFilesStatistics	cleanUpFolder(FvFolder folder) Clean up a folder by removing unreferenced files from it.
DeletedFilesStatistics	cleanUpFolders(FvVault vault) Clean up all the folders from the given FvVault.
void	dumpBackupInfo() Supported API: false
Vector	getAllFolders(Site site, Vault vault) Gets all the folders for a given site and FvVault Supported API: false
Enumeration	getAllHosts(Site site) For the given Site, returns all the hosts in the system as an Enumaration of FvHost objects.
FvPolicyRule[]	getAllPolicyRules(String domainName) Returns all of the policy rules Supported API: false
Vector	getAllRevaultableItems(Vault vault, Vector queryInfo, int pageSize) Get all revaultable items from the given vault with streamId is at least "startingStreamId".
String[]	getFileLists(FvMount mount) Get the list of all files in the directory as identified by the "mount" Supported API: false
Enumeration	getLocalFolders(Site site, Vault vault) Returns all the FvFolders given a site and a vault.
Vector	getLocalVaults(Site site) Gets all the FvVaults for the given site object Supported API: false
private static Manager	getManager()
FvPolicyItem	getPolicyItem(Selector sel) Supported API: false
FvPolicyItem[]	getPolicyItems() Returns all of the policy items.
FvPolicyRule	getPolicyRule(Selector sel) Returns a policy rule for a given selector.
Vector	getSiteMounts(Site site) Gets all the FvMounts for a given site.
FvMount	mountFolder(FvHost host, FileFolder folder, String path, boolean local) Mounts a folder to a given host.
FvFolder	moveFolder(FvFolder folder, FvVault newVault) Moves a folder to another vault.
void	revault(FvVault vault) This method synchronizes the given vault with the vaulting rules which are in place.
void	unmountFolder(FvHost host, FileFolder folder) Unmount the specified folder from a given host.
void	updateFolderSeqNumbers(Vault vault, Vector folders) This function is used to reorder the sequence numbers within a vault.
int	validateRelatedFvMounts(FileFolder folder, boolean disabled, boolean ronly) Validate the mounts for the given folder.
int	validateRelatedFvMounts(FvHost host, boolean disabled, boolean ronly) Validate the mounts for the given host.
int	validateRelatedFvMounts(FvMount mount, boolean disabled, boolean ronly) Validate the given mount Supported API: false
int	validateRelatedFvMounts(Vault vault, boolean disabled, boolean ronly) Validate the mounts for the given vault Supported API: false
int	validateRelMounts(Vector target, boolean disabled, boolean ronly) Supported API: false

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Constructor Detail

FvServiceFwd

public FvServiceFwd()

Method Detail

getManager

private static Manager getManager()
                           throws WTException

Returns:

Manager

Throws:

WTException

addFolder

public FvFolder addFolder(FvVault vault,
                          FvFolder 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: false

Specified by:

addFolder in interface FvService

Parameters:

vault -

folder -

Returns:

FvFolder

Throws:

WTException

mountFolder

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

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

Supported API: false

Specified by:

mountFolder in interface FvService

Parameters:

host -

folder -

path -

local -

Returns:

FvMount

Throws:

WTPropertyVetoException

WTException

unmountFolder

public void unmountFolder(FvHost host,
                          FileFolder folder)
                   throws WTException

Unmount the specified folder from a given host.

Supported API: false

Specified by:

unmountFolder in interface FvService

Parameters:

host -

folder -

Throws:

WTException

cleanUpFolder

public DeletedFilesStatistics cleanUpFolder(FvFolder folder)
                                     throws WTException

Clean up a folder by removing unreferenced files from it.

Supported API: false

Specified by:

cleanUpFolder in interface FvService

Parameters:

folder -

Returns:

DeletedFilesStatistics

Throws:

WTException

cleanUpFolders

public DeletedFilesStatistics cleanUpFolders(FvVault vault)
                                      throws WTException

Clean up all the folders from the given FvVault. This method will fail if all folders in the vault are not mounted.

Supported API: false

Specified by:

cleanUpFolders in interface FvService

Parameters:

vault -

Returns:

DeletedFilesStatistics

Throws:

WTException

addPolicyRule

public FvPolicyRule addPolicyRule(FvPolicyRule rule)
                           throws WTException

Adds a policy rule. A policy rule will not be added if a different policy rule exists for a given selector.

Supported API: false

Specified by:

addPolicyRule in interface FvService

Parameters:

rule -

Returns:

FvPolicyRule

Throws:

WTException

getPolicyRule

public FvPolicyRule getPolicyRule(Selector sel)
                           throws WTException

Returns a policy rule for a given selector.

Supported API: false

Specified by:

getPolicyRule in interface FvService

Parameters:

sel -

Returns:

FvPolicyRule

Throws:

WTException

getAllPolicyRules

public FvPolicyRule[] getAllPolicyRules(String domainName)
                                 throws WTException

Returns all of the policy rules

Supported API: false

Specified by:

getAllPolicyRules in interface FvService

Parameters:

domainName -

Returns:

FvPolicyRule[]

Throws:

WTException

getPolicyItem

public FvPolicyItem getPolicyItem(Selector sel)
                           throws WTException

Supported API: false

Specified by:

getPolicyItem in interface FvService

Parameters:

sel -

Returns:

FvPolicyItem

Throws:

WTException

getPolicyItems

public FvPolicyItem[] getPolicyItems()
                              throws WTException

Returns all of the policy items.

Supported API: false

Specified by:

getPolicyItems in interface FvService

Returns:

FvPolicyItem[]

Throws:

WTException

moveFolder

public FvFolder moveFolder(FvFolder folder,
                           FvVault newVault)
                    throws WTException,
                           WTPropertyVetoException

Moves a folder to another vault.

Supported API: false

Specified by:

moveFolder in interface FvService

Parameters:

folder - the folder to be moved.

newVault - the vault that the folder is to be moved to.

Returns:

FvFolder

Throws:

WTException

WTPropertyVetoException

updateFolderSeqNumbers

public void updateFolderSeqNumbers(Vault vault,
                                   Vector folders)
                            throws WTException,
                                   WTPropertyVetoException

This function is used to reorder the sequence numbers within a vault.

Supported API: false

Specified by:

updateFolderSeqNumbers in interface FvService

Parameters:

vault - The vault whose folder sequence numbers are to be updated.

folders - the vector of FvFolders with the desired sequence number attributes.

Throws:

WTException

WTPropertyVetoException

dumpBackupInfo

public void dumpBackupInfo()
                    throws WTException

Supported API: false

Specified by:

dumpBackupInfo in interface FvService

Throws:

WTException

revault

public void revault(FvVault vault)
             throws WTException

This method synchronizes the given vault with the vaulting rules which are in place. This is typically a scheduled occurrence although it can be forced by scheduling the method as immediate/once.

Supported API: false

Specified by:

revault in interface FvService

Parameters:

vault -

Throws:

WTException

validateRelatedFvMounts

public int validateRelatedFvMounts(Vault vault,
                                   boolean disabled,
                                   boolean ronly)
                            throws WTException

Validate the mounts for the given vault

Supported API: false

Specified by:

validateRelatedFvMounts in interface FvService

Parameters:

vault -

disabled -

ronly -

Returns:

int

Throws:

WTException

validateRelatedFvMounts

public int validateRelatedFvMounts(FileFolder folder,
                                   boolean disabled,
                                   boolean ronly)
                            throws WTException

Validate the mounts for the given folder.

Supported API: false

Specified by:

validateRelatedFvMounts in interface FvService

Parameters:

folder -

disabled -

ronly -

Returns:

int

Throws:

WTException

validateRelatedFvMounts

public int validateRelatedFvMounts(FvHost host,
                                   boolean disabled,
                                   boolean ronly)
                            throws WTException

Validate the mounts for the given host.

Supported API: false

Specified by:

validateRelatedFvMounts in interface FvService

Parameters:

host -

disabled -

ronly -

Returns:

int

Throws:

WTException

validateRelatedFvMounts

public int validateRelatedFvMounts(FvMount mount,
                                   boolean disabled,
                                   boolean ronly)
                            throws WTException

Validate the given mount

Supported API: false

Specified by:

validateRelatedFvMounts in interface FvService

Parameters:

mount -

disabled -

ronly -

Returns:

int

Throws:

WTException

validateRelMounts

public int validateRelMounts(Vector target,
                             boolean disabled,
                             boolean ronly)
                      throws WTException

Supported API: false

Specified by:

validateRelMounts in interface FvService

Parameters:

target -

disabled -

ronly -

Returns:

int

Throws:

WTException

getAllHosts

public Enumeration getAllHosts(Site site)
                        throws WTException

For the given Site, returns all the hosts in the system as an Enumaration of FvHost objects.

Supported API: false

Specified by:

getAllHosts in interface FvService

Parameters:

site -

Returns:

Enumeration

Throws:

WTException

getLocalVaults

public Vector getLocalVaults(Site site)
                      throws WTException

Gets all the FvVaults for the given site object

Supported API: false

Specified by:

getLocalVaults in interface FvService

Parameters:

site - : Site the site object to find the FvVautls from

Returns:

Vector

Throws:

WTException

getAllFolders

public Vector getAllFolders(Site site,
                            Vault vault)
                     throws WTException

Gets all the folders for a given site and FvVault

Supported API: false

Specified by:

getAllFolders in interface FvService

Parameters:

site -

vault -

Returns:

Vector

Throws:

WTException

addHostToSite

public FvHost addHostToSite(Site site,
                            FvHost host)
                     throws WTException

Adds the given host to the give site.

Supported API: false

Specified by:

addHostToSite in interface FvService

Parameters:

site -

host -

Returns:

FvHost

Throws:

WTException

addVaultToSite

public Vault addVaultToSite(Site site,
                            Vault vault)
                     throws WTException

Adds the given vault to the given site.

Supported API: false

Specified by:

addVaultToSite in interface FvService

Parameters:

site -

vault -

Returns:

Vault

Throws:

WTException

getLocalFolders

public Enumeration getLocalFolders(Site site,
                                   Vault vault)
                            throws WTException

Returns all the FvFolders given a site and a vault. If vault is null, all FvFolders for the given site are returned.

Supported API: false

Specified by:

getLocalFolders in interface FvService

Parameters:

site -

vault -

Returns:

Enumeration

Throws:

WTException

getSiteMounts

public Vector getSiteMounts(Site site)
                     throws WTException

Gets all the FvMounts for a given site.

Supported API: false

Specified by:

getSiteMounts in interface FvService

Returns:

Vector of FvMounts belonging to the given site.

Throws:

WTException

getAllRevaultableItems

public 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: false

Specified by:

getAllRevaultableItems in interface FvService

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

getFileLists

public String[] getFileLists(FvMount mount)
                      throws WTException

Get the list of all files in the directory as identified by the "mount"

Supported API: false

Specified by:

getFileLists in interface FvService

Parameters:

mount -

Returns:

String[]

Throws:

WTException