T-Plan Robot Enterprise 5.0.1
Build No. 5.0.1-20190308.1

com.tplan.robot
Interface LicenseListener

All Known Implementing Classes:
DefaultLicenseListener

public interface LicenseListener

License listener interface tracks how licensed seats (connections) are used. T-Plan Robot Enterprise licensing is based on a maximum number of allowed simultaneous desktop connections. This limit is enforced through the software license key.

To register a listener for the license usage notifications call ApplicationSupport.addLicenseListener(com.tplan.robot.LicenseListener). The licenseStatus(com.tplan.robot.LicenseEvent) method will be called immediately to pass the initial information such as the number of total licensed connections/seats (available through LicenseEvent.getTotalSeats()) and currently free ones (LicenseEvent.getFreeSeats()). The method then gets called when a connection is pooled or reused (removed from the connection pool).

The remaining two listener methods of licenseUtilized(com.tplan.robot.LicenseEvent) and licenseReleased(com.tplan.robot.LicenseEvent) will be called asynchronously when a seat gets utilized (through connection to a desktop) or released (after disconnection from a client).

For a simple, ready-to-use listener listener see the DefaultLicenseListener class.


T-Plan Robot Enterprise, (C) 2009-2019 T-Plan Limited. All rights reserved.


Method Summary
 void licenseReleased(LicenseEvent event)
          This method gets called when a seat (connection) is released.
 void licenseStatus(LicenseEvent event)
          This method has several purposes.
 void licenseUtilized(LicenseEvent event)
          This method gets called when a seat (connection) is utilized by a connection to a desktop.
 

Method Detail

licenseStatus

void licenseStatus(LicenseEvent event)

This method has several purposes. First of all it is called immediately when the listener registers for license notifications through ApplicationSupport.addLicenseListener(com.tplan.robot.LicenseListener) with the event type of LicenseEvent.TYPE_STATUS.

The method then gets called when the status of the desktop clients changes without an immediate impact on the overall license number status. These changes include these type events:

Parameters:
event - license event providing the initial information about the total number of licensed seats (connections) as well as the free ones.

licenseReleased

void licenseReleased(LicenseEvent event)
This method gets called when a seat (connection) is released.

Parameters:
event - license event with information about license numbers and a reference to the desktop client which released the seat.

licenseUtilized

void licenseUtilized(LicenseEvent event)
This method gets called when a seat (connection) is utilized by a connection to a desktop.

Parameters:
event - license event with information about license numbers and a reference to the desktop client which reserved the seat.

T-Plan Robot Enterprise 5.0.1
Build No. 5.0.1-20190308.1