fmewebservices.FMETokenConnection

Inheritance diagram of fmewebservices.FMETokenConnection

FMETokenConnection.clearKeyValues()

Clears all values associated with this connection.

FMETokenConnection.getAccessToken()

Retrieves the access token associated with this connection.

FMETokenConnection.getAuthorizationHeader()

Returns a header field containing the access token.

FMETokenConnection.getAuthorizationQueryString()

Returns a URI query str containing the access token.

FMETokenConnection.getExpiryTime()

Retrieves the access token expiry time in seconds since epoch associated with this connection.

FMETokenConnection.getId()

Gets the database generated id for this connection.

FMETokenConnection.getKeyValues()

Retrieves the key values associated with this connection.

FMETokenConnection.getName()

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

FMETokenConnection.getOwnerName()

Gets the owner (user) of this named connection.

FMETokenConnection.getServiceName()

Gets the owner (user) of this named connection.

FMETokenConnection.getType()

Retrieves the type of the named connection.

FMETokenConnection.getVerifySslCertificate()

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

FMETokenConnection.getWebService()

Return the associated Web Service, which contains a general description of the type of Web Service as well as other details.

FMETokenConnection.setAccessToken(accessToken)

Sets the access token associated with this connection.

FMETokenConnection.setId(name)

Sets the database generated id for this connection.

FMETokenConnection.setKeyValues(keyValues)

Sets the key values associated with this connection.

FMETokenConnection.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.

FMETokenConnection.setOwnerName(name)

Sets the owner (user) of this named connection.

FMETokenConnection.setSuspectExpired()

This information is NOT persistent.

class FMETokenConnection

FME Token Connection class.

init(serviceName)

Create an instance of a token connection object.

Parameters

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

__init__(*args, **kwargs)
clearKeyValues()

Clears all values associated with this connection.

Return type

None

getAccessToken()

Retrieves the access token associated with this connection.

Return type

str

Returns

The access token.

getAuthorizationHeader()

Returns a header field containing the access token.

Return type

tuple[str]

Returns

A tuple in the form (header, authCode).

Raises

FMEWSException – An exception is raised if an error occurred.

getAuthorizationQueryString()

Returns a URI query str containing the access token.

Return type

tuple[str]

Returns

A tuple in the form (queryKey, queryValue).

Raises

FMEWSException – An exception is raised if an error occurred.

getExpiryTime()

Retrieves the access token expiry time in seconds since epoch associated with this connection.

Return type

long

Returns

The expiry time.

getId()

Gets the database generated id for this connection.

Return type

str

Returns

The database generated id for the named connection.

getKeyValues()

Retrieves the key values associated with this connection. The keys are the dictionary keys and the values are the dictionary values in the returned dict.

Return type

dict

Returns

The key values values.

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.

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.

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.

Return type

FMEWebService

Returns

The associated web service.

setAccessToken(accessToken)

Sets the access token associated with this connection. Not committed until this named connection is passed back to the manager.

Parameters

accessToken (str) – The access token.

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

setKeyValues(keyValues)

Sets the key values associated with this connection. Will append new keys, and update existing values, will not delete existing values. The keys are the dictionary keys and the values are the dictionary values in the dict parameter.

Parameters

keyValues (dict) – The key values.

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

setSuspectExpired()

This information is NOT persistent. It is preferred to be set by the clients when they receive a 401 call failure.

Return type

None