Index (Licensespring License Client 2.20.3 API)

A B C D E F G H I J L O P R S T U V

A

activateAirGapResponse(LicenseIdentity, String, String) - Method in class com.licensespring.LicenseManager: Activates an Air Gap License from the policy file
activateLicence(ActivationRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Activate the license.
activateLicence(ActivationRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
activateLicense(ActivationLicense) - Method in class com.licensespring.LicenseManager: Activate the license on the remove server.
activateLicenseOffline(LicenseIdentity) - Method in class com.licensespring.LicenseManager: Activates a license in offline mode.
activateLicenseOffline(LicenseIdentity, ActivateOfflineParams) - Method in class com.licensespring.LicenseManager: Activates a license in offline mode with additional parameters.
activateLicenseV2(ActivationRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Activate the license.
activateLicenseV2(ActivationRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
activateOffline(String) - Method in interface com.licensespring.api.LicenseClientAPI: Activates a license using the offline activation method.
activateOffline(String) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
activateOfflineResponse(LicenseIdentity, String) - Method in class com.licensespring.LicenseManager: Activates the license using ls_activation.lic file that was generated using LicenseSpring platform.
activateOfflineResponse(LicenseIdentity, InputStream) - Method in class com.licensespring.LicenseManager: Activates the license using ls_activation.lic file that was generated using LicenseSpring platform.
active(Boolean) - Method in class com.licensespring.License.LicenseBuilder
addConsumption(ConsumptionRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Increases the consumptions by the parameter provided.
addConsumption(ConsumptionRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
addFeatureConsumption(FeatureConsumptionRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Increases the consumptions of a feature by the provided parameter.
addFeatureConsumption(FeatureConsumptionRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
airGappedPublicKey(String) - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder: Air Gapped Public Key generated in the LS platform - needed for AirGapped Feature to work

B

build() - Method in class com.licensespring.License.LicenseBuilder
build() - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder
builder() - Static method in class com.licensespring.License
builder() - Static method in class com.licensespring.LicenseSpringConfiguration
buildFeign(LicenseSpringConfiguration, Gson, AuthorizationService, boolean) - Static method in class com.licensespring.api.LicenseClientApiFactory: Build LicenseClientAPI from provided parameters.
buildFeign(LicenseSpringConfiguration, Gson, AuthorizationService, boolean, OkHttpClient.Builder) - Static method in class com.licensespring.api.LicenseClientApiFactory: Build LicenseClientAPI from provided parameters.

C

canEqual(Object) - Method in class com.licensespring.License
canEqual(Object) - Method in class com.licensespring.LicenseSpringConfiguration
changeOAuthClientSecret(String) - Method in class com.licensespring.LicenseManager: Changes the OAuth client secret
changeOAuthCredentials(String, String) - Method in class com.licensespring.LicenseManager: Changes the OAuth client credentials (both ID and secret) without deleting the license
checkLicense(ActivationRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Checks if license is valid and syncs local consumptions if configuration property enableLocalCaching is true.
checkLicense(ActivationRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
checkLicense(License) - Method in class com.licensespring.LicenseManager: Check license call.
checkLicenseFeature(FloatingFeatureReq) - Method in interface com.licensespring.api.LicenseClientAPI: Use this endpoint to check a license device against a license feature.
checkLicenseFeature(FloatingFeatureReq) - Method in class com.licensespring.api.OfflineLicenseClientApi
checkLicenseV2(ActivationRequest) - Method in interface com.licensespring.api.LicenseClientAPI
checkLicenseV2(ActivationRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi
checkPeriod(Duration) - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder
clearLocalStorage() - Method in class com.licensespring.LicenseManager: Clears all local license data.
ClientConfigurationBuilder() - Constructor for class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder
com.licensespring - package com.licensespring
com.licensespring.api - package com.licensespring.api: Package com.licensespring.api contains all classes required to successfully call LicenseClientAPI.
com.licensespring.utils - package com.licensespring.utils
createFromCheck(License, CheckResponse) - Static method in class com.licensespring.License
createGson(LicenseSpringConfiguration) - Static method in class com.licensespring.utils.JsonSerialization: Returns Gson object with custom options required to serialize from JSON to Java objects and vice-versa.
createGsonSerializeNulls(LicenseSpringConfiguration) - Static method in class com.licensespring.utils.JsonSerialization
createLicenseManager() - Static method in class com.licensespring.LicenseManagerFactory: creates a new LicenseManager object

D

data(LicenseData) - Method in class com.licensespring.License.LicenseBuilder: Server license data - both online and offline activation data is stored in this field
daysPassedSinceLastCheck() - Method in class com.licensespring.License
daysRemaining() - Method in class com.licensespring.License
deactivateAirGapResponse(LicenseIdentity, String, String) - Method in class com.licensespring.LicenseManager: Deactivates an Air Gap License with matching policyId
deactivateLicence(LicenseRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Releases a floating cloud license from current device and syncs local consumptions if configuration property enableLocalCaching is true.
deactivateLicence(LicenseRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
deactivateLicense(LicenseIdentity) - Method in class com.licensespring.LicenseManager: A license can be deactivated using this method, then the license can be used on another device
deactivateLicenseOffline(LicenseIdentity) - Method in class com.licensespring.LicenseManager: Deactivates a license in offline mode.
deactivateOffline(String) - Method in interface com.licensespring.api.LicenseClientAPI: Deactivates a license using the offline deactivation method.
deactivateOffline(String) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.licensespring.utils.LicenseDeserializer
deserializeLicenseData(License, String) - Method in class com.licensespring.utils.LicenseDeserializer
deviceLicenses(String) - Method in interface com.licensespring.api.LicenseClientAPI: Returns a list of licenses assigned to device
deviceLicenses(String) - Method in class com.licensespring.api.OfflineLicenseClientApi

E

enabled(Boolean) - Method in class com.licensespring.License.LicenseBuilder
enablePeriodicCheck(boolean) - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder
equals(Object) - Method in class com.licensespring.License
equals(Object) - Method in class com.licensespring.LicenseSpringConfiguration

F

forceSignatureV2Check(boolean) - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder

G

getActive() - Method in class com.licensespring.License
getAirGapActivationCode(LicenseIdentity, String) - Method in class com.licensespring.LicenseManager: Generated the activation code for Air Gapped License
getAirGapDeactivationCode(LicenseIdentity, String) - Method in class com.licensespring.LicenseManager: Generated the deactivation code for Air Gapped License
getAirGappedPublicKey() - Method in class com.licensespring.LicenseSpringConfiguration: Air Gapped Public Key generated in the LS platform - needed for AirGapped Feature to work
getCheckPeriod() - Method in class com.licensespring.LicenseSpringConfiguration: Period of invocation.
getConfig() - Method in class com.licensespring.LicenseManager
getCurrent() - Method in class com.licensespring.LicenseManager: Returns the license from the local license file Updates the usage timestamp if offline mode, check locally for clock tampering before setting usage timestamp
getData() - Method in class com.licensespring.License: Server license data - both online and offline activation data is stored in this field
getEnabled() - Method in class com.licensespring.License
getGracePeriodDays() - Method in class com.licensespring.LicenseSpringConfiguration: Period, in days, in which the SDK ignores infrastructural issues on check Call.
getHardwareId() - Method in class com.licensespring.License: hardware id for which this license data has been activated for
getIdentity() - Method in class com.licensespring.License: The license identity - licenseKey or username is kept in this field
getInstallationFile(InstallationFileQuery) - Method in interface com.licensespring.api.LicenseClientAPI: Gets the installation file for the product.
getInstallationFile(InstallationFileQuery) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
getInstallationFile() - Method in class com.licensespring.License: Information on the location of potential installation files.
getInstallationFile(LicenseIdentity) - Method in class com.licensespring.LicenseManager: Gets the latest installation file for the product.
getInstallationFile(LicenseIdentity, InstallationFileParams) - Method in class com.licensespring.LicenseManager: Gets the installation file for the product.
getInstance() - Static method in class com.licensespring.LicenseManager: Thread-safe method to obtain the instance of LicenseManager
getLastCheck() - Method in class com.licensespring.License: Last time the check was performed on this
getLastUsage() - Method in class com.licensespring.License: Gets updated each time the application runs
getLicenseFilePath() - Method in class com.licensespring.LicenseSpringConfiguration: Custom path for the local file
getLicenseManager() - Static method in class com.licensespring.LicenseManagerFactory: uses the Singleton design pattern, to have a single LicenseManager
getLocalConsumptions() - Method in class com.licensespring.License: Consumptions which are tracked locally.
getLocalFeatureConsumptions() - Method in class com.licensespring.License: Map which used to increase local feature consumptions.
getMaxActivations() - Method in class com.licensespring.License
getMaxConsumptions() - Method in class com.licensespring.License
getOAuthCredentials() - Method in class com.licensespring.LicenseManager: Gets the current OAuth credentials.
getOfflineLicenseContent(LicenseIdentity) - Method in class com.licensespring.LicenseManager: Gets the content for offline license activation without activating the license.
getOfflineLicenseContent(LicenseIdentity, ActivateOfflineParams) - Method in class com.licensespring.LicenseManager: Gets the content for offline license activation with additional parameters without activating the license.
getProduct() - Method in class com.licensespring.License
getProductDetails(ProductDetailsQuery) - Method in interface com.licensespring.api.LicenseClientAPI: Fetches product data from the server
getProductDetails(ProductDetailsQuery) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
getProductDetails() - Method in class com.licensespring.LicenseManager: Fetches product data from the server
getProductDetails(ProductDetailsParams) - Method in class com.licensespring.LicenseManager: Fetches product data from the server
getProductVersions(ProductVersionsQuery) - Method in interface com.licensespring.api.LicenseClientAPI: Gets all the available versions for the product configured via configuration settings
getProductVersions(ProductVersionsQuery) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
getProductVersions(LicenseIdentity, ProductVersionsParams) - Method in class com.licensespring.LicenseManager: Gets all the available versions for the product configured via configuration settings
getRemoteExpired() - Method in class com.licensespring.License
getRepository() - Method in class com.licensespring.License
getServerResponse() - Method in class com.licensespring.License
getServerSignature() - Method in class com.licensespring.License
getService() - Method in class com.licensespring.License
getSsoUrl(String, SSOResponseType) - Method in class com.licensespring.LicenseManager: Returns SSO URL
getTimesActivated() - Method in class com.licensespring.License
getTotalConsumptions() - Method in class com.licensespring.License
getTrialLicense(String) - Method in class com.licensespring.LicenseManager: For a trial period an email must be provided
getTrialLicense(Customer) - Method in class com.licensespring.LicenseManager: For a trial period an email must be provided
getVariables(LicenseRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Gets custom device variables for the device and license
getVariables(LicenseRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi
getVariables(LicenseIdentity) - Method in class com.licensespring.LicenseManager: Tracks custom device variables which can be seen in the platform.
getVersions(LicenseIdentity) - Method in class com.licensespring.LicenseManager: Gets all the available versions for the product configured via configuration settings
gracePeriodDays(int) - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder

H

hardwareId(String) - Method in class com.licensespring.License.LicenseBuilder: hardware id for which this license data has been activated for
hashCode() - Method in class com.licensespring.License
hashCode() - Method in class com.licensespring.LicenseSpringConfiguration

I

identity(LicenseIdentity) - Method in class com.licensespring.License.LicenseBuilder: The license identity - licenseKey or username is kept in this field
ignoreServerExceptions(boolean) - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder: Disable the need to contact LS servers for checking of license.
increaseConsumption() - Method in class com.licensespring.License: Increases local consumptions by 1.
increaseConsumption(int) - Method in class com.licensespring.License: Increases local consumptions by the parameter provided.
increaseFeatureConsumption(String) - Method in class com.licensespring.License: Increases by 1 the consumptions of a feature provided.
increaseFeatureConsumption(String, int) - Method in class com.licensespring.License: Increases by increment the consumptions of a feature provided.
initialize(LicenseSpringConfiguration) - Method in class com.licensespring.LicenseManager: Should be called once per runtime.
initialize(LicenseSpringConfiguration, LicenseRepository) - Method in class com.licensespring.LicenseManager: Should be called once per runtime.
initialize(LicenseSpringConfiguration, OkHttpClient.Builder) - Method in class com.licensespring.LicenseManager: Should be called once per runtime.
initialize(LicenseSpringConfiguration, LicenseRepository, OkHttpClient.Builder) - Method in class com.licensespring.LicenseManager: Should be called once per runtime.
installationFile(InstallationFile) - Method in class com.licensespring.License.LicenseBuilder: Information on the location of potential installation files.
isEnablePeriodicCheck() - Method in class com.licensespring.LicenseSpringConfiguration: Should the Consumption APIs be invoked periodically.
isExpired() - Method in class com.licensespring.License: Checks if license has expired locally
isForceSignatureV2Check() - Method in class com.licensespring.LicenseSpringConfiguration: Force signature v2 check
isIgnoreServerExceptions() - Method in class com.licensespring.LicenseSpringConfiguration: Disable the need to contact LS servers for checking of license.
isInitialized() - Method in class com.licensespring.LicenseManager: Checks if the LicenseManger has been initialized
isOfflineActivated() - Method in class com.licensespring.License: Returns true if License is offline activated, false otherwise.
isOfflineMode() - Method in class com.licensespring.LicenseSpringConfiguration: Enable offline mode.

J

JsonSerialization - Class in com.licensespring.utils: Custom Gson factory, implementing custom serialization, handling naming conventions conversion from snake_case to camelCase, field naming, and various custom adapters required.

L

lastCheck(ZonedDateTime) - Method in class com.licensespring.License.LicenseBuilder: Last time the check was performed on this
lastUsage(ZonedDateTime) - Method in class com.licensespring.License.LicenseBuilder: Gets updated each time the application runs
License - Class in com.licensespring: SDK's abstraction of the License.
License.LicenseBuilder - Class in com.licensespring
LicenseClientAPI - Interface in com.licensespring.api: License APIs
LicenseClientApiFactory - Class in com.licensespring.api: API factory used for building LicenseClientAPI
LicenseDeserializer - Class in com.licensespring.utils
LicenseDeserializer(LicenseSpringConfiguration) - Constructor for class com.licensespring.utils.LicenseDeserializer
licenseFilePath(String) - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder
LicenseManager - Class in com.licensespring: A singleton instance of the LicenseManager can be gotten via .getInstance() call Multiple LicenseManagers can be instantiated with the no-args constructor or using the LicenseManagerFactory.
LicenseManager() - Constructor for class com.licensespring.LicenseManager
LicenseManagerFactory - Class in com.licensespring: A factory for LicenseManager
LicenseSpringConfiguration - Class in com.licensespring: LicenseSpring configuration object.
LicenseSpringConfiguration.ClientConfigurationBuilder - Class in com.licensespring
localCheck() - Method in class com.licensespring.License: performs a local check of the license.
localConsumptions(int) - Method in class com.licensespring.License.LicenseBuilder: Consumptions which are tracked locally.
localFeatureConsumptions(Map<String, Integer>) - Method in class com.licensespring.License.LicenseBuilder: Map which used to increase local feature consumptions.

O

offlineActivationFile(LicenseIdentity, String) - Method in class com.licensespring.LicenseManager: Generates an offline activation file.
offlineActivationFile(LicenseIdentity, String, ActivateOfflineParams) - Method in class com.licensespring.LicenseManager: Generates an offline activation file.
offlineActivationStream(LicenseIdentity, OutputStream) - Method in class com.licensespring.LicenseManager: Generates an offline activation request.
offlineDeactivationFile(LicenseIdentity, String) - Method in class com.licensespring.LicenseManager: Generates an offline deactivation file.
offlineDeactivationStream(LicenseIdentity, OutputStream) - Method in class com.licensespring.LicenseManager: Generates an offline deactivation request.
OfflineLicenseClientApi - Class in com.licensespring.api: Offline implementation - should not call these APIs.
OfflineLicenseClientApi() - Constructor for class com.licensespring.api.OfflineLicenseClientApi
offlineMode(boolean) - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder

P

product(Product) - Method in class com.licensespring.License.LicenseBuilder: Detailed product information is kept and updated everytime the license is activated.

R

reinitialize(LicenseSpringConfiguration) - Method in class com.licensespring.LicenseManager
reinitialize(LicenseSpringConfiguration, LicenseRepository) - Method in class com.licensespring.LicenseManager
reinitialize(LicenseSpringConfiguration, OkHttpClient.Builder) - Method in class com.licensespring.LicenseManager
reinitialize(LicenseSpringConfiguration, LicenseRepository, OkHttpClient.Builder) - Method in class com.licensespring.LicenseManager: deletes the previous license and scheduled executor in case the manager was initialized before
remoteExpired(Boolean) - Method in class com.licensespring.License.LicenseBuilder
repository(LicenseRepository) - Method in class com.licensespring.License.LicenseBuilder

S

self() - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder
serverResponse(String) - Method in class com.licensespring.License.LicenseBuilder
serverSignature(String) - Method in class com.licensespring.License.LicenseBuilder
service(LicenseService) - Method in class com.licensespring.License.LicenseBuilder
setActive(Boolean) - Method in class com.licensespring.License
setData(LicenseData) - Method in class com.licensespring.License: Server license data - both online and offline activation data is stored in this field
setEnabled(Boolean) - Method in class com.licensespring.License
setLastCheck(ZonedDateTime) - Method in class com.licensespring.License: Last time the check was performed on this
setLastUsage(ZonedDateTime) - Method in class com.licensespring.License: Gets updated each time the application runs
setLocalConsumptions(int) - Method in class com.licensespring.License: Consumptions which are tracked locally.
setLocalFeatureConsumptions(Map<String, Integer>) - Method in class com.licensespring.License: Map which used to increase local feature consumptions.
setOfflineMode(boolean) - Method in class com.licensespring.LicenseManager: Sets offline mode to desired value (true for turning on, false for turning off)
setRemoteExpired(Boolean) - Method in class com.licensespring.License
setRepository(LicenseRepository) - Method in class com.licensespring.License
setService(LicenseService) - Method in class com.licensespring.License
shutdownScheduler() - Method in class com.licensespring.LicenseManager: Calls ExecutorService.shutdownNow() for the periodic check executor, if period check is enabled Used for cases where JVM doesn't get the shutdown signal and keeps a thread running indefinitely
ssoUrl(Map<String, String>) - Method in interface com.licensespring.api.LicenseClientAPI: Returns SSO URL
ssoUrl(Map<String, String>) - Method in class com.licensespring.api.OfflineLicenseClientApi
syncConsumptions() - Method in class com.licensespring.License: The method syncs local with remote consumptions.

T

toString() - Method in class com.licensespring.License.LicenseBuilder
toString() - Method in class com.licensespring.License
toString() - Method in class com.licensespring.LicenseSpringConfiguration.ClientConfigurationBuilder
toString() - Method in class com.licensespring.LicenseSpringConfiguration
trackVariables(VariableRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Tracks custom device variables which can be seen in the platform.
trackVariables(VariableRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.
trackVariables(LicenseIdentity, Map<String, String>) - Method in class com.licensespring.LicenseManager: Tracks custom device variables which can be seen in the platform.
trialKey(TrialLicenseRequest) - Method in interface com.licensespring.api.LicenseClientAPI: This method provides a trial key.
trialKey(TrialLicenseRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi: Throws exception when invoked.

U

updateFromOfflineResponse(LicenseIdentity, InputStream) - Method in class com.licensespring.LicenseManager: Updates the license using ls_activation.lic file that was generated using LicenseSpring platform.
userLicenses(UserLicensesRequest) - Method in interface com.licensespring.api.LicenseClientAPI: Returns a list of licenses assigned to user
userLicenses(UserLicensesRequest) - Method in class com.licensespring.api.OfflineLicenseClientApi

V

verifyAirGapConfirmationCode(LicenseIdentity, String, String) - Method in class com.licensespring.LicenseManager: Verifies the activation code for Air Gapped License

A B C D E F G H I J L O P R S T U V