com.tplan.robot

Class LicenseEvent

java.lang.Object

com.tplan.robot.LicenseEvent

public class LicenseEvent
extends Object

License event used for license status change notifications fired to the license listeners. See the LicenseListener class for details.

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_POOLED Event type - a desktop connection was released by a testing process (thread) to the connection pool for reuse.
static int	TYPE_RELEASED Event type - a seat has been released because a connection was either closed or crashed.
static int	TYPE_REUSED Event type - a desktop connection was picked up from the connection pool (reused) by a testing process (thread).
static int	TYPE_STATUS Event type - initial status request
static int	TYPE_UTILIZED Event type - a seat has been utilized by an established desktop connection.
static int	TYPE_WAITING Event type - all licensed seats have been exhausted and the client was put onto a waiting list.

Constructor Summary

Constructors

Constructor and Description
LicenseEvent(int type, int totalEx, int availableEx, int totalDev, int availableDev, boolean server, boolean dev, RemoteDesktopClient owner) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getFreeDevelopmentSeats() Get the number of free (available) development seats (connections).
int	getFreeExecutionSeats() Get the number of free (available) execution seats (connections).
int	getFreeSeats() Get the number of free (available) seats (connections).
RemoteDesktopClient	getSeatOwner() Get the desktop client owning the license seat.
int	getTotalDevelopmentSeats() Get the total number of licensed execution seats (connections).
int	getTotalExecutionSeats() Get the total number of licensed execution seats (connections).
int	getTotalSeats() Get the total number of licensed seats (connections).
int	getType() Get the event type, one of: TYPE_STATUS is the initial status event fired immediately after the listeners registers with the ApplicationSupport class, TYPE_UTILIZED is fired when a desktop client is about to connect to a desktop and uses up a license seat, TYPE_RELEASED is fired when a desktop client disconnects and frees up the owned license seat, TYPE_POOLED is fired when a connection is released by a test process and pooled for eventual reuse.
String	getTypeAsString()
long	getWhen() Time of event creation.
boolean	isDevelopmentLicense() Indicate whether the license is a development (true) or execution (false) one.
boolean	isServer() Indicates whether the application is licensed through the licensing server or a file based license key.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_STATUS

public static final int TYPE_STATUS

Event type - initial status request

See Also:

Constant Field Values

TYPE_RELEASED

public static final int TYPE_RELEASED

Event type - a seat has been released because a connection was either closed or crashed.

See Also:

Constant Field Values

TYPE_UTILIZED

public static final int TYPE_UTILIZED

Event type - a seat has been utilized by an established desktop connection.

See Also:

Constant Field Values

TYPE_WAITING

public static final int TYPE_WAITING

Event type - all licensed seats have been exhausted and the client was put onto a waiting list.

See Also:

Constant Field Values

TYPE_POOLED

public static final int TYPE_POOLED

Event type - a desktop connection was released by a testing process (thread) to the connection pool for reuse.

See Also:

Constant Field Values

TYPE_REUSED

public static final int TYPE_REUSED

Event type - a desktop connection was picked up from the connection pool (reused) by a testing process (thread).

See Also:

Constant Field Values

Constructor Detail

LicenseEvent

public LicenseEvent(int type,
                    int totalEx,
                    int availableEx,
                    int totalDev,
                    int availableDev,
                    boolean server,
                    boolean dev,
                    RemoteDesktopClient owner)

Constructor.

Parameters:

type - event type. See the getType() method for details on recognized event types.

totalEx - the number of execution seats.

availableEx - the number of free (unused) execution seats.

totalDev - the number of development seats.

availableDev - the number of free (unused) development seats.

server - true for licensing server or false for a file based license key(s).

dev - true/false for development/execution license type.

owner - license owner. It is null for the initial event of the TYPE_STATUS type.

Method Detail

getType

public int getType()

Get the event type, one of:

• TYPE_STATUS is the initial status event fired immediately after the listeners registers with the ApplicationSupport class,
• TYPE_UTILIZED is fired when a desktop client is about to connect to a desktop and uses up a license seat,
• TYPE_RELEASED is fired when a desktop client disconnects and frees up the owned license seat,
• TYPE_POOLED is fired when a connection is released by a test process and pooled for eventual reuse. Though this means no change to the license status because pooled connections keep holding the license seat, it is useful for debugging of the pool mechanism.
• TYPE_REUSED is fired when a connection is picked up from the connection pool and reused for a test script. Though this means no change to the license status because reused connections keep holding the license seat, it is useful for debugging of the pool mechanism.
• TYPE_WAITING is fired when the number of licenses is exhausted and the client requesting a license seat is queued to wait for a released license.

Returns:

the event type.

getFreeSeats

public int getFreeSeats()

Get the number of free (available) seats (connections). Be aware this number is accurate only if this automated process is the only one running on the local OS. If there are multiple Robot instances running at the same time on the same local machine, the tool may refuse a client connection due to the exhausted license seat limit even when this method returns a number which is greater than zero.

Returns:

number of free seats.

getFreeExecutionSeats

public int getFreeExecutionSeats()

Get the number of free (available) execution seats (connections). Be aware this number is accurate only if this automated process is the only one running on the local OS. If there are multiple Robot instances running at the same time on the same local machine, the tool may refuse a client connection due to the exhausted license seat limit even when this method returns a number which is greater than zero.

Returns:

number of free seats.

Since:

4.4

getFreeDevelopmentSeats

public int getFreeDevelopmentSeats()

Get the number of free (available) development seats (connections). Be aware this number is accurate only if this automated process is the only one running on the local OS. If there are multiple Robot instances running at the same time on the same local machine, the tool may refuse a client connection due to the exhausted license seat limit even when this method returns a number which is greater than zero.

Returns:

number of free seats.

Since:

4.4

getTotalSeats

public int getTotalSeats()

Get the total number of licensed seats (connections). It is a sum of all licensed connections retrieved from the installed software license keys. For details on licensing see the License Key of the T-Plan Robot Enterprise Release Notes document.

Returns:

total number of licensed seats (connections).

getTotalExecutionSeats

public int getTotalExecutionSeats()

Get the total number of licensed execution seats (connections). It is a sum of all licensed connections retrieved from the installed software license keys. For details on licensing see the License Key of the T-Plan Robot Enterprise Release Notes document.

Returns:

total number of licensed execution seats (connections).

Since:

4.4

getTotalDevelopmentSeats

public int getTotalDevelopmentSeats()

Get the total number of licensed execution seats (connections). It is a sum of all licensed connections retrieved from the installed software license keys. For details on licensing see the License Key of the T-Plan Robot Enterprise Release Notes document.

Returns:

total number of licensed execution seats (connections).

Since:

4.4

getSeatOwner

public RemoteDesktopClient getSeatOwner()

Get the desktop client owning the license seat.

Returns:

desktop client which owns the license seat.

getWhen

public long getWhen()

Time of event creation.

Returns:

machine time in milliseconds obtained through System.currentTimeMillis() at the time of event creation.

isServer

public boolean isServer()

Indicates whether the application is licensed through the licensing server or a file based license key.

Returns:

true in server mode or false otherwise.

Since:

4.4

isDevelopmentLicense

public boolean isDevelopmentLicense()

Indicate whether the license is a development (true) or execution (false) one.

Returns:

true on a dev license or false on an execution one.

Since:

4.4

getTypeAsString

public String getTypeAsString()

toString

public String toString()

Overrides:

toString in class Object