IFMEServerSession Class Reference

IFMEServerSession class. More...

#include <ifmeserversession.h>

List of all members.

Public Member Functions
virtual IFMEServerCustomFormat *	createCustomFormat ()=0
virtual IFMEServerCustomFormatVector *	createCustomFormatVector ()=0
virtual IFMEServerCustomTransformer *	createCustomTransformer ()=0
virtual IFMEServerCustomTransformerVector *	createCustomTransformerVector ()=0
virtual IFMEServerFileInfo *	createFileInfo ()=0
virtual IFMEServerFileInfoVector *	createFileInfoVector ()=0
virtual IFMEServerItemVector *	createItemVector ()=0
virtual IFMEServerLogFileInfo *	createLogFileInfo ()=0
virtual IFMEServerMountPoint *	createMountPoint ()=0
virtual IFMEServerMountPointVector *	createMountPointVector ()=0
virtual IFMEServerPropertyAccessor *	createPropertyAccessor ()=0
virtual IFMEServerPropertyVector *	createPropertyVector ()=0
virtual IFMEServerRepository *	createRepository ()=0
virtual IFMEServerRepositoryVector *	createRepositoryVector ()=0
virtual IFMEServerResource *	createResource ()=0
virtual IFMEServerResourceVector *	createResourceVector ()=0
virtual IFMEServerConnectionInfo *	createServerConnectionInfo (const IFMEServerString &url, const IFMEServerString &userID, const IFMEServerString &password)=0
virtual IFMEServerConnectionInfo *	createServerConnectionInfo (const IFMEServerString &url, const IFMEServerStringArray &directives)=0
virtual IFMEServerConnectionInfo *	createServerConnectionInfo (const IFMEServerString &host, FME_UInt16 port, const IFMEServerString &userID, const IFMEServerString &password)=0
virtual IFMEServerConnectionInfo *	createServerConnectionInfo (const IFMEServerString &host, FME_UInt16 port, const IFMEServerStringArray &directives)=0
virtual IFMEServerString *	createServerString ()=0
virtual IFMEServerStringArray *	createServerStringArray ()=0
virtual IFMEServerService *	createService ()=0
virtual IFMEServerService *	createService (const IFMEServerString &name, const IFMEServerString &displayName, const IFMEServerString &description, const IFMEServerString &urlPattern)=0
virtual IFMEServerServiceVector *	createServiceVector ()=0
virtual IFMEServerTemplate *	createTemplate ()=0
virtual IFMEServerTemplateVector *	createTemplateVector ()=0
virtual IFMEServerTransformationRequest *	createTransformationRequest (const IFMEServerString &subsectionName, const IFMEServerString &path)=0
virtual IFMEServerTransformationRequest *	createTransformationRequest (const IFMEServerString &subsectionName, const IFMEServerString &repositoryName, const IFMEServerString &workspaceName)=0
virtual IFMEServerTransformationRequest *	createTransformationRequest (const IFMEServerString &subsectionName, const IFMEServerString &repositoryName, const IFMEServerWorkspace &workspace)=0
virtual IFMEServerTransformationResult *	createTransformationResult (const IFMEServerString &fmeServerResponse)=0
virtual IFMEServerTransformationResult *	createTransformationResult ()=0
virtual IFMEServerWorkspace *	createWorkspace ()=0
virtual IFMEServerWorkspaceService *	createWorkspaceService ()=0
virtual IFMEServerWorkspaceServiceVector *	createWorkspaceServiceVector ()=0
virtual IFMEServerWorkspaceSummary *	createWorkspaceSummary ()=0
virtual IFMEServerWorkspaceSummaryVector *	createWorkspaceSummaryVector ()=0
virtual IFMEServerWorkspaceVector *	createWorkspaceVector ()=0
virtual void	destroyCustomFormat (IFMEServerCustomFormat *&customFormat)=0
virtual void	destroyCustomFormatVector (IFMEServerCustomFormatVector *&customFormatVector)=0
virtual void	destroyCustomTransformer (IFMEServerCustomTransformer *&customTransformer)=0
virtual void	destroyCustomTransformerVector (IFMEServerCustomTransformerVector *&customTransformerVector)=0
virtual void	destroyFileInfo (IFMEServerFileInfo *&fileInfo)=0
virtual void	destroyFileInfoVector (IFMEServerFileInfoVector *&fileInfos)=0
virtual void	destroyItemVector (IFMEServerItemVector *&itemVector)=0
virtual void	destroyLogFileInfo (IFMEServerLogFileInfo *&logFileInfo)=0
virtual void	destroyMountPoint (IFMEServerMountPoint *&mountPoint)=0
virtual void	destroyMountPointVector (IFMEServerMountPointVector *&mountPoints)=0
virtual void	destroyPropertyAccessor (IFMEServerPropertyAccessor *&propertyAccessor)=0
virtual void	destroyPropertyVector (IFMEServerPropertyVector *&propertyVector)=0
virtual void	destroyRepository (IFMEServerRepository *&repository)=0
virtual void	destroyRepositoryVector (IFMEServerRepositoryVector *&repositoryVector)=0
virtual void	destroyResource (IFMEServerResource *&resource)=0
virtual void	destroyResourceVector (IFMEServerResourceVector *&resourceVector)=0
virtual void	destroyServerConnectionInfo (IFMEServerConnectionInfo *&pServerConnectionInfo)=0
virtual void	destroyServerStatus (IFMEServerStatus *&serverStatus)=0
virtual void	destroyServerString (IFMEServerString *&serverString)=0
virtual void	destroyServerStringArray (IFMEServerStringArray *&serverStringArray)=0
virtual void	destroyService (IFMEServerService *&service)=0
virtual void	destroyServiceVector (IFMEServerServiceVector *&serviceVector)=0
virtual void	destroyTemplate (IFMEServerTemplate *&serverTemplate)=0
virtual void	destroyTemplateVector (IFMEServerTemplateVector *&templateVector)=0
virtual void	destroyTransformationRequest (IFMEServerTransformationRequest *&transformationRequest)=0
virtual void	destroyTransformationResult (IFMEServerTransformationResult *&transformationResult)=0
virtual void	destroyWorkspace (IFMEServerWorkspace *&workspace)=0
virtual void	destroyWorkspaceService (IFMEServerWorkspaceService *&workspaceService)=0
virtual void	destroyWorkspaceServiceVector (IFMEServerWorkspaceServiceVector *&workspaceServiceVector)=0
virtual void	destroyWorkspaceSummary (IFMEServerWorkspaceSummary *&workspaceSummary)=0
virtual void	destroyWorkspaceSummaryVector (IFMEServerWorkspaceSummaryVector *&workspaceSummaryVector)=0
virtual void	destroyWorkspaceVector (IFMEServerWorkspaceVector *&workspaceVector)=0
virtual IFMEServerStatus *	disconnect ()=0
virtual IFMEServerIdentity *	getIdentity ()=0
virtual IFMEServerMountPointManager *	getMountPointManager ()=0
virtual IFMEServerStatus *	getProperty (const IFMEServerString &propName, IFMEServerString &propValue)=0
virtual IFMEServerRepositoryManager *	getRepositoryManager ()=0
virtual IFMEServerSecurityManager *	getSecurityManager ()=0
virtual IFMEServerTransformationManager *	getTransformationManager ()=0
virtual IFMEServerStatus *	init (const IFMEServerConnectionInfo &connectionInfo, const IFMEServerStringArray *directives)=0
Protected Member Functions
	IFMEServerSession ()
virtual	~IFMEServerSession ()
Private Member Functions
	IFMEServerSession (const IFMEServerSession &other)
IFMEServerSession &	operator= (const IFMEServerSession &other)

---

Detailed Description

IFMEServerSession class.

Package Overview:

This defines the entry-point class used to provide access to the fundamental building blocks of FME Server clients to C++ users. It currently provides methods for client access and administration of the Queue Manager.

---

Constructor & Destructor Documentation

IFMEServerSession::IFMEServerSession

(

)

[inline, protected]

virtual IFMEServerSession::~IFMEServerSession

(

)

[inline, protected, virtual]

IFMEServerSession::IFMEServerSession

(

const IFMEServerSession &

other

)

[private]

---

Member Function Documentation

virtual IFMEServerCustomFormat* IFMEServerSession::createCustomFormat

(

)

[pure virtual]

Creates a new instance of IFMEServerCustomFormat. This object must be freed by invoking destroyCustomFormat.

virtual IFMEServerCustomFormatVector* IFMEServerSession::createCustomFormatVector

(

)

[pure virtual]

Creates a new instance of IFMEServerCustomFormatVector. This object must be freed by invoking destroyCustomFormatVector.

virtual IFMEServerCustomTransformer* IFMEServerSession::createCustomTransformer

(

)

[pure virtual]

Creates a new instance of IFMEServerCustomTransformer. This object must be freed by invoking destroyCustomTransformer.

virtual IFMEServerCustomTransformerVector* IFMEServerSession::createCustomTransformerVector

(

)

[pure virtual]

Creates a new instance of IFMEServerCustomTransformerVector. This object must be freed by invoking destroyCustomTransformerVector.

virtual IFMEServerFileInfo* IFMEServerSession::createFileInfo

(

)

[pure virtual]

BETA - Preview of the new createFileInfo method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Creates a new instance of IFMEServerFileInfo. This object must be freed by invoking destroyFileInfo.

virtual IFMEServerFileInfoVector* IFMEServerSession::createFileInfoVector

(

)

[pure virtual]

BETA - Preview of the new createFileInfoVector method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Creates a new instance of IFMEServerFileInfoVector. This object must be freed by invoking destroyFileInfoVector.

virtual IFMEServerItemVector* IFMEServerSession::createItemVector

(

)

[pure virtual]

Creates a new instance of IFMEServerItemVector. This object must be freed by invoking destroyItemVector.

virtual IFMEServerLogFileInfo* IFMEServerSession::createLogFileInfo

(

)

[pure virtual]

Creates a new instance of IFMEServerLogFileInfo. This object must be freed by invoking destroyLogFileInfo.

virtual IFMEServerMountPoint* IFMEServerSession::createMountPoint

(

)

[pure virtual]

BETA - Preview of the new createMountPoint method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Creates a new instance of IFMEServerMountPoint. This object must be freed by invoking destroyMountPoint.

virtual IFMEServerMountPointVector* IFMEServerSession::createMountPointVector

(

)

[pure virtual]

BETA - Preview of the new createMountPointVector method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Creates a new instance of IFMEServerMountPointVector. This object must be freed by invoking destroyMountPointVector.

virtual IFMEServerPropertyAccessor* IFMEServerSession::createPropertyAccessor

(

)

[pure virtual]

Creates a new instance of IFMEServerPropertyAccessor. This object must be freed by invoking destroyPropertyAccessor.

virtual IFMEServerPropertyVector* IFMEServerSession::createPropertyVector

(

)

[pure virtual]

Creates a new instance of IFMEServerPropertyVector. This object must be freed by invoking destroyWorkspaceServiceVector.

virtual IFMEServerRepository* IFMEServerSession::createRepository

(

)

[pure virtual]

Creates a new instance of IFMEServerRepository. This object must be freed by invoking destroyRepository.

virtual IFMEServerRepositoryVector* IFMEServerSession::createRepositoryVector

(

)

[pure virtual]

Creates a new instance of IFMEServerRepositoryVector. This object must be freed by invoking destroyRepositoryVector.

virtual IFMEServerResource* IFMEServerSession::createResource

(

)

[pure virtual]

Creates a new instance of IFMEServerResource. This object must be freed by invoking destroyResource.

virtual IFMEServerResourceVector* IFMEServerSession::createResourceVector

(

)

[pure virtual]

Creates a new instance of IFMEServerResourceVector. This object must be freed by invoking destroyResourceVector.

virtual IFMEServerConnectionInfo* IFMEServerSession::createServerConnectionInfo	(	const IFMEServerString &	url,
		const IFMEServerString &	userID,
		const IFMEServerString &	password
	)		[pure virtual]

Return an IFMEServerConnectionInfo of SOAP connection This object must be freed by invoking destroyServerConnectionInfo.

Parameters:

url	The URL link of the SOAP service
userID	The user ID used to authenticate.
password	The password used to authenticate`.

Returns:

A pointer to an IFMEServerConnectionInfo.

virtual IFMEServerConnectionInfo* IFMEServerSession::createServerConnectionInfo	(	const IFMEServerString &	url,
		const IFMEServerStringArray &	directives
	)		[pure virtual]

Return an IFMEServerConnectionInfo of SOAP connection This object must be freed by invoking destroyServerConnectionInfo.

If the SSO_AUTH_DATA directive keyword is specified, then single sign-on authentication will be performed. The value is expected to be a SPNEGO authentication token, as defined in RFC 4559.

Parameters:

url	The URL link of the SOAP service
directives	The authentication parameters.

Returns:

A pointer to an IFMEServerConnectionInfo.

virtual IFMEServerConnectionInfo* IFMEServerSession::createServerConnectionInfo	(	const IFMEServerString &	host,
		FME_UInt16	port,
		const IFMEServerString &	userID,
		const IFMEServerString &	password
	)		[pure virtual]

Return an IFMEServerConnectionInfo This object must be freed by invoking destroyServerConnectionInfo.

Parameters:

host	The host name of the server.
port	The port on which the server is running.
userID	The user ID used to authenticate.
password	The password used to authenticate`.

Returns:

A pointer to an IFMEServerConnectionInfo.

virtual IFMEServerConnectionInfo* IFMEServerSession::createServerConnectionInfo	(	const IFMEServerString &	host,
		FME_UInt16	port,
		const IFMEServerStringArray &	directives
	)		[pure virtual]

Return an IFMEServerConnectionInfo This object must be freed by invoking destroyServerConnectionInfo.

If the SSO_AUTH_DATA directive keyword is specified, then single sign-on authentication will be performed. The value is expected to be a SPNEGO authentication token, as defined in RFC 4559.

Parameters:

host	The host name of the server.
port	The port on which the server is running.
directives	The authentication parameters.

Returns:

A pointer to an IFMEServerConnectionInfo.

virtual IFMEServerString* IFMEServerSession::createServerString

(

)

[pure virtual]

Creates a new instance of IFMESETLString. This object must be freed by invoking destroySETLString.

virtual IFMEServerStringArray* IFMEServerSession::createServerStringArray

(

)

[pure virtual]

Creates a new instance of IFMESETLStringArray. This object must be freed by invoking destroySETLStringArray.

virtual IFMEServerService* IFMEServerSession::createService

(

)

[pure virtual]

Creates a new instance of IFMEServerService. The service is by default enabled but unnamed. Appropriate setters should be called on the service object. This object must be freed by invoking destroyService.

virtual IFMEServerService* IFMEServerSession::createService	(	const IFMEServerString &	name,
		const IFMEServerString &	displayName,
		const IFMEServerString &	description,
		const IFMEServerString &	urlPattern
	)		[pure virtual]

Creates a new instance of IFMEServerService. The service created is by default enabled. This object must be freed by invoking destroyService.

Parameters:

name	the unique name of the new service
displayName	the display name of the new service
description	the description of the new service
urlPattern	the locater pattern of the service

Returns:

a new IFMEServerService instance.

virtual IFMEServerServiceVector* IFMEServerSession::createServiceVector

(

)

[pure virtual]

Creates a new instance of IFMEServerServiceVector. This object must be freed by invoking destroyServiceVector.

virtual IFMEServerTemplate* IFMEServerSession::createTemplate

(

)

[pure virtual]

Creates a new instance of IFMEServerTemplate. This object must be freed by invoking destroyTemplate.

virtual IFMEServerTemplateVector* IFMEServerSession::createTemplateVector

(

)

[pure virtual]

Creates a new instance of IFMEServerTemplateVector. This object must be freed by invoking destroyTemplateVector.

virtual IFMEServerTransformationRequest* IFMEServerSession::createTransformationRequest	(	const IFMEServerString &	subsectionName,
		const IFMEServerString &	path
	)		[pure virtual]

Creates a new instance of IFMEServerTransformationRequest. No validation is performed on this method's parameters; thus, if the specified subsection name or path does not exist, this will not be discovered until the user attempts to run the transformation.

This object must be freed by invoking destroyTransformationRequest. For a request object configured in this way, getType() == FME_PATH.

Parameters:

subsectionName	The keyword or subsection for this request.
path	The path to a workspace of mapping file, as seen by the FME Server. This workspace does *not* reside in the repository. All FME Engines must be able to access the workspace file via the filepath as specified.

Returns:

a pointer to the new IFMEServerTransformationRequest instance.

virtual IFMEServerTransformationRequest* IFMEServerSession::createTransformationRequest	(	const IFMEServerString &	subsectionName,
		const IFMEServerString &	repositoryName,
		const IFMEServerString &	workspaceName
	)		[pure virtual]

Creates a new instance of IFMEServerTransformationRequest. No validation is performed on this method's parameters; thus, if the specified subsection name or path does not exist, this will not be discovered until the user attempts to run the transformation.

This object must be freed by invoking destroyTransformationRequest. For a request object configured in this way, getType() == FME_PATH.

Parameters:

subsectionName	The name of an FME Engine subsection to be used for this request.
repositoryName	The name of the repository in which the specified workspace resides.
workspaceName	The name, including the ".fmw" extension, of the workspace to be used. The name must not include a filepath. Examples: "roads.fmw", "reduceAllParcels.fmw". The workspace must reside in the specified repository.

Returns:

a new IFMEServerTransformationRequest instance or NULL if the workspace name does not end with ".fmw"

virtual IFMEServerTransformationRequest* IFMEServerSession::createTransformationRequest	(	const IFMEServerString &	subsectionName,
		const IFMEServerString &	repositoryName,
		const IFMEServerWorkspace &	workspace
	)		[pure virtual]

Creates a new instance of IFMEServerTransformationRequest. No validation is performed on this method's parameters; thus, if the specified subsection name or path does not exist, this will not be discovered until the user attempts to run the transformation.

This object must be freed by invoking destroyTransformationRequest. For a request object configured in this way, getType() == FME_PATH.

Parameters:

subsectionName	The keyword or subsection for this request.
repositoryName	The name of the repository in which the workspace object was retrieved from.
workspace	The workspace object from in the repository

virtual IFMEServerTransformationResult* IFMEServerSession::createTransformationResult

(

const IFMEServerString &

fmeServerResponse

)

[pure virtual]

Creates a new instance of IFMEServerTransformationResult and uses the created object to parse the given FME Server response string. This object must be freed by invoking destroyTransformationResult.

Parameters:

fmeServerResponse

A valid FME Server response string.

virtual IFMEServerTransformationResult* IFMEServerSession::createTransformationResult

(

)

[pure virtual]

Creates a new instance of IFMEServerTransformationResult. This object must be freed by invoking destroyTransformationResult.

virtual IFMEServerWorkspace* IFMEServerSession::createWorkspace

(

)

[pure virtual]

Creates a new instance of IFMEServerWorkspace. This object must be freed by invoking destroyWorkspace.

virtual IFMEServerWorkspaceService* IFMEServerSession::createWorkspaceService

(

)

[pure virtual]

Creates a new instance of IFMEServerWorkspaceService. This object must be freed by invoking destroyWorkspaceService.

virtual IFMEServerWorkspaceServiceVector* IFMEServerSession::createWorkspaceServiceVector

(

)

[pure virtual]

Creates a new instance of IFMEServerWorkspaceServiceVector. This object must be freed by invoking destroyWorkspaceServiceVector.

virtual IFMEServerWorkspaceSummary* IFMEServerSession::createWorkspaceSummary

(

)

[pure virtual]

Creates a new instance of IFMEServerWorkspaceSummary. This object must be freed by invoking destroyWorkspaceSummary.

virtual IFMEServerWorkspaceSummaryVector* IFMEServerSession::createWorkspaceSummaryVector

(

)

[pure virtual]

Creates a new instance of IFMEServerWorkspaceSummaryVector. This object must be freed by invoking destroyWorkspaceSummaryVector.

virtual IFMEServerWorkspaceVector* IFMEServerSession::createWorkspaceVector

(

)

[pure virtual]

Creates a new instance of IFMEServerWorkspaceVector. This object must be freed by invoking destroyWorkspaceVector.

virtual void IFMEServerSession::destroyCustomFormat

(

IFMEServerCustomFormat *&

customFormat

)

[pure virtual]

Frees the memory allocated for IFMEServerCustomFormat.

virtual void IFMEServerSession::destroyCustomFormatVector

(

IFMEServerCustomFormatVector *&

customFormatVector

)

[pure virtual]

Frees the memory allocated for IFMEServerCustomFormatVector.

virtual void IFMEServerSession::destroyCustomTransformer

(

IFMEServerCustomTransformer *&

customTransformer

)

[pure virtual]

Frees the memory allocated for IFMEServerCustomTransformer.

virtual void IFMEServerSession::destroyCustomTransformerVector

(

IFMEServerCustomTransformerVector *&

customTransformerVector

)

[pure virtual]

Frees the memory allocated for IFMEServerCustomTransformerVector.

virtual void IFMEServerSession::destroyFileInfo

(

IFMEServerFileInfo *&

fileInfo

)

[pure virtual]

BETA - Preview of the new destroyFileInfo method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Frees the memory allocated for IFMEServerFileInfo.

virtual void IFMEServerSession::destroyFileInfoVector

(

IFMEServerFileInfoVector *&

fileInfos

)

[pure virtual]

BETA - Preview of the new destroyFileInfoVector method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Frees the memory allocated for IFMEServerFileInfoVector.

virtual void IFMEServerSession::destroyItemVector

(

IFMEServerItemVector *&

itemVector

)

[pure virtual]

Frees the memory allocated for IFMEServerItemVector.

virtual void IFMEServerSession::destroyLogFileInfo

(

IFMEServerLogFileInfo *&

logFileInfo

)

[pure virtual]

Frees the memory allocated for IFMEServerService.

virtual void IFMEServerSession::destroyMountPoint

(

IFMEServerMountPoint *&

mountPoint

)

[pure virtual]

BETA - Preview of the new destroyMountPoint method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Frees the memory allocated for IFMEServerMountPoint.

virtual void IFMEServerSession::destroyMountPointVector

(

IFMEServerMountPointVector *&

mountPoints

)

[pure virtual]

BETA - Preview of the new destroyMountPointVector method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Frees the memory allocated for IFMEServerMountPointVector.

virtual void IFMEServerSession::destroyPropertyAccessor

(

IFMEServerPropertyAccessor *&

propertyAccessor

)

[pure virtual]

Frees the memory allocated for IFMEServerPropertyAccessor.

virtual void IFMEServerSession::destroyPropertyVector

(

IFMEServerPropertyVector *&

propertyVector

)

[pure virtual]

Frees the memory allocated for IFMEServerPropertyVector.

virtual void IFMEServerSession::destroyRepository

(

IFMEServerRepository *&

repository

)

[pure virtual]

Frees the memory allocated for IFMEServerRepository.

virtual void IFMEServerSession::destroyRepositoryVector

(

IFMEServerRepositoryVector *&

repositoryVector

)

[pure virtual]

Frees the memory allocated for IFMEServerRepositoryVector.

virtual void IFMEServerSession::destroyResource

(

IFMEServerResource *&

resource

)

[pure virtual]

Frees the memory allocated for IFMEServerResource.

virtual void IFMEServerSession::destroyResourceVector

(

IFMEServerResourceVector *&

resourceVector

)

[pure virtual]

Frees the memory allocated for IFMEServerResourceVector.

virtual void IFMEServerSession::destroyServerConnectionInfo

(

IFMEServerConnectionInfo *&

pServerConnectionInfo

)

[pure virtual]

Frees the memory allocated for IFMEServerConnectionInfo.

virtual void IFMEServerSession::destroyServerStatus

(

IFMEServerStatus *&

serverStatus

)

[pure virtual]

Frees the memory allocated for IFMEServerStatus.

virtual void IFMEServerSession::destroyServerString

(

IFMEServerString *&

serverString

)

[pure virtual]

Frees the memory allocated for IFMESETLString.

virtual void IFMEServerSession::destroyServerStringArray

(

IFMEServerStringArray *&

serverStringArray

)

[pure virtual]

Frees the memory allocated for IFMESETLStringArray.

virtual void IFMEServerSession::destroyService

(

IFMEServerService *&

service

)

[pure virtual]

Frees the memory allocated for IFMEServerService.

virtual void IFMEServerSession::destroyServiceVector

(

IFMEServerServiceVector *&

serviceVector

)

[pure virtual]

Frees the memory allocated for IFMEServerServiceVector.

virtual void IFMEServerSession::destroyTemplate

(

IFMEServerTemplate *&

serverTemplate

)

[pure virtual]

Frees the memory allocated for IFMEServerTemplate.

virtual void IFMEServerSession::destroyTemplateVector

(

IFMEServerTemplateVector *&

templateVector

)

[pure virtual]

Frees the memory allocated for IFMEServerTemplateVector.

virtual void IFMEServerSession::destroyTransformationRequest

(

IFMEServerTransformationRequest *&

transformationRequest

)

[pure virtual]

Frees the memory allocated for IFMEServerTransformationRequest.

virtual void IFMEServerSession::destroyTransformationResult

(

IFMEServerTransformationResult *&

transformationResult

)

[pure virtual]

Frees the memory allocated for IFMEServerTransformationResult.

virtual void IFMEServerSession::destroyWorkspace

(

IFMEServerWorkspace *&

workspace

)

[pure virtual]

Frees the memory allocated for IFMEServerWorkspace.

virtual void IFMEServerSession::destroyWorkspaceService

(

IFMEServerWorkspaceService *&

workspaceService

)

[pure virtual]

Frees the memory allocated for IFMEServerWorkspaceService.

virtual void IFMEServerSession::destroyWorkspaceServiceVector

(

IFMEServerWorkspaceServiceVector *&

workspaceServiceVector

)

[pure virtual]

Frees the memory allocated for IFMEServerWorkspaceServiceVector.

virtual void IFMEServerSession::destroyWorkspaceSummary

(

IFMEServerWorkspaceSummary *&

workspaceSummary

)

[pure virtual]

Frees the memory allocated for IFMEServerWorkspaceSummary.

virtual void IFMEServerSession::destroyWorkspaceSummaryVector

(

IFMEServerWorkspaceSummaryVector *&

workspaceSummaryVector

)

[pure virtual]

Frees the memory allocated for IFMEServerWorkspaceSummaryVector.

virtual void IFMEServerSession::destroyWorkspaceVector

(

IFMEServerWorkspaceVector *&

workspaceVector

)

[pure virtual]

Frees the memory allocated for IFMEServerWorkspaceVector.

virtual IFMEServerStatus* IFMEServerSession::disconnect

(

)

[pure virtual]

Disconnects the session with the FME Server. This should be called when a server session is no longer need to free up resources.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerIdentity* IFMEServerSession::getIdentity

(

)

[pure virtual]

Gets the user identity.

If single sign-on authentication is done via init(), then the identity returned is also an IFMEServerSingleSignOnIdentity.

NULL may be returned if, for example, init() has not been called.

Returns:

The user identity.

virtual IFMEServerMountPointManager* IFMEServerSession::getMountPointManager

(

)

[pure virtual]

BETA - Preview of the new getMountPointManager method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Gets the mount point manager

Returns:

A pointer to the mount point manager instance, otherwise null.

virtual IFMEServerStatus* IFMEServerSession::getProperty	(	const IFMEServerString &	propName,
		IFMEServerString &	propValue
	)		[pure virtual]

Gets the specified property for the current session.

Parameters:

propName

the name of the property to get.

If SESSION_PROP_ISALIVE property name is specified, then propValue will be "true" if session is alive, otherwise "false" or an error will occur.

If SESSION_PROP_SERVERBUILDVERSION property name is specified, then propValue will be the build string of the connected FME Server.

If SESSION_PROP_SERVERLOCALE property name is specified, then propValue will be the locale string of the connected FME Server.

Parameters:

propValue

the property value for the session.

Returns:

IFMEServerStatus pointer if the property does not exist or error occurred.

virtual IFMEServerRepositoryManager* IFMEServerSession::getRepositoryManager

(

)

[pure virtual]

Gets the repository manager

Returns:

A pointer to the repository manager instance, otherwise null.

virtual IFMEServerSecurityManager* IFMEServerSession::getSecurityManager

(

)

[pure virtual]

Gets the security manager

Returns:

A pointer to the security manager instance, otherwise null.

virtual IFMEServerTransformationManager* IFMEServerSession::getTransformationManager

(

)

[pure virtual]

Gets the transformation manager

Returns:

A pointer to the transformation manager instance, otherwise null.

virtual IFMEServerStatus* IFMEServerSession::init	(	const IFMEServerConnectionInfo &	connectionInfo,
		const IFMEServerStringArray *	directives
	)		[pure virtual]

Initializes the FME Server session. This method must always be called first.

The directives are reserved for future use. Until they are used, just pass in NULL.

IFMEServerSession& IFMEServerSession::operator=

(

const IFMEServerSession &

other

)

[private]

---

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

• ifmeserversession.h