fmewebservices.FMEOAuthV2Connection

FMEOAuthV2Connection.clearKeyValues()	Clears all values associated with this connection.
FMEOAuthV2Connection.getAccessToken()	Retrieves the access token associated with this connection.
FMEOAuthV2Connection.getAuthorizationHeader()	Returns a header field containing the access token.
FMEOAuthV2Connection.getAuthorizationQueryString()	Returns a URI query string containing the access token.
FMEOAuthV2Connection.getId()	Gets the database generated id for this connection.
FMEOAuthV2Connection.getKeyValues()	Retrieves the key values associated with this connection.
FMEOAuthV2Connection.getName()	Retrieves the name of this named connection, which is unique for the given authorized users.
FMEOAuthV2Connection.getOwnerName()	Gets the owner (user) of this named connection.
FMEOAuthV2Connection.getRefreshToken()	Retrieves the refresh token associated with this connection.
FMEOAuthV2Connection.getServiceName()	Gets the owner (user) of this named connection.
FMEOAuthV2Connection.getType()	Retrieves the type of the named connection.
FMEOAuthV2Connection.getVerifySslCertificate()	Returns whether or not this named connection should verify ssl certificates.
FMEOAuthV2Connection.getWebService()	Return the associated web service.
FMEOAuthV2Connection.setAccessToken(accessToken)	Sets the access token associated with this connection.
FMEOAuthV2Connection.setExpiryTime(utcUnixTime)	Sets the expiry time associated with the access token.
FMEOAuthV2Connection.setId(name)	Sets the database generated id for this connection.
FMEOAuthV2Connection.setKeyValues(keyValues)	Sets the key values associated with this connection.
FMEOAuthV2Connection.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.
FMEOAuthV2Connection.setOwnerName(name)	Sets the owner (user) of this named connection.
FMEOAuthV2Connection.setRefreshToken(...)	Sets the refresh token associated with this connection.
FMEOAuthV2Connection.setSuspectExpired()	This information is NOT persistent.

class FMEOAuthV2Connection

FME OAuth Connection class.

init(serviceName)

Create an instance of an oauth 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 string 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.

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.

Return type:

dict

Returns:

The key values for this connection as a dictionary.

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.

getRefreshToken()

Retrieves the refresh token associated with this connection.

Return type:

str

Returns:

The refresh token.

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.

Return type:

FMEOAuthV2WebService

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

setExpiryTime(utcUnixTime)

Sets the expiry time associated with the access token. The value is assumed to be in seconds since epoch, UTC. Not committed until this named connection is passed back to the manager.

Parameters:

utcUnixTime (long) – The expiry time.

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. This will append new keys, update existing values and 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

Raises:

FMEWSException – An exception is raised if an error occurred.

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

setRefreshToken(refreshToken)

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

Parameters:

refreshToken (str) – The refresh token.

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