fmewebservices.FMETokenService

Inheritance diagram of fmewebservices.FMETokenService

FMETokenService.clearKeyDefinitions()

Removes the associated keys and definition lines for this Web Service.

FMETokenService.getAccessTokenRequestFormat()

Retrieves the associated access token request format for this Web Service.

FMETokenService.getAccessTokenResponseFormat()

Retrieves the associated access token response format for this Web Service.

FMETokenService.getAccessTokenURL()

Retrieves the associated access token URL for this Web Service.

FMETokenService.getApiTokenItemName()

Retrieves the associated token item name for this Web Service.

FMETokenService.getAuthorizationHeaderFormat()

Retrieves the associated authorization header format for this Web Service.

FMETokenService.getDefinitions()

Retrieves the associated definition lines for this Web Service.

FMETokenService.getDescription()

Retrieves the optional description of this Web Service.

FMETokenService.getExpiryTimeFormat()

Retrieves the associated expiry time format for this Web Service.

FMETokenService.getExpiryTimeResponseFormat()

Retrieves the associated expiry time response format for this Web Service.

FMETokenService.getHelpURL()

Retrieves the optional help url of this Web Service.

FMETokenService.getKeyDefinitions()

Retrieves the associated keys and definition lines for this Web Service.

FMETokenService.getKeys()

Retrieves the associated keys for this Web Service.

FMETokenService.getName()

Retrieves the unique name of this Web Service.

FMETokenService.getSourceWebServiceName()

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

FMETokenService.isDerivedWebService()

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

FMETokenService.isInstalledWebService()

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

FMETokenService.setAccessTokenRequestFormat(...)

Sets the associated access token request format for this web service.

FMETokenService.setAccessTokenResponseFormat(...)

Sets the associated access token response format for this web service.

FMETokenService.setAccessTokenURL(accessTokenURL)

Sets the associated access token url for this Web Service.

FMETokenService.setApiTokenItemName(...)

Sets the associated token item name for this Web Service.

FMETokenService.setAuthorizationHeaderFormat(...)

Sets the associated authorization header format for this web service.

FMETokenService.setDescription(description)

Sets the optional description of this Web Service.

FMETokenService.setExpiryTimeFormat(type, format)

Sets the associated expiry time format for this Web Service.

FMETokenService.setExpiryTimeResponseFormat(...)

Sets the associated expiry time response format for this web service.

FMETokenService.setHelpURL(url)

Sets the optional help url of this Web Service.

FMETokenService.setKeyDefinition(key, guiLine)

Sets the associated field pair for this Web Service.

FMETokenService.setName(name)

Sets the unique name of this Web Service.

FMETokenService.setSourceWebServiceName(name)

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

FMETokenService.setSupportHeaderAuthorization(...)

Sets whether the service supports bearer tokens in the HTTP header.

FMETokenService.setSupportQueryStringAuthorization(...)

Sets whether the service supports access token strings in the URL.

FMETokenService.supportHeaderAuthorization()

Returns true if the service supports bearer tokens in the HTTP header.

FMETokenService.supportQueryStringAuthorization()

Returns true if the service supports access token strings in the URL.

class FMETokenService

FME Token Service class.

init()

Create an instance of a token service object.

__init__(*args, **kwargs)
clearKeyDefinitions()

Removes the associated keys and definition lines for this Web Service.

Return type

None

getAccessTokenRequestFormat()

Retrieves the associated access token request format for this Web Service.

Return type

str

Returns

The access token request format.

getAccessTokenResponseFormat()

Retrieves the associated access token response format for this Web Service.

Return type

str

Returns

The access token response format.

getAccessTokenURL()

Retrieves the associated access token URL for this Web Service.

Return type

str

Returns

The access token URL.

getApiTokenItemName()

Retrieves the associated token item name for this Web Service.

Return type

str

Returns

The token item name.

getAuthorizationHeaderFormat()

Retrieves the associated authorization header format for this Web Service.

Return type

str

Returns

The access token response format.

getDefinitions()

Retrieves the associated definition lines for this Web Service.

Return type

list[str]

Returns

The definition lines.

getDescription()

Retrieves the optional description of this Web Service.

Return type

str

Returns

The description of the Web Service.

getExpiryTimeFormat()

Retrieves the associated expiry time format for this Web Service.

Return type

tuple of int and str

Returns

A tuple in the form (type, format), where type is one of FME_TIMEDURATION, FME_TIMEDATE or FME_TIMESTAMP.

getExpiryTimeResponseFormat()

Retrieves the associated expiry time response format for this Web Service.

Return type

str

Returns

The access token response format.

getHelpURL()

Retrieves the optional help url of this Web Service.

Return type

str

Returns

The url of the Web Service.

getKeyDefinitions()

Retrieves the associated keys and definition lines for this Web Service. The keys are the keys and the definition lines are the values in the returned dict.

Return type

dict

Returns

The keys and definition lines.

getKeys()

Retrieves the associated keys for this Web Service.

Return type

list[str]

Returns

The keys.

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.

setAccessTokenRequestFormat(accessTokenRequestFormat)

Sets the associated access token request format for this web service.

Parameters

accessTokenRequestFormat (str) – The access token request format.

Return type

None

setAccessTokenResponseFormat(accessTokenResponseFormat)

Sets the associated access token response format for this web service.

Parameters

accessTokenResponseFormat (str) – The access token response format.

Return type

None

setAccessTokenURL(accessTokenURL)

Sets the associated access token url for this Web Service.

Parameters

accessTokenURL (str) – The access token URL.

Return type

None

setApiTokenItemName(apiTokenItemName)

Sets the associated token item name for this Web Service.

Parameters

apiTokenItemName (str) – The token item name.

Return type

None

setAuthorizationHeaderFormat(authorizationHeaderFormat)

Sets the associated authorization header format for this web service.

Parameters

authorizationHeaderFormat (str) – The authorization header format.

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

setExpiryTimeFormat(type, format)

Sets the associated expiry time format for this Web Service.

Parameters
Return type

None

setExpiryTimeResponseFormat(expiryTimeResponseFormat)

Sets the associated expiry time response format for this web service.

Parameters

expiryTimeResponseFormat (str) – The expiry time response format.

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

setKeyDefinition(key, guiLine)

Sets the associated field pair for this Web Service.

Parameters
  • key (str) – The of the definition.

  • guiLine (str) – The definition of the key.

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

setSupportHeaderAuthorization(supported)

Sets whether the service supports bearer tokens in the HTTP header.

Parameters

supported (bool) – Whether the service supports bearer tokens.

Return type

None

setSupportQueryStringAuthorization(supported)

Sets whether the service supports access token strings in the URL.

Parameters

supported (bool) – Whether the service supports access token strings.

Return type

None

supportHeaderAuthorization()

Returns true if the service supports bearer tokens in the HTTP header.

Return type

bool

Returns

Whether the service supports bearer tokens.

supportQueryStringAuthorization()

Returns true if the service supports access token strings in the URL.

Return type

bool

Returns

Whether the service supports access token strings.