com.licensespring.management

Class LicenseService

java.lang.Object

com.licensespring.management.LicenseService

public class LicenseService
extends Object

LicenseService class is used for searching, updating, disabling, assigning licenses to a particular users and (re)setting consumptions on the license. It also contains methods for searching devices and setting license users password. The object needs to be initialized before any other calls can be made.

Constructor Summary

Constructors

Constructor and Description
LicenseService(ManagementConfiguration configuration) LicenseService has to be built using the ManagementConfiguration object.

Method Summary

Modifier and Type	Method and Description
List<MultipleAssignmentResponse>	assignMultipleUsers(Long licenseId, AssignMultipleUsersRequest request) Assigns multiple users to a single license if requesting manager has access permissions to it.
String	assignUser(Long licenseId, AssignUserToLicenseRequest licenseUser) Assigns the provided user to the license.
boolean	blacklistDevice(Long id) Blacklists the device.
DeviceVariablesService	deviceVariablesService() Returns service for device variables.
void	disableAllLicenses(Long[] licenseIds) Disables licenses in bulk.
void	disableLicense(Long licenseId) Disables the license with provided id.
BackOfficeLicense	enableLicense(Long licenseId) Enables license with the provided id.
Device	getDevice(Long id) Gets the device data.
BackOfficeLicense	getLicense(Long licenseId) Retrieves license data.
LicenseCustomFieldsService	licenseCustomFieldsService() Returns service for license custom fields.
List<Device>	paginateThroughAllDevices(SearchDevicesRequest request) Goes through all pages of the search devices response and returns a list with all possible devices that satisfy the request.
List<BackOfficeLicense>	paginateThroughAllLicenses(SearchLicensesRequest request) Goes through all pages of the search licenses response and returns a list with all possible licenses that satisfy the request.
BackOfficeLicense	patchLicenseFeatures(Long licenseId, PatchLicenseFeaturesRequest request) Patches the license (product) features available.
boolean	resetDevice(Long id) Resets the device.
boolean	resetLicense(Long licenseId) Resets the license with the provided id.
BackOfficeLicense	resetTotalConsumptions(Long licenseId) Resets the total consumptions on the license to zero.
SearchResult<Device>	searchDevices(SearchDevicesRequest request) Returns a list of devices that satisfy the request.
SearchResult<BackOfficeLicense>	searchLicenses(SearchLicensesRequest request) Returns list of licenses that satisfy the request.
BackOfficeLicense	setTotalConsumptions(Long licenseId, int totalConsumptions) Sets the total consumptions on the license to the desired number.
boolean	setUserPassword(int userId, String newPassword) Sets the license users password to a new value.
void	unassignUser(Long licenseId, int licenseUserId) Unassigns a user from a single license if requesting manager has access permissions to it.
BackOfficeLicense	updateLicense(Long licenseId, UpdateLicenseRequest request) Updates the license with the provided id.

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseService

public LicenseService(ManagementConfiguration configuration)

LicenseService has to be built using the ManagementConfiguration object.

Parameters:

configuration - build via the builder pattern

Method Detail

licenseCustomFieldsService

public LicenseCustomFieldsService licenseCustomFieldsService()

Returns service for license custom fields.

Returns:

service for license custom fields

deviceVariablesService

public DeviceVariablesService deviceVariablesService()

Returns service for device variables.

Returns:

service for device variables

searchLicenses

public SearchResult<BackOfficeLicense> searchLicenses(SearchLicensesRequest request)
                                               throws com.licensespring.model.exceptions.LicenseSpringException

Returns list of licenses that satisfy the request.

Parameters:

request - search request that can be made using the builder method

Returns:

paginated result that contains list of licenses

Throws:

com.licensespring.model.exceptions.LicenseSpringException

disableAllLicenses

public void disableAllLicenses(Long[] licenseIds)
                        throws com.licensespring.model.exceptions.LicenseSpringException

Disables licenses in bulk. Sets fields to active=false, time_disabled=now, enabled=false, disabled_user=request.user, device_active=false.

Parameters:

licenseIds - string array that contains all license ids that need to be disabled

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getLicense

public BackOfficeLicense getLicense(Long licenseId)
                             throws com.licensespring.model.exceptions.LicenseSpringException

Retrieves license data.

Parameters:

licenseId - id of the license that needs to be fetched, 16 digit number

Returns:

the BackOfficeLicense object that contains detailed information about the license

Throws:

com.licensespring.model.exceptions.LicenseSpringException

updateLicense

public BackOfficeLicense updateLicense(Long licenseId,
                                       UpdateLicenseRequest request)
                                throws com.licensespring.model.exceptions.LicenseSpringException

Updates the license with the provided id.

Parameters:

licenseId - id of the license that needs to be updated, 16 digit number

request - use builder for constructing the object, fill only the fields that you want to update

Returns:

the BackOfficeLicense object that contains detailed information about the updated license.

Throws:

com.licensespring.model.exceptions.LicenseSpringException

patchLicenseFeatures

public BackOfficeLicense patchLicenseFeatures(Long licenseId,
                                              PatchLicenseFeaturesRequest request)
                                       throws com.licensespring.model.exceptions.LicenseSpringException

Patches the license (product) features available. Thread carefully when using this method, posting an empty request will remove all features.

Parameters:

licenseId - id of the license that needs to be updated, 16 digit number

request - use builder for constructing the object, fill all fields to prevent losing features

Returns:

the BackOfficeLicense object that contains detailed information about the updated license

Throws:

com.licensespring.model.exceptions.LicenseSpringException

assignUser

public String assignUser(Long licenseId,
                         AssignUserToLicenseRequest licenseUser)
                  throws com.licensespring.model.exceptions.LicenseSpringException

Assigns the provided user to the license. User can be assigned only to the user-based license.

Parameters:

licenseId - id of the license that needs to be assigned to the user, 16 digit number

licenseUser - AssignedLicenseUser object, contains user data, use builder to construct this object

Returns:

String message

Throws:

com.licensespring.model.exceptions.LicenseSpringException

assignMultipleUsers

public List<MultipleAssignmentResponse> assignMultipleUsers(Long licenseId,
                                                            AssignMultipleUsersRequest request)
                                                     throws com.licensespring.model.exceptions.LicenseSpringException

Assigns multiple users to a single license if requesting manager has access permissions to it.

Parameters:

licenseId - id of the license that needs to be assigned to the user, 16 digit number

request - request containing information about the users and this assignment

Returns:

list of responses, each contains email of the user, indicator if this is a new user, and their password

Throws:

com.licensespring.model.exceptions.LicenseSpringException

unassignUser

public void unassignUser(Long licenseId,
                         int licenseUserId)
                  throws com.licensespring.model.exceptions.LicenseSpringException

Unassigns a user from a single license if requesting manager has access permissions to it.

Parameters:

licenseId - id of the license, 16 digit number

licenseUserId - id of the user that needs to be unassigned

Throws:

com.licensespring.model.exceptions.LicenseSpringException

disableLicense

public void disableLicense(Long licenseId)
                    throws com.licensespring.model.exceptions.LicenseSpringException

Disables the license with provided id. Sets license fields to active=false, time_disabled=now, enabled=false, disabled_user=request.user, device_active=false.

Parameters:

licenseId - id of the license that needs to be disabled, 16 digit number

Throws:

com.licensespring.model.exceptions.LicenseSpringException

resetLicense

public boolean resetLicense(Long licenseId)
                     throws com.licensespring.model.exceptions.LicenseSpringException

Resets the license with the provided id. Sets license fields to active=false, times_activated=0, and all devices to device_active=false.

Parameters:

licenseId - id of the license that needs a reset, 16 digit number

Returns:

true if the license and all devices were reset, false otherwise

Throws:

com.licensespring.model.exceptions.LicenseSpringException

enableLicense

public BackOfficeLicense enableLicense(Long licenseId)
                                throws com.licensespring.model.exceptions.LicenseSpringException

Enables license with the provided id.

Parameters:

licenseId - id of the license that needs to be enabled, 16 digit number

Returns:

the BackOfficeLicense object that contains detailed information about the license

Throws:

com.licensespring.model.exceptions.LicenseSpringException

setTotalConsumptions

public BackOfficeLicense setTotalConsumptions(Long licenseId,
                                              int totalConsumptions)
                                       throws com.licensespring.model.exceptions.LicenseSpringException

Sets the total consumptions on the license to the desired number. As of now, it is not possible to set total consumptions to a negative number.

Parameters:

licenseId - id of the license that needs consumptions update, 16 digit number

totalConsumptions - number of consumptions to set the field total_consumptions to

Returns:

the BackOfficeLicense object that contains detailed information about updated the license

Throws:

com.licensespring.model.exceptions.LicenseSpringException

resetTotalConsumptions

public BackOfficeLicense resetTotalConsumptions(Long licenseId)
                                         throws com.licensespring.model.exceptions.LicenseSpringException

Resets the total consumptions on the license to zero.

Parameters:

licenseId - id of the license that needs consumptions reset, 16 digit number

Returns:

the BackOfficeLicense object that contains detailed information about updated the license.

Throws:

com.licensespring.model.exceptions.LicenseSpringException

searchDevices

public SearchResult<Device> searchDevices(SearchDevicesRequest request)
                                   throws com.licensespring.model.exceptions.LicenseSpringException

Returns a list of devices that satisfy the request.

Parameters:

request - search request that can be made using the builder

Returns:

paginated result that contains list of devices

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getDevice

public Device getDevice(Long id)
                 throws com.licensespring.model.exceptions.LicenseSpringException

Gets the device data.

Parameters:

id - id of the device, 16 digit number

Returns:

Device object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

resetDevice

public boolean resetDevice(Long id)
                    throws com.licensespring.model.exceptions.LicenseSpringException

Resets the device.

Parameters:

id - id of the device that needs a reset

Returns:

true if action was successful

Throws:

com.licensespring.model.exceptions.LicenseSpringException

blacklistDevice

public boolean blacklistDevice(Long id)
                        throws com.licensespring.model.exceptions.LicenseSpringException

Blacklists the device.

Parameters:

id - id of the device that needs to be blacklisted

Returns:

true if action was successful

Throws:

com.licensespring.model.exceptions.LicenseSpringException

paginateThroughAllLicenses

public List<BackOfficeLicense> paginateThroughAllLicenses(SearchLicensesRequest request)
                                                   throws com.licensespring.model.exceptions.LicenseSpringException

Goes through all pages of the search licenses response and returns a list with all possible licenses that satisfy the request. Makes multiple requests to the server until all results have been found. Use searchLicenses(SearchLicensesRequest) in order to get results per page.

Parameters:

request - can be made with builder, contains query fields

Returns:

list of all licenses that satisfy the request

Throws:

com.licensespring.model.exceptions.LicenseSpringException

paginateThroughAllDevices

public List<Device> paginateThroughAllDevices(SearchDevicesRequest request)
                                       throws com.licensespring.model.exceptions.LicenseSpringException

Goes through all pages of the search devices response and returns a list with all possible devices that satisfy the request. Makes multiple requests to the server until all results have been found. Use searchDevices(SearchDevicesRequest) in order to get results per page.

Parameters:

request - can be made with builder, contains query fields

Returns:

list of all devices that satisfy the request

Throws:

com.licensespring.model.exceptions.LicenseSpringException

setUserPassword

public boolean setUserPassword(int userId,
                               String newPassword)
                        throws com.licensespring.model.exceptions.LicenseSpringException

Sets the license users password to a new value.

Parameters:

userId - id of the license user

newPassword - new password

Returns:

true if the password was set, false otherwise

Throws:

com.licensespring.model.exceptions.LicenseSpringException