IFMEServerRepositoryManager Class Reference

IFMEServerRepositoryManager interface. More...

#include <ifmeserverrepositorymanager.h>

List of all members.

Public Member Functions
virtual IFMEServerStatus *	addRepository (const IFMEServerString &repositoryName, const IFMEServerString &description)=0
virtual IFMEServerStatus *	addService (const IFMEServerService &service)=0
virtual IFMEServerStatus *	getPropertyAccessor (const IFMEServerStringArray *directives, IFMEServerPropertyAccessor &propertyAccessor)=0
virtual IFMEServerStatus *	getRepositories (const IFMEServerStringArray *directives, IFMEServerRepositoryVector &repositories) const =0
virtual IFMEServerStatus *	getRepository (const IFMEServerString &repositoryName, IFMEServerRepository &repository, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getService (const IFMEServerString &serviceName, IFMEServerService &service, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getServices (const IFMEServerStringArray *directives, IFMEServerServiceVector &services) const =0
virtual IFMEServerStatus *	removeRepository (const IFMEServerString &repositoryName, FME_Boolean &existed)=0
virtual IFMEServerStatus *	removeService (const IFMEServerString &serviceName, FME_Boolean &existed)=0
virtual IFMEServerStatus *	repositoryExists (const IFMEServerString &repositoryName, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	serviceExists (const IFMEServerString &serviceName, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	updateService (const IFMEServerService &service)=0
Protected Member Functions
	IFMEServerRepositoryManager ()
virtual	~IFMEServerRepositoryManager ()
Private Member Functions
	IFMEServerRepositoryManager (const IFMEServerRepositoryManager &other)
IFMEServerRepositoryManager &	operator= (const IFMEServerRepositoryManager &other)

---

Detailed Description

IFMEServerRepositoryManager 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

IFMEServerRepositoryManager::IFMEServerRepositoryManager

(

)

[inline, protected]

virtual IFMEServerRepositoryManager::~IFMEServerRepositoryManager

(

)

[inline, protected, virtual]

IFMEServerRepositoryManager::IFMEServerRepositoryManager

(

const IFMEServerRepositoryManager &

other

)

[private]

---

Member Function Documentation

virtual IFMEServerStatus* IFMEServerRepositoryManager::addRepository	(	const IFMEServerString &	repositoryName,
		const IFMEServerString &	description
	)		[pure virtual]

Adds an FME repository. The repository name must not contain the following characters: \/:*?"<>|&='+%

Parameters:

name	the unique name that identifies the FME repository
description	the description of the FME repository

Returns:

IFMEServerStatus if a FME Server exception occurred. An exception will also occur if an FME repository with the same name already exists.

virtual IFMEServerStatus* IFMEServerRepositoryManager::addService

(

const IFMEServerService &

service

)

[pure virtual]

Adds an FME service to the FME Repository.

Note: An error will also occur if an FME service with the same name already exists.

Parameters:

service

The FME service to add. The name of the FME service must be unique.

virtual IFMEServerStatus* IFMEServerRepositoryManager::getPropertyAccessor	(	const IFMEServerStringArray *	directives,
		IFMEServerPropertyAccessor &	propertyAccessor
	)		[pure virtual]

Gets a property manager to manage repository manager properties.

Parameters:

directives	keyword and value pairs specifying property accessor to return
propertyAccessor	returns a property accessor

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepositoryManager::getRepositories	(	const IFMEServerStringArray *	directives,
		IFMEServerRepositoryVector &	repositories
	)		const [pure virtual]

Gets a list of FME repositories.

Parameters:

directives

a Map of keyword and values specifying FME repositories to return

If null then ALL repositories are returned.

If ENABLE_FILTER keyword used, then possible value is ALL. If ALL value used, then all repositories returned.

Parameters:

repositories

returns a list of FME repositories. An empty list is returned if there are no repositories.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepositoryManager::getRepository	(	const IFMEServerString &	repositoryName,
		IFMEServerRepository &	repository,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified FME repository.

Parameters:

name	the unique name that identifies the FME repository
repository	returns an FME repository.
exists	returns true if the requested repository exists, otherwise false if the named repository does not exists.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepositoryManager::getService	(	const IFMEServerString &	serviceName,
		IFMEServerService &	service,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified FME service.

Parameters:

serviceName	The unique name that identifies the FME service.
service	Return an FME service.
exists	Returns true if the service exists, otherwise false if there are no service named serviceName.

virtual IFMEServerStatus* IFMEServerRepositoryManager::getServices	(	const IFMEServerStringArray *	directives,
		IFMEServerServiceVector &	services
	)		const [pure virtual]

Gets a list of FME services.

Parameters:

directives

Keyword and values specifying FME services to request.

If NULL then all services are requested.

The following are the supported values for keyword: "ENABLE_FILTER" (C++ Constant: ???)

"ALL" (C++ Constant: ???)

When this is the value, all services are requested.

"ENABLED" (C++ Constant: ???)

When this is the value, only enabled services are requested.

"DISABLED" (C++ Constant: ???)

When this is the value, only disabled services are requested.

Parameters:

services

A list of FME services. An empty list is returned if there are no services.

IFMEServerRepositoryManager& IFMEServerRepositoryManager::operator=

(

const IFMEServerRepositoryManager &

other

)

[private]

virtual IFMEServerStatus* IFMEServerRepositoryManager::removeRepository	(	const IFMEServerString &	repositoryName,
		FME_Boolean &	existed
	)		[pure virtual]

Removes an FME repository.

Parameters:

name	the unique name that identifies the FME repository
existed	returns true if repository existed and was removed, otherwise false if service did not exist

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepositoryManager::removeService	(	const IFMEServerString &	serviceName,
		FME_Boolean &	existed
	)		[pure virtual]

Removes the specified FME service. When an FME service is removed all corresponding workspace registrations are also removed.

Parameters:

serviceName	The unique name that identifies the FME service.
existed	Return true if service existed and was removed, otherwise false if service did not exist.

virtual IFMEServerStatus* IFMEServerRepositoryManager::repositoryExists	(	const IFMEServerString &	repositoryName,
		FME_Boolean &	exists
	)		const [pure virtual]

Checks if specified FME repository exists.

Parameters:

repositoryName	the unique name that identifies the FME repository
exists	returns true if repository exists, otherwise false if repository does not exist

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepositoryManager::serviceExists	(	const IFMEServerString &	serviceName,
		FME_Boolean &	exists
	)		const [pure virtual]

Checks if the specified service exists.

Parameters:

serviceName	The unique name of the FME service.
exists	Returns true if the service exists, otherwise false is returned.

virtual IFMEServerStatus* IFMEServerRepositoryManager::updateService

(

const IFMEServerService &

service

)

[pure virtual]

Updates an existing FME service in the FME Repository.

Parameters:

service

The FME service to update.

---

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

• ifmeserverrepositorymanager.h