fmewebservices.FMEBasicConnection

Inheritance diagram of fmewebservices.FMEBasicConnection
FMEBasicConnection.getAuthenticationMethod() Retrieves the authentication method associated with this connection.
FMEBasicConnection.getAuthorizationHeader() Returns the authorization header associated with this named connection: utf-8 format expected for header.
FMEBasicConnection.getId() Gets the database generated id for this connection.
FMEBasicConnection.getName() Retrieves the name of this named connection, which is unique for the given authorized users.
FMEBasicConnection.getOwnerName() Gets the owner (user) of this named connection.
FMEBasicConnection.getPassword() Retrieves the user password associated with this connection.
FMEBasicConnection.getServiceName() Gets the owner (user) of this named connection.
FMEBasicConnection.getType() Retrieves the type of the named connection.
FMEBasicConnection.getUserName() Retrieves the user name associated with this connection.
FMEBasicConnection.getVerifySslCertificate() Returns whether or not this named connection should verify ssl certificates.
FMEBasicConnection.getWebService() Return the associated Web Service, which contains a general description of the type of Web Service as well as other details.
FMEBasicConnection.setAuthenticationMethod(...) Sets the authentication method associated with this connection.
FMEBasicConnection.setId(name) Sets the database generated id for this connection.
FMEBasicConnection.setName(name) Sets the name of this named connection, which is not committed to the DB until this named connection is passed back to the manager.
FMEBasicConnection.setOwnerName(name) Sets the owner (user) of this named connection.
FMEBasicConnection.setPassword(name) Sets the user password associated with this connection.
FMEBasicConnection.setUserName(name) Sets the user name associated with this connection.
class FMEBasicConnection

Bases: fmewebservices.FMENamedConnection

FME Basic Connection class.

init(serviceName)

Create an instance of a basic connection object.

Parameters:serviceName (str) – The service name of the connection.
__init__

Initialize self. See help(type(self)) for accurate signature.

getAuthenticationMethod()

Retrieves 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. If the connection has no associated authentication method, the associated Web Service’s authentication method will be used.

Return type:int
Returns:The authentication method.
getAuthorizationHeader()

Returns the authorization header associated with this named connection: utf-8 format expected for header.

Return type:str
Returns:The authorization header.
getId()

Gets the database generated id for this connection.

Return type:str
Returns:The database generated id for the named connection.
getName()

Retrieves the name of this named connection, which is unique for the given authorized users. This is the name given to the connection by the user.

Return type:str
Returns:The name of the named connection.
getOwnerName()

Gets the owner (user) of this named connection.

Return type:str
Returns:The owner of the named connection.
getPassword()

Retrieves the user password associated with this connection.

Return type:str
Returns:The user password.
getServiceName()

Gets the owner (user) of this named connection.

Return type:str
Returns:The owner of the named connection.
getType()

Retrieves the type of the named connection.

Returns one of FME_NAMEDCONNECTION_DATABASE, FME_NAMEDCONNECTION_BASIC, FME_NAMEDCONNECTION_OAUTH, FME_NAMEDCONNECTION_TOKEN, or FME_NAMEDCONNECTION_WEBSERVICE.

Return type:int
Returns:The type of the named connection.
getUserName()

Retrieves the user name associated with this connection.

Return type:str
Returns:The user name.
getVerifySslCertificate()

Returns whether or not this named connection should verify ssl certificates.

Return type:bool
Returns:Whether or not this named connection should verify ssl certificates.
getWebService()

Return the associated Web Service, which contains a general description of the type of Web Service as well as other details. Returns None if the Web Service does no exist.

Return type:FMEWebService or None
Returns:The 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
setId(name)

Sets the database generated id for this connection.

Parameters:name (str) – The database generated id to set for the named connection.
Return type:None
setName(name)

Sets the name of this named connection, which is not committed to the DB until this named connection is passed back to the manager.

Parameters:name (str) – The name to set on the named connection.
Return type:None
setOwnerName(name)

Sets the owner (user) of this named connection.

Parameters:name (str) – The name to set as the owner of the named connection.
Return type:None
setPassword(name)

Sets the user password associated with this connection.

Parameters:name (str) – The user password.
Return type:None
setUserName(name)

Sets the user name associated with this connection.

Parameters:name (str) – The user name.
Return type:None