IFMEServerMountPoint interface. More...

#include <ifmeservermountpoint.h>

Public Member Functions
virtual IFMEServerStatus *	copy (const IFMEServerPath &src, const IFMEServerPath &dest) const =0
virtual IFMEServerPath *	createPath (const IFMEServerString &dirpath, const IFMEServerString &name) const =0
virtual IFMEServerPath *	createPath (const IFMEServerString &path) const =0
virtual void	destroyPath (IFMEServerPath *&path) const =0
virtual IFMEServerStatus *	download (const IFMEServerPath &src, const IFMEServerString &dest, FME_Boolean &exists, IFMEServerTransferCallback *callback) const =0
virtual IFMEServerStatus *	exists (const IFMEServerPath &path, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	get (const IFMEServerPath &path, IFMEServerFileInfo &fileInfo, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	get (const IFMEServerPath &path, const IFMEServerStringArray *directives, IFMEServerFileInfo &fileInfo, FME_Boolean &exists) const =0
virtual void	getDescription (IFMEServerString &description) const =0
virtual void	getDisplayName (IFMEServerString &displayName) const =0
virtual void	getName (IFMEServerString &name) const =0
virtual IFMEServerPropertyAccessor *	getPropertyAccessor () const =0
virtual IFMEServerStatus *	list (const IFMEServerPath &path, IFMEServerFileInfoVector &fileInfos) const =0
virtual IFMEServerStatus *	list (const IFMEServerPath &path, const IFMEServerStringArray *directives, IFMEServerFileInfoVector &fileInfos) const =0
virtual IFMEServerStatus *	make (const IFMEServerPath &path) const =0
virtual IFMEServerStatus *	move (const IFMEServerPath &src, const IFMEServerPath &dest) const =0
virtual IFMEServerStatus *	remove (const IFMEServerPath &path, FME_Boolean &removed) const =0
virtual IFMEServerStatus *	upload (const IFMEServerString &src, const IFMEServerPath &path, IFMEServerTransferCallback *callback) const =0
Protected Member Functions
	IFMEServerMountPoint ()
virtual	~IFMEServerMountPoint ()
Private Member Functions
	IFMEServerMountPoint (const IFMEServerMountPoint &other)
IFMEServerMountPoint &	operator= (const IFMEServerMountPoint &other)

Detailed Description

IFMEServerMountPoint interface.

Package Overview:

This file defines the interface that subclasses of this class MUST follow.

Developers MUST NOT implement their own subclasses of this, instead, the FME will ALWAYS provide them with the subclass instance they should be using.

Constructor & Destructor Documentation

IFMEServerMountPoint::IFMEServerMountPoint ( ) [inline, protected]

virtual IFMEServerMountPoint::~IFMEServerMountPoint ( ) [inline, protected, virtual]

IFMEServerMountPoint::IFMEServerMountPoint ( const IFMEServerMountPoint & other ) [private]

Member Function Documentation

virtual IFMEServerStatus* IFMEServerMountPoint::copy	(	const IFMEServerPath &	src,
		const IFMEServerPath &	dest
	)		const `[pure virtual]`

Copies from source to destination on server mount point.

Parameters:

src	the server mount point source file or directory path.
dest	the server mount point destination file or directory path.

Returns:: IFMEServerStatus* if an FME Server exception occurred.

virtual IFMEServerPath* IFMEServerMountPoint::createPath	(	const IFMEServerString &	dirpath,
		const IFMEServerString &	name
	)		const `[pure virtual]`

Creates a path. This object must be freed by invoking destroyPath.

Parameters:

dirpath	the server mount point directory path. i.e., /path/to.
name	the file name.

Returns:: the file path object, otherwise NULL.

virtual IFMEServerPath* IFMEServerMountPoint::createPath ( const IFMEServerString & path ) const [pure virtual]

Creates a path. This object must be freed by invoking destroyPath.

Parameters:

path	the full server mount point path. i.e., /path/to/dir or /path/to/file.

Returns:: the directory path object, otherwise NULL.

virtual void IFMEServerMountPoint::destroyPath ( IFMEServerPath *& path ) const [pure virtual]

Frees the memory allocated for IFMEServerPath.

virtual IFMEServerStatus* IFMEServerMountPoint::download	(	const IFMEServerPath &	src,
		const IFMEServerString &	dest,
		FME_Boolean &	exists,
		IFMEServerTransferCallback *	callback
	)		const `[pure virtual]`

Downloads from the server mount point.

Parameters:

src	the server mount point source file or directory path.
dest	the local destination file or directory.
exists	returns FME_TRUE if the file or directory exists, otherwise FME_FALSE.
callback	a callback function to update transfer progress.

Returns:: IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerMountPoint::exists	(	const IFMEServerPath &	path,
		FME_Boolean &	exists
	)		const `[pure virtual]`

Checks if the path exists.

Parameters:

path	the server mount point file or directory path.
exists	returns FME_TRUE if the file or directory exists, otherwise FME_FALSE.

Returns:: IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerMountPoint::get	(	const IFMEServerPath &	path,
		IFMEServerFileInfo &	fileInfo,
		FME_Boolean &	exists
	)		const `[pure virtual]`

Gets file info for the specified path.

Parameters:

path	the server mount point file or directory path.
fileInfo	the returned file info object with all file metadata.
exists	returns FME_TRUE if the file or directory exists, otherwise FME_FALSE.

Returns:: IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerMountPoint::get	(	const IFMEServerPath &	path,
		const IFMEServerStringArray *	directives,
		IFMEServerFileInfo &	fileInfo,
		FME_Boolean &	exists
	)		const `[pure virtual]`

Gets file info for the specified path.

Parameters:

path	the server mount point file or directory path.
directives	NULL to retrieve all file info metadata.
fileInfo	the returned file info object.
exists	returns FME_TRUE if the file or directory exists, otherwise FME_FALSE.

Returns:: IFMEServerStatus if an FME Server exception occurred.

virtual void IFMEServerMountPoint::getDescription ( IFMEServerString & description ) const [pure virtual]

Gets the description of the mount point.

Parameters:

description the returned mount point description.

virtual void IFMEServerMountPoint::getDisplayName ( IFMEServerString & displayName ) const [pure virtual]

Gets the display name of the mount point.

Parameters:

displayName the returned mount point display name.

virtual void IFMEServerMountPoint::getName ( IFMEServerString & name ) const [pure virtual]

Gets the name of the mount point.

Parameters:

name	the returned mount point name.

virtual IFMEServerPropertyAccessor* IFMEServerMountPoint::getPropertyAccessor ( ) const [pure virtual]

Gets the property accessor for mount point properties.

Returns:: the property accessor

virtual IFMEServerStatus* IFMEServerMountPoint::list	(	const IFMEServerPath &	path,
		IFMEServerFileInfoVector &	fileInfos
	)		const `[pure virtual]`

Lists the file infos for the specified path.

Parameters:

path	the server mount point directory path.
fileInfos	the returned list of all file infos with all file metadata, otherwise empty.

Returns:: IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerMountPoint::list	(	const IFMEServerPath &	path,
		const IFMEServerStringArray *	directives,
		IFMEServerFileInfoVector &	fileInfos
	)		const `[pure virtual]`

Lists the file infos for the specified path.

Parameters:

path the server mount point directory path.

directives

NULL to retrieve all file objects. Keyword FILETYPE_FILTER:

if FILE then return only files.
if DIR then return only directories.

fileInfos the returned list of file infos, otherwise empty.

Returns:: IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerMountPoint::make ( const IFMEServerPath & path ) const [pure virtual]

Makes a directory at the specified server mount point path.

Parameters:

path	the server mount point directory path to create the directory.

Returns:: IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerMountPoint::move	(	const IFMEServerPath &	src,
		const IFMEServerPath &	dest
	)		const `[pure virtual]`

Moves from source to destination on server mount point.

Parameters:

src	the server mount point source file or directory path.
dest	the server mount point destination file or directory path.

Returns:: IFMEServerStatus* if an FME Server exception occurred.

IFMEServerMountPoint& IFMEServerMountPoint::operator= ( const IFMEServerMountPoint & other ) [private]

virtual IFMEServerStatus* IFMEServerMountPoint::remove	(	const IFMEServerPath &	path,
		FME_Boolean &	removed
	)		const `[pure virtual]`

Deletes at the specified server mount point path.

Parameters:

path	the server mount point file or directory path to delete.
removed	returns FME_TRUE if the file or directory existed and was removed, other FME_FALSE.

Returns:: IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerMountPoint::upload	(	const IFMEServerString &	src,
		const IFMEServerPath &	path,
		IFMEServerTransferCallback *	callback
	)		const `[pure virtual]`

Uploads to the server mount point.

Parameters:

src	the local source file or directory.
dest	the server mount point destination file or directory path.
callback	a callback function to update transfer progress.

Returns:: IFMEServerStatus if an FME Server exception occurred.

The documentation for this class was generated from the following file:

ifmeservermountpoint.h

IFMEServerMountPoint Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation