Package io.scanbot.sdk.licensing

Class LicenseInfo

java.lang.Object

io.scanbot.sdk.licensing.LicenseInfo

public class LicenseInfo
extends java.lang.Object

Information about the SDK license.

Constructor Summary

Constructors

Constructor	Description
LicenseInfo(LicenseStatus status, boolean isValid, java.lang.String licenseStatusMessage, double expirationTimestamp, java.lang.String expirationDateString, java.lang.String errorMessage, boolean onlineLicenseCheckInProgress, java.lang.String license, double nextOnlineLicenseCheckInMs, java.util.List<DeviceDeregistrationError> deviceDeregistationErrors)	Constructs LicenseInfo with default parameters.
LicenseInfo(LicenseStatus status, boolean isValid, java.lang.String licenseStatusMessage, double expirationTimestamp, java.lang.String expirationDateString, java.lang.String errorMessage, boolean onlineLicenseCheckInProgress, java.lang.String license, java.lang.Integer devices, double nextOnlineLicenseCheckInMs, java.util.List<DeviceDeregistrationError> deviceDeregistationErrors)	Constructs LicenseInfo with the given params.

Method Summary

Modifier and Type	Method	Description
java.util.List<DeviceDeregistrationError>	getDeviceDeregistationErrors()	Getter for deviceDeregistationErrors field.
java.lang.Integer	getDevices()	Getter for devices field.
java.lang.String	getErrorMessage()	Getter for errorMessage field.
java.lang.String	getExpirationDateString()	Getter for expirationDateString field.
double	getExpirationTimestamp()	Getter for expirationTimestamp field.
java.lang.String	getLicense()	Getter for license field.
java.lang.String	getLicenseStatusMessage()	Getter for licenseStatusMessage field.
double	getNextOnlineLicenseCheckInMs()	Getter for nextOnlineLicenseCheckInMs field.
boolean	getOnlineLicenseCheckInProgress()	Getter for onlineLicenseCheckInProgress field.
LicenseStatus	getStatus()	Getter for status field.
boolean	isValid()	Getter for isValid field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LicenseInfo

public LicenseInfo(LicenseStatus status,
                   boolean isValid,
                   java.lang.String licenseStatusMessage,
                   double expirationTimestamp,
                   java.lang.String expirationDateString,
                   java.lang.String errorMessage,
                   boolean onlineLicenseCheckInProgress,
                   java.lang.String license,
                   java.lang.Integer devices,
                   double nextOnlineLicenseCheckInMs,
                   java.util.List<DeviceDeregistrationError> deviceDeregistationErrors)

Constructs LicenseInfo with the given params.

Parameters:

status - License status.

isValid - True if the license status corresponds to a valid license.

licenseStatusMessage - Message describing the license status.

expirationTimestamp - Expiration timestamp of the license or trial period in seconds since the UNIX epoch.

expirationDateString - Expiration date of the license or trial period in ISO 8601 date-time format.

errorMessage - Additional error message in case of a license error.

onlineLicenseCheckInProgress - True if an online license check is in progress.

license - The currently active license. May be different from the license used to initialize the SDK if the online license check has completed and the server has sent an updated license.

devices - Number of devices the license is valid for, if the license is floating.

nextOnlineLicenseCheckInMs - Time in milliseconds until the next online license check will be performed. -1 if no online license check is scheduled.

deviceDeregistationErrors - List of errors that occurred during device deregistration. If for some device deregistration completed successfully, it will not be listed here. For each device at most one entry will be present.

LicenseInfo

public LicenseInfo(LicenseStatus status,
                   boolean isValid,
                   java.lang.String licenseStatusMessage,
                   double expirationTimestamp,
                   java.lang.String expirationDateString,
                   java.lang.String errorMessage,
                   boolean onlineLicenseCheckInProgress,
                   java.lang.String license,
                   double nextOnlineLicenseCheckInMs,
                   java.util.List<DeviceDeregistrationError> deviceDeregistationErrors)

Constructs LicenseInfo with default parameters.

Parameters:

status - License status.

isValid - True if the license status corresponds to a valid license.

licenseStatusMessage - Message describing the license status.

expirationTimestamp - Expiration timestamp of the license or trial period in seconds since the UNIX epoch.

expirationDateString - Expiration date of the license or trial period in ISO 8601 date-time format.

errorMessage - Additional error message in case of a license error.

onlineLicenseCheckInProgress - True if an online license check is in progress.

license - The currently active license. May be different from the license used to initialize the SDK if the online license check has completed and the server has sent an updated license.

nextOnlineLicenseCheckInMs - Time in milliseconds until the next online license check will be performed. -1 if no online license check is scheduled.

deviceDeregistationErrors - List of errors that occurred during device deregistration. If for some device deregistration completed successfully, it will not be listed here. For each device at most one entry will be present.

Method Detail

getStatus

public LicenseStatus getStatus()

Getter for status field. See constructor documentation for more information about the field.

Returns:

status

isValid

public boolean isValid()

Getter for isValid field. See constructor documentation for more information about the field.

Returns:

isValid

getLicenseStatusMessage

public java.lang.String getLicenseStatusMessage()

Getter for licenseStatusMessage field. See constructor documentation for more information about the field.

Returns:

licenseStatusMessage

getExpirationTimestamp

public double getExpirationTimestamp()

Getter for expirationTimestamp field. See constructor documentation for more information about the field.

Returns:

expirationTimestamp

getExpirationDateString

public java.lang.String getExpirationDateString()

Getter for expirationDateString field. See constructor documentation for more information about the field.

Returns:

expirationDateString

getErrorMessage

public java.lang.String getErrorMessage()

Getter for errorMessage field. See constructor documentation for more information about the field.

Returns:

errorMessage

getOnlineLicenseCheckInProgress

public boolean getOnlineLicenseCheckInProgress()

Getter for onlineLicenseCheckInProgress field. See constructor documentation for more information about the field.

Returns:

onlineLicenseCheckInProgress

getLicense

public java.lang.String getLicense()

Getter for license field. See constructor documentation for more information about the field.

Returns:

license

getDevices

public java.lang.Integer getDevices()

Getter for devices field. See constructor documentation for more information about the field.

Returns:

devices

getNextOnlineLicenseCheckInMs

public double getNextOnlineLicenseCheckInMs()

Getter for nextOnlineLicenseCheckInMs field. See constructor documentation for more information about the field.

Returns:

nextOnlineLicenseCheckInMs

getDeviceDeregistationErrors

public java.util.List<DeviceDeregistrationError> getDeviceDeregistationErrors()

Getter for deviceDeregistationErrors field. See constructor documentation for more information about the field.

Returns:

deviceDeregistationErrors