com.licensespring.floating.api

Interface FloatingServerV2Api

public interface FloatingServerV2Api

Floating Server V2 API.

Method Summary

Modifier and Type	Method and Description
AddConsumptionToFeatureResponse	addConsumptionToFeature(Long id, AddConsumptionToFeatureRequest payload) Adds a specified number of consumptions to a feature under a license.
AddConsumptionToLicenseResponse	addConsumptionToLicense(Long id, AddConsumptionToLicenseRequest payload) Adds a specified number of consumptions to a license by license ID.
AddLicenseResponse	addLicense(AddLicenseRequest payload) Activates a product license using either a license key or a username/password pair.
AddUserResponse	addUser(AddUserRequest payload) Creates a user with a hashed password and role Requires admin role.
BorrowLicenseResponse	borrowLicense(Long id, BorrowLicenseRequest payload) Temporarily borrows a license for a user until a given UTC time.
ChangePasswordResponse	changePassword(ChangePasswordRequest payload) Creates a user with a hashed password and role
com.licensespring.LicenseData	getLicenseById(Long id) Returns license details for a given license ID
List<com.licensespring.LicenseData>	getLicenses(GetLicensesQuery query) Returns all licenses associated with a specific product code
LoginResponse	login(LoginRequest payload) Authenticates a user and returns a JWT token
PingResponse	ping() Returns a simple pong message
RegisterFeatureForUserResponse	registerFeatureForUser(Long id, RegisterFeatureForUserRequest payload) Registers a specific feature under a license for a given user Requires user or admin role.
com.licensespring.LicenseData	registerUserToLicense(Long id, RegisterUserToLicenseRequest payload) Registers a user under a license with a specified number of allowed registrations Requires user or admin role.
String	removeLicenseById(Long id) Removes a product license using its license ID Requires admin role.
RemoveUserResponse	removeUser(RemoveUserRequest payload) Creates a user with a hashed password and role Requires admin role.
void	unregisterFeatureForUser(Long id, UnregisterFeatureForUserRequest payload) Releases a registered feature for a specific user.
void	unregisterUserFromLicense(Long id, UnregisterUserFromLicenseRequest payload) Removes a user from the license system by license ID and username Requires user or admin role.

Method Detail

addUser

AddUserResponse addUser(AddUserRequest payload)

Creates a user with a hashed password and role Requires admin role.

Returns:

User created successfully

changePassword

ChangePasswordResponse changePassword(ChangePasswordRequest payload)

Creates a user with a hashed password and role

Returns:

User changed password successfully

login

LoginResponse login(LoginRequest payload)

Authenticates a user and returns a JWT token

Returns:

JWT token

removeUser

RemoveUserResponse removeUser(RemoveUserRequest payload)

Creates a user with a hashed password and role Requires admin role.

Returns:

User removed successfully

getLicenses

List<com.licensespring.LicenseData> getLicenses(GetLicensesQuery query)

Returns all licenses associated with a specific product code

Returns:

List of licenses associated with the product

addLicense

AddLicenseResponse addLicense(AddLicenseRequest payload)

Activates a product license using either a license key or a username/password pair. Requires admin role.

Returns:

Product activated successfully

getLicenseById

com.licensespring.LicenseData getLicenseById(Long id)

Returns license details for a given license ID

Returns:

License details

removeLicenseById

String removeLicenseById(Long id)

Removes a product license using its license ID Requires admin role.

Returns:

License removed successfully

borrowLicense

BorrowLicenseResponse borrowLicense(Long id,
                                    BorrowLicenseRequest payload)

Temporarily borrows a license for a user until a given UTC time. The borrowed_until field must be in RFC3339 format: 2006-01-02T15:04:05Z07:00 (e.g. "2025-06-01T12:00:00Z"). Requires user or admin role.

Returns:

User borrowed license

registerUserToLicense

com.licensespring.LicenseData registerUserToLicense(Long id,
                                                    RegisterUserToLicenseRequest payload)

Registers a user under a license with a specified number of allowed registrations Requires user or admin role.

Returns:

User registered successfully

unregisterUserFromLicense

void unregisterUserFromLicense(Long id,
                               UnregisterUserFromLicenseRequest payload)

Removes a user from the license system by license ID and username Requires user or admin role.

registerFeatureForUser

RegisterFeatureForUserResponse registerFeatureForUser(Long id,
                                                      RegisterFeatureForUserRequest payload)

Registers a specific feature under a license for a given user Requires user or admin role.

Returns:

Feature registered

unregisterFeatureForUser

void unregisterFeatureForUser(Long id,
                              UnregisterFeatureForUserRequest payload)

Releases a registered feature for a specific user. Requires user or admin role.

ping

PingResponse ping()

Returns a simple pong message

Returns:

simple pong message

addConsumptionToLicense

AddConsumptionToLicenseResponse addConsumptionToLicense(Long id,
                                                        AddConsumptionToLicenseRequest payload)

Adds a specified number of consumptions to a license by license ID. Requires user or admin role.

Returns:

Consumption added

addConsumptionToFeature

AddConsumptionToFeatureResponse addConsumptionToFeature(Long id,
                                                        AddConsumptionToFeatureRequest payload)

Adds a specified number of consumptions to a feature under a license. Requires user or admin role.

Returns:

Feature consumption added