fmewebservices.FMEBasicService

Inheritance diagram of fmewebservices.FMEBasicService

FMEBasicService.getAuthenticationMethod()

Retrieves the authentication method associated with this service.

FMEBasicService.getDescription()

Retrieves the optional description of this Web Service.

FMEBasicService.getHelpURL()

Retrieves the optional help url of this Web Service.

FMEBasicService.getName()

Retrieves the unique name of this Web Service.

FMEBasicService.getSourceWebServiceName()

Gets the source name for the original Web Service for the derived Web Services.

FMEBasicService.isDerivedWebService()

Returns True if the Web Service is derived from another source.

FMEBasicService.isInstalledWebService()

Returns True if the Web Service is an installed Web Service.

FMEBasicService.setAuthenticationMethod(...)

Sets the authentication method associated with this connection.

FMEBasicService.setDescription(description)

Sets the optional description of this Web Service.

FMEBasicService.setHelpURL(url)

Sets the optional help url of this Web Service.

FMEBasicService.setName(name)

Sets the unique name of this Web Service.

FMEBasicService.setSourceWebServiceName(name)

Sets the source name for the original Web Service for the derived Web Services.

class FMEBasicService

FME Basic Service class.

init()

Create an instance of a basic service object.

__init__(*args, **kwargs)
getAuthenticationMethod()

Retrieves the authentication method associated with this service. This is expected to be FME_HTTP_AUTH_METHOD_BASIC, FME_HTTP_AUTH_METHOD_DIGEST, FME_HTTP_AUTH_METHOD_NTLM, or FME_HTTP_AUTH_METHOD_NONE.

Return type

int

Returns

The authentication method.

getDescription()

Retrieves the optional description of this Web Service.

Return type

str

Returns

The description of the Web Service.

getHelpURL()

Retrieves the optional help url of this Web Service.

Return type

str

Returns

The url of the Web Service.

getName()

Retrieves the unique name of this Web Service.

Return type

str

Returns

The name of the Web Service.

getSourceWebServiceName()

Gets the source name for the original Web Service for the derived Web Services.

Return type

str

Returns

The source web service name.

isDerivedWebService()

Returns True if the Web Service is derived from another source.

Return type

bool

Returns

Whether or not the Web Service is derived from another source.

isInstalledWebService()

Returns True if the Web Service is an installed Web Service.

Return type

bool

Returns

Whether or not the Web Service is an installed Web Service.

setAuthenticationMethod(authMethod)

Sets the authentication method associated with this connection. This is expected to be FME_HTTP_AUTH_METHOD_BASIC, FME_HTTP_AUTH_METHOD_DIGEST, FME_HTTP_AUTH_METHOD_NTLM, or FME_HTTP_AUTH_METHOD_NONE.

Parameters

authMethod (int) – The authentication method.

Return type

None

setDescription(description)

Sets the optional description of this Web Service.

Parameters

description (str) – The description to set on the Web Service.

Return type

None

setHelpURL(url)

Sets the optional help url of this Web Service.

Parameters

url (str) – The url to set on the Web Service.

Return type

None

setName(name)

Sets the unique name of this Web Service.

Parameters

name (str) – The name to set on the Web Service.

Return type

None

setSourceWebServiceName(name)

Sets the source name for the original Web Service for the derived Web Services.

Parameters

name (str) – The source name to set for the original Web Service for the derived Web Services.

Return type

None