FME Server C++ API 3.0

IFMEServerConnectionInfo Class Reference

IFMEServerConnectionInfo interface. More...

#include <ifmeserverconnectioninfo.h>

List of all members.

Public Member Functions

virtual FMEServerCredentialType getCredentialType () const =0
virtual FME_Boolean getDirective (const IFMEServerString &key, IFMEServerString &value) const =0
virtual void getHost (IFMEServerString &host) const =0
virtual void getPassword (IFMEServerString &password) const =0
virtual FME_UInt16 getPort () const =0
virtual void getToken (IFMEServerString &token) const =0
virtual FMEServerConnectionType getType () const =0
virtual void getURL (IFMEServerString &url) const =0
virtual void getUserID (IFMEServerString &userID) const =0

Protected Member Functions

 IFMEServerConnectionInfo ()
virtual ~IFMEServerConnectionInfo ()

Private Member Functions

 IFMEServerConnectionInfo (const IFMEServerConnectionInfo &other)
IFMEServerConnectionInfooperator= (const IFMEServerConnectionInfo &other)

Detailed Description

IFMEServerConnectionInfo 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

IFMEServerConnectionInfo::IFMEServerConnectionInfo ( ) [inline, protected]
virtual IFMEServerConnectionInfo::~IFMEServerConnectionInfo ( ) [inline, protected, virtual]
IFMEServerConnectionInfo::IFMEServerConnectionInfo ( const IFMEServerConnectionInfo other) [private]

Member Function Documentation

virtual FMEServerCredentialType IFMEServerConnectionInfo::getCredentialType ( ) const [pure virtual]

Gets the credential type.

Parameters:
thecredential type
virtual FME_Boolean IFMEServerConnectionInfo::getDirective ( const IFMEServerString key,
IFMEServerString value 
) const [pure virtual]

If the directive key exists, returns true and the directive value. For all other cases, returns false.

Parameters:
thedirective key
thedirective value
Returns:
true if the directive key exists, and false otherwise
virtual void IFMEServerConnectionInfo::getHost ( IFMEServerString host) const [pure virtual]

Gets the host of this connection.

Returns:
the host of this connection
virtual void IFMEServerConnectionInfo::getPassword ( IFMEServerString password) const [pure virtual]

Gets the password.

Parameters:
passwordreturns the password
virtual FME_UInt16 IFMEServerConnectionInfo::getPort ( ) const [pure virtual]

Gets the port of this connection.

Returns:
the port of this connection.
virtual void IFMEServerConnectionInfo::getToken ( IFMEServerString token) const [pure virtual]

Gets the token.

Parameters:
thetoken
virtual FMEServerConnectionType IFMEServerConnectionInfo::getType ( ) const [pure virtual]

Gets the connection type

Returns:
the type of this connection
virtual void IFMEServerConnectionInfo::getURL ( IFMEServerString url) const [pure virtual]

Gets the http location for SOAP service.

Parameters:
httpLocationreturns the http location for SOAP service
virtual void IFMEServerConnectionInfo::getUserID ( IFMEServerString userID) const [pure virtual]

Gets the user ID.

Parameters:
userIDreturns the user ID
IFMEServerConnectionInfo& IFMEServerConnectionInfo::operator= ( const IFMEServerConnectionInfo other) [private]

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines