Home       Trees       Indices       Help   
Module fmeobjects :: Class FMELicenseManager
[hide private]
[frames] | no frames]

Class FMELicenseManager

object --+
         |
        FMELicenseManager

init()

FME License Manager class.

This class provides an interface to security functionality.

Instance Methods [hide private]
 
__init__()
x.__init__(...) initializes x; see help(type(x)) for signature
a new object with type S, a subtype of T
__new__(T, S, ...)
string or None
get3rdLicenseProperty(licenseFileName, vendorID, vendorRegKey, property)
Retrieves the value of a property from a 3rd party license file.
tuple of strings or None
getAllFactories()
Returns all the factory names for the current license.
tuple of strings or None
getAllFormats()
Returns all the format names for the current license.
tuple of strings or None
getAllFunctions()
Returns all the function names for the current license.
string or None
getAppLicenseProperty(appName, property)
Retrieves the value of a property for a given application.
string or None
getFactoryLicenseProperty(factoryName, property)
Retrieves the value of a property for a given factory.
string
getFactoryMinBaseCapability(factoryName)
Returns the minimum base capability for the specified factory to be licensed.
string or None
getFunctionLicenseProperty(functionName, property)
Retrieves the value of a property for a given function.
string
getFunctionMinBaseCapability(functionName)
Returns the minimum base capability for the specified function to be licensed.
string
getLicenseProperty(property)
Retrieves the value of a property from the current license.
string
getLicenseType()
Returns the current license type.
int
getMaxFMEProcesses()
This routine returns the maximum number of licensed fme processes.
int
getMaxFMEWorkerProcesses()
This routine returns the maximum number of licensed fmeworker processes.
string or None
getReaderLicenseProperty(readerName, property)
Retrieves the value of a property for a given reader.
string
getReaderMinBaseCapability(readerName)
Returns the minimum base capability for the specified reader to be licensed.
string or None
getWriterLicenseProperty(writerName, property)
Retrieves the value of a property for a given writer.
string
getWriterMinBaseCapability(writerName)
Returns the minimum base capability for the writer factory to be licensed.
bool
hasBaseCapability(capability)
bool
isAppLicensed(appName)
Returns whether or not an application is licensed.
bool
isArcGISInstalled(productName)
Returns whether or not a given ArcGIS product is installed.
bool
isArcObjectsLicensed()
bool
isFactoryLicensed(factoryName)
Returns whether or not a given factory is licensed.
bool
isFunctionLicensed(functionName)
Returns whether or not a given function is licensed.
bool
isGtransInstalled()
Returns whether or not the Gtrans reprojection library is installed.
bool
isReaderLicensed(readerName)
Returns whether or not a given reader is licensed.
bool
isWriterLicensed(writerName)
Returns whether or not a given writer is licensed.
int
validateLicenseFile(licenseFilePath)
This method is used to validate a license file.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__()
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

__new__(T, S, ...)

 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__

get3rdLicenseProperty(licenseFileName, vendorID, vendorRegKey, property)

 

Retrieves the value of a property from a 3rd party license file.

Parameters:
  • licenseFileName (string) - The file name of a 3rd party license file.
  • vendorID (int) - The custom key assigned by the vendor, used to verify that the property is licensed.
  • vendorRegKey (int) - The registration code of the vendor assigned by Safe Software, used to verify that the property is licensed.
  • property (string) - The name of the property to be retrieved.
Returns: string or None
The value of the property if successful or None otherwise.

getAllFactories()

 

Returns all the factory names for the current license. For all factories the list will be populated with <factory name>/<license value> pairs. <license value> can be either kFME_FormatLicensed or kFME_FormatUnlicensed.

Returns: tuple of strings or None
All the factories for the current license or None if unsuccessful.

getAllFormats()

 

Returns all the format names for the current license. For all formats the list will be populated with <format name>/<license value> pairs. <license value> can be one of the following:

kFME_FormatRead: Only reader is licensed

kFME_FormatWrite: Only writer is licensed

kFME_FormatBoth: Both reader and writer are licensed

kFME_FormatUnlicensed: Neither reader nor writer is licensed

Returns: tuple of strings or None
All the formats for the current license or None if unsuccessful.

getAllFunctions()

 

Returns all the function names for the current license. For all functions the list will be populated with <function name>/<license value> pairs. <license value> can be either kFME_FormatLicensed or kFME_FormatUnlicensed.

Returns: tuple of strings or None
All the functions for the current license or None if unsuccessful.

getAppLicenseProperty(appName, property)

 

Retrieves the value of a property for a given application. This is only used for application in which there are different levels of support

Parameters:
  • appName (string) - The name of the application.
  • property (string) - The name of the property to be retrieved.
Returns: string or None
The value of the property if successful or None otherwise.

getFactoryLicenseProperty(factoryName, property)

 

Retrieves the value of a property for a given factory. This is only used for factories in which there are different levels of support

Parameters:
  • factoryName (string) - The name of the factory.
  • property (string) - The name of the property to be retrieved.
Returns: string or None
The value of the property if successful or None otherwise.

getFactoryMinBaseCapability(factoryName)

 

Returns the minimum base capability for the specified factory to be licensed. Will return one of the following capability names:

  • DESKTOP
  • PROFESSIONAL
  • ENTERPRISE_GIS
  • ENTERPRISE_DB
  • SERVER
  • SMALLWORLD
  • NATIONAL
  • BASIC_RASTER
  • ADVANCED_RASTER
  • EXTRA_COST
Parameters:
  • factoryName (string) - The name of the factory.
Returns: string
The minimum base capability or None otherwise.

getFunctionLicenseProperty(functionName, property)

 

Retrieves the value of a property for a given function. This is only used for function in which there are different levels of support

Parameters:
  • functionName (string) - The name of the function.
  • property (string) - The name of the property to be retrieved.
Returns: string or None
The value of the property if successful or None otherwise.

getFunctionMinBaseCapability(functionName)

 

Returns the minimum base capability for the specified function to be licensed. Will return one of the following capability names:

  • DESKTOP
  • PROFESSIONAL
  • ENTERPRISE_GIS
  • ENTERPRISE_DB
  • SERVER
  • SMALLWORLD
  • NATIONAL
  • BASIC_RASTER
  • ADVANCED_RASTER
  • EXTRA_COST
Parameters:
  • functionName (string) - The name of the function.
Returns: string
The minimum base capability or None otherwise.

getLicenseProperty(property)

 

Retrieves the value of a property from the current license.

Parameters:
  • property (string) - The name of the property to be retrieved
Returns: string
The value of the property if successful or None otherwise.

getLicenseType()

 

Returns the current license type. Possible values are MACHINE SPECIFIC, OEM, GENERIC, or FLOATING.

Returns: string
The current license type if successful or None otherwise.

getMaxFMEProcesses()

 

This routine returns the maximum number of licensed fme processes.

Returns: int
Returns the maximum number of licensed fme processes.

getMaxFMEWorkerProcesses()

 

This routine returns the maximum number of licensed fmeworker processes.

Returns: int
Returns the maximum number of licensed fmeworker processes.

getReaderLicenseProperty(readerName, property)

 

Retrieves the value of a property for a given reader. This is only used for reader in which there are different levels of support

Parameters:
  • readerName (string) - The name of the reader.
  • property (string) - The name of the property to be retrieved.
Returns: string or None
The value of the property if successful or None otherwise.

getReaderMinBaseCapability(readerName)

 

Returns the minimum base capability for the specified reader to be licensed. Will return one of the following capability names:

  • DESKTOP
  • PROFESSIONAL
  • ENTERPRISE_GIS
  • ENTERPRISE_DB
  • SERVER
  • SMALLWORLD
  • NATIONAL
  • BASIC_RASTER
  • ADVANCED_RASTER
  • EXTRA_COST
Parameters:
  • readerName (string) - The name of the reader.
Returns: string
The minimum base capability or None otherwise.

getWriterLicenseProperty(writerName, property)

 

Retrieves the value of a property for a given writer. This is only used for writer in which there are different levels of support

Parameters:
  • writerName (string) - The name of the writer.
  • property (string) - The name of the property to be retrieved.
Returns: string or None
The value of the property if successful or None otherwise.

getWriterMinBaseCapability(writerName)

 

Returns the minimum base capability for the writer factory to be licensed. Will return one of the following capability names:

  • DESKTOP
  • PROFESSIONAL
  • ENTERPRISE_GIS
  • ENTERPRISE_DB
  • SERVER
  • SMALLWORLD
  • NATIONAL
  • BASIC_RASTER
  • ADVANCED_RASTER
  • EXTRA_COST
Parameters:
  • writerName (string) - The name of the writer.
Returns: string
The minimum base capability or None otherwise.

isAppLicensed(appName)

 

Returns whether or not an application is licensed.

Parameters:
  • appName (string) - The name of the application.
Returns: bool
Returns True if the application is licensed and False otherwise.

isArcGISInstalled(productName)

 

Returns whether or not a given ArcGIS product is installed. The following products are supported:

  • ArcGISDesktop - ArcGIS Desktop
  • ArcGISEngine - ArcGIS Engine
  • ArcGISServer - ArcGIS Server
  • None - any ArcGIS product
Parameters:
  • productName (string) - The name of the ArcGIS product.
Returns: bool
Returns True if the product is install and False otherwise.

isFactoryLicensed(factoryName)

 

Returns whether or not a given factory is licensed.

Parameters:
  • factoryName (string) - The name of a given factory.
Returns: bool
Returns True if the factory is licensed and False otherwise.

isFunctionLicensed(functionName)

 

Returns whether or not a given function is licensed.

Parameters:
  • functionName (string) - The name of a given function.
Returns: bool
Returns True if the function is licensed and False otherwise.

isGtransInstalled()

 

Returns whether or not the Gtrans reprojection library is installed.

Returns: bool
Returns True if the Gtrans reprojection library is installed and False otherwise.

isReaderLicensed(readerName)

 

Returns whether or not a given reader is licensed.

Parameters:
  • readerName (string) - The name of a given reader.
Returns: bool
Returns True if the reader is licensed and False otherwise.

isWriterLicensed(writerName)

 

Returns whether or not a given writer is licensed.

Parameters:
  • writerName (string) - The name of a given writer.
Returns: bool
Returns True if the writer is licensed and False otherwise.

validateLicenseFile(licenseFilePath)

 

This method is used to validate a license file. Note: It is not using the license file but rather merely returning whether or not the license file is valid for the current machine if it is installed.

Parameters:
  • licenseFilePath (string) - The full path of the license file.
Returns: int
If the file is valid it returns 0 otherwise a non-zero error code.

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Thu Nov 26 19:10:16 2015 http://epydoc.sourceforge.net