public class AsmServicesWs extends Object
Modifier and Type | Class and Description |
---|---|
static class |
AsmServicesWs.AsmDeviceInfo
Container-object, which holds the information of the device.
|
static class |
AsmServicesWs.AsmDeviceStateInfo
Container-object, which holds the information of the state of the device.
|
static class |
AsmServicesWs.ASMServicesWSFault
Own exception class of the SOAP interface ASMServicesWS.
|
static class |
AsmServicesWs.CancelResult
Return values of the method
and
{@link AsmServicesWs#cancelTransaction(int)} |
static class |
AsmServicesWs.CertTypeCategory
Categories of certificates, which shall be used (for example for search operation).
|
static class |
AsmServicesWs.DeviceEvents
The current event of a device.
|
static class |
AsmServicesWs.ErrorCodes
Class with all possible error codes listed.
|
static class |
AsmServicesWs.LoginResult
Container-object, which holds the information of the login result, including a return code.
|
static class |
AsmServicesWs.LoginResultCode
Return codes of the
login(String) method. |
static class |
AsmServicesWs.NodeDeviceEvent
Container object, which holds data for all device events of a node.
|
static class |
AsmServicesWs.NodeTransactionEvent
Deprecated.
|
static class |
AsmServicesWs.OfflineResultCode
Return values of the methods
verifyOfflineOtp(OfflineOtpParam)
and verifyOfflineSecureSequence(OfflineSecureSequenceParam) |
static class |
AsmServicesWs.TransactionInput
Deprecated.
|
static class |
AsmServicesWs.TransactionResult
Container-object, which holds the result data of a transaction.
|
static class |
AsmServicesWs.TransactionResultCode
Return codes of a transaction.
|
Modifier and Type | Field and Description |
---|---|
static String |
ERROR_VERIFY_PIN |
static int |
RANDOM_NUMBER_LENGTH |
Constructor and Description |
---|
AsmServicesWs() |
Modifier and Type | Method and Description |
---|---|
AsmServicesWs.CancelResult |
cancelTransaction(int deviceId)
Deprecated.
use method
#cancelTransactionEx2(int, String)
Cancels the current transaction for the given device Id. The device might be offline. |
AsmServicesWs.CancelResult |
cancelTransactionEx(int deviceId,
String reportDetails)
Deprecated.
use method
cancelTransactionEx2(TransactionFilter, String)
Cancels the current transaction for the given device Id. The device might be offline. |
List<CancelResultEx2> |
cancelTransactionEx2(TransactionFilter transactionFilter,
String reportDetails)
Cancels all transactions which match the filter.
|
AsmServicesWs.ErrorCodes |
changePin(String userId,
String currentPin,
String newPin)
Note: This feature is only available, if the setting "Use Same Pin For All Devices" is enabled
in the "Advanced Settings" of ASM.
|
static List<Integer> |
convertToIntegerList(List<com.kobil.ssms.kernel.logic.jgroups.data.NodeResponse<int[]>> nodeResponses)
Converts the data part of all
NodeResponse objects to a list of Integer objects. |
AsmServicesWs.ErrorCodes |
displayMessage(int certHandle,
String displayData,
int messageType)
Deprecated.
use method
displayMessageEx(DisplayMessageParam) |
AsmServicesWs.ErrorCodes |
displayMessageEx(DisplayMessageParam displayMessageParam)
Asynchronous method, which sends a message to client.
|
byte[] |
getCertificate(int certHandle)
Returns the certificate (in DER format) of a device.
|
com.kobil.ssms.asm.logic.statistics.response.CountInfo |
getCountDevice()
Retrieves statistics details regarding
|
AsmServicesWs.AsmDeviceInfo |
getDeviceInfo(int certHandle)
Retrieve information about a device from the database.
|
List<DeviceProperty> |
getDeviceProperties(int deviceId)
Deprecated.
Use
#getProperties(AstPropertyParam) |
DeviceProperty |
getDeviceProperty(int deviceId,
String key)
Deprecated.
|
List<AsmServicesWs.AsmDeviceStateInfo> |
getDevices(String userId,
AsmServicesWs.CertTypeCategory certTypeCategory,
boolean onlyOnlineCerts)
Retrieve information about devices of the given user including their current state from the database.
|
AsmServicesWs.AsmDeviceStateInfo |
getDeviceStateInfo(int deviceID)
Retrieve information about the state of a device.
|
com.kobil.ssms.asm.logic.statistics.response.DeviceInfo |
getDeviceWithPage(String userId,
Integer currentPageNo,
Integer elementsPerPage)
Returns a DeviceInfo object that contains the amount of all AsmDevice screen at management GUI part
and nextPage is exist or not according to given page number.
|
List<com.kobil.ssms.kernel.presentation.b2b.SsmsNode> |
getNodes()
Deprecated.
Use the method with the same name but from the kernel SOAP interface (class
com.kobil.ssms.kernel.presentation.b2b.KernelServicesWs ) |
List<AstProperty> |
getProperties(AstPropertyParam astPropertyParam,
com.kobil.ssms.kernel.presentation.b2b.RangeInput rangeInput,
com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput,
Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination)
Gets a list of
AstProperty objects of a device, a user or a group. |
AstProperty |
getProperty(AstPropertyParam propertyParam)
Gets a
AstProperty object of a device, a user or a group. |
AsmServicesWs.TransactionResult |
getTransactionResult(int certHandle)
Deprecated.
use method
getTransactionResultEx(TransactionFilter) |
List<AsmServicesWs.TransactionResult> |
getTransactionResultEx(TransactionFilter transactionFilter)
Retrieve the transaction result of a certain transaction ID, all transaction results of a device or of a user.
|
int[] |
getUserCertificates(String userId,
AsmServicesWs.CertTypeCategory certTypeCategory,
boolean onlyOnlineCerts)
Deprecated.
This method is deprecated, use
getDevices(String, CertTypeCategory, boolean) . |
AsmServicesWs.LoginResult |
login(String otp)
Login to the SSMS server using a one-time-password (OTP).
|
AsmServicesWs.LoginResult |
loginWithCertificate(int certHandle)
Deprecated.
Portal does not need to call this method anymore before it can use any other method. The method will remain
only for backward compatibility.
|
void |
logOffDevice(int certHandle)
Logs off this device/certificate from SSMS server.
|
List<Integer> |
logOffUser(String userId)
Logs off all active devices of a user.
|
PinVerifyResult |
migrateDevicePinToUserPin(String deviceId,
String devicePin,
String userPin)
Set the pin of an user.
|
OfflineReSyncResult |
offlineReSync(OfflineReSyncParam offlineReSyncParam)
Try to re-synchronize a software device of the given user.
|
List<AsmServicesWs.NodeDeviceEvent> |
pollAllDeviceEvents()
Retrieve a list of
AsmServicesWs.NodeDeviceEvent objects that contain information about all device events. |
List<AsmServicesWs.NodeTransactionEvent> |
pollAllTransactionEvents()
Deprecated.
|
List<AsmServicesWs.NodeDeviceEvent> |
pollDeviceEvents(PollDeviceEventsParam pollDeviceEventsParam)
Retrieve a list of
AsmServicesWs.NodeDeviceEvent objects that contain information about those device events, which are specified by the filters in PollDeviceEventsParam. |
int[] |
pollTransactionResult()
Deprecated.
|
boolean |
removeDeviceProperty(int deviceId,
String key)
Deprecated.
Use
removeProperty(AstProperty) instead. |
boolean |
removeDevicePropertyEx(DeviceProperty deviceProperty)
Deprecated.
Use
removeProperty(AstProperty) instead. |
void |
removeProperty(AstProperty property)
Removes a property of a device, a user or a group.
|
String |
requestLoginNonce(String portalSessionId)
Generates a random, 32 digit number, encodes it base64 and stores it along with the portalSessionId as key in the SSMS database.
|
List<TransactionData> |
retrieveTransactionData(String userId)
########### IMPORTANT NOTE ###########
This method is for testing purposes only!
|
List<Integer> |
searchDevicePropertyValues(String key,
byte[] value)
Search all
DeviceProperty objects matching to the given key / value pair and retrieve a list of corresponding device Id's. |
void |
sendPushNotification(PushNotificationParam pushNotificationParam)
Send a push notification to a specific device or to all devices of the given user (For detailed
information see
PushNotificationParam ). |
void |
setDeviceProperty(DeviceProperty deviceProperty)
Deprecated.
|
void |
setProperty(AstProperty property)
Sets a property to a device, to a user or to a group.
|
AsmServicesWs.ErrorCodes |
startTransaction(AsmServicesWs.TransactionInput transactionInput)
Deprecated.
use method
startTransactionEx(TransactionParam) |
AsmServicesWs.ErrorCodes |
startTransactionEx(TransactionParam transactionParam)
Asynchronous method, which launches a 'transaction' and resolves the template with the given values.
|
AsmServicesWs.ErrorCodes |
startTransactionForUser(TransactionParam transactionParam)
Asynchronous method, which launches a 'transaction' and resolves the template with the given values.
|
OfflineOtpResult |
verifyOfflineOtp(OfflineOtpParam offlineOtpParam)
Verify an OTP (created by a software device).
|
OfflineSecureSequenceResultEx |
verifyOfflineSecureSequence(OfflineSecureSequenceParam offlineSecureSequenceParam)
Verify a SecureSequence.
|
PinVerifyResult |
verifyPin(String userId,
String pin)
Verifies the validity of the PIN for a user.
|
public static final String ERROR_VERIFY_PIN
public static final int RANDOM_NUMBER_LENGTH
public AsmServicesWs.LoginResult login(String otp) throws AsmServicesWs.ASMServicesWSFault
otp
- The OTP of login.AsmServicesWs.LoginResult
contains the AsmServicesWs.LoginResultCode.SOFTWARE_CERT_MAPPED_TO_USER
or
AsmServicesWs.LoginResultCode.HARDWARE_CERT_MAPPED_TO_USER
, the device ID (named "certHandle"), the ID of the assigned user,
the category of device (software or hardware, see AsmServicesWs.LoginResult.isSoftwareCertificate()
)
and the id of the node the device is connected to. AsmServicesWs.LoginResultCode
for a list of possible errors.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.OTP_INVALID
if the passed OTP is null or empty. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.@Deprecated public AsmServicesWs.LoginResult loginWithCertificate(int certHandle) throws AsmServicesWs.ASMServicesWSFault
certHandle
- Primary key of the certificate in the database.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
A parameter is invalid. See details of this error in the exception message. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if database access fails. or if the device or certificate associated to the
session is not in database.@Deprecated public AsmServicesWs.ErrorCodes displayMessage(int certHandle, String displayData, int messageType) throws AsmServicesWs.ASMServicesWSFault
displayMessageEx(DisplayMessageParam)
certHandle
- Primary Key of the certificate in the database.displayData
- This message will be displayed to the user.messageType
- 0=information; 1=warning; 2=error;displayMessageEx(DisplayMessageParam)
AsmServicesWs.ASMServicesWSFault
- see Throws of displayMessageEx(DisplayMessageParam)
public AsmServicesWs.ErrorCodes displayMessageEx(DisplayMessageParam displayMessageParam) throws AsmServicesWs.ASMServicesWSFault
displayMessageParam
- See class DisplayMessageParam
for more information. AsmServicesWs.ErrorCodes.OK
The message was sent to client. AsmServicesWs.ErrorCodes.OK_IN_WAITING_LIST
AsmServicesWs.ErrorCodes.NO_CERT_FOR_CERTHANDLE
AsmServicesWs.ErrorCodes.CERT_IS_LOCKED
The certificate is locked. AsmServicesWs.ErrorCodes.NO_USER_FOR_CERTHANDLE
if the certificate, matching to the given device Id, is not assigned to a user. AsmServicesWs.ErrorCodes.USER_IS_LOCKED
The assigned user is locked. AsmServicesWs.ErrorCodes.CERT_IS_OFFLINE
The device is offline and deviceGoOnlineTimeout is set to 0. AsmServicesWs.ErrorCodes.SEND_FAILED
Sending data to client failed. AsmServicesWs.ErrorCodes.TRANSACTION_TEMPLATE_ERROR
An error occurred while resolving the template. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal occurred.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_MISSING
A required parameter is missing. See details of this error in the exception message.AsmServicesWs.ErrorCodes.PARAMETER_INVALID
A parameter is invalid. See details of this error in the exception message.AsmServicesWs.ErrorCodes.LANGUAGE_CODE_INVALID
If a provided locale does not conform ISO standard for 2 chars language strings.AsmServicesWs.ErrorCodes.GENERAL_ERROR
In case of an internal error.@Deprecated public AsmServicesWs.ErrorCodes startTransaction(AsmServicesWs.TransactionInput transactionInput) throws AsmServicesWs.ASMServicesWSFault
startTransactionEx(TransactionParam)
transactionInput
- Container object, which holds the data required for a transaction (see
AsmServicesWs.TransactionInput
).startTransactionEx(TransactionParam)
AsmServicesWs.ASMServicesWSFault
- see Throws of startTransactionEx(TransactionParam)
public AsmServicesWs.ErrorCodes startTransactionEx(TransactionParam transactionParam) throws AsmServicesWs.ASMServicesWSFault
startTransaction(TransactionInput)
and should be used solely.
The method takes care of whether there is a template that has to be resolved or not.
pollDeviceEvents(PollDeviceEventsParam)
). Then the transaction result can be fetched (see
getTransactionResultEx(TransactionFilter)
).
transactionParam
- Container object, which holds the data required for a transaction (see TransactionParam
). AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
A parameter is invalid. See details of this error in the exception message.AsmServicesWs.ErrorCodes.LANGUAGE_CODE_INVALID
If a provided locale does not conform ISO standard for 2 chars language strings.AsmServicesWs.ErrorCodes.GENERAL_ERROR
In case of an internal error.public AsmServicesWs.ErrorCodes startTransactionForUser(TransactionParam transactionParam) throws AsmServicesWs.ASMServicesWSFault
pollDeviceEvents(PollDeviceEventsParam)
). Then the transaction result can be fetched (see
getTransactionResultEx(TransactionFilter)
).
transactionParam
- Container object, which holds the data required for a transaction (see TransactionParam
). AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
A parameter is invalid. See details of this error in the exception message.AsmServicesWs.ErrorCodes.LANGUAGE_CODE_INVALID
If a provided locale does not conform ISO standard for 2 chars language strings.AsmServicesWs.ErrorCodes.GENERAL_ERROR
In case of an internal error.@Deprecated public AsmServicesWs.CancelResult cancelTransaction(int deviceId) throws AsmServicesWs.ASMServicesWSFault
#cancelTransactionEx2(int, String)
Cancels the current transaction for the given device Id. The device might be offline.deviceId
- Primary key of the certificate in the database.cancelTransactionEx(int, String)
AsmServicesWs.ASMServicesWSFault
- see Throws of cancelTransactionEx(int, String)
@Deprecated public AsmServicesWs.CancelResult cancelTransactionEx(int deviceId, String reportDetails) throws AsmServicesWs.ASMServicesWSFault
cancelTransactionEx2(TransactionFilter, String)
Cancels the current transaction for the given device Id. The device might be offline.deviceId
- the unique deviceId.reportDetails
- If set, this string will be written to the report as 'details'. If null, SSMS will possibly write some details.AsmServicesWs.CancelResult
ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
A parameter is invalid. See details of this error in the exception message.AsmServicesWs.ErrorCodes.GENERAL_ERROR
in case of an internal error.AsmServicesWs.ASMServicesWSFault
public List<CancelResultEx2> cancelTransactionEx2(TransactionFilter transactionFilter, String reportDetails) throws AsmServicesWs.ASMServicesWSFault
transactionFilter
- The TransactionFilter
.
If the device id is set, all transactions of this device are canceled.
If the user id is set, all transactions of this user are canceled.
If the user id and the transaction id are set, exactly this transaction is canceled.reportDetails
- If set, this string will be written to the report as 'details'. If null, SSMS will possibly write some details.CancelResultEx2
ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
One ore more parameters of the given TransactionFilter
are invalid.
See details of this error in the exception message.AsmServicesWs.ErrorCodes.USERID_INVALID
in case a none existing user is set into the filter
AsmServicesWs.ErrorCodes.GENERAL_ERROR
in case of an internal error.AsmServicesWs.ASMServicesWSFault
@Deprecated public int[] pollTransactionResult() throws AsmServicesWs.ASMServicesWSFault
pollAllTransactionEvents()
getTransactionResultEx(TransactionFilter)
must be
invoked.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
in case of an internal error.@Deprecated public AsmServicesWs.TransactionResult getTransactionResult(int certHandle) throws AsmServicesWs.ASMServicesWSFault
getTransactionResultEx(TransactionFilter)
certHandle
- The Primary key of the certificate in the database.AsmServicesWs.TransactionResult
AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the device Id is less than 1. AsmServicesWs.ErrorCodes.NO_TRANSACTION_RESULT
if no transaction result is available for the given device Id. AsmServicesWs.ErrorCodes.NO_SESSION
if no session is associated with this device Id. AsmServicesWs.ErrorCodes.GENERAL_ERROR
in case of an internal error.public List<TransactionData> retrieveTransactionData(String userId) throws AsmServicesWs.ASMServicesWSFault
userId
- The user ID of whom transactions shall be searched.TransactionData
Selected information on the user's data.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.USERID_INVALID
if the user ID is empty or the regarding user does not exist. AsmServicesWs.ErrorCodes.GENERAL_ERROR
in case of an internal error.public List<AsmServicesWs.TransactionResult> getTransactionResultEx(TransactionFilter transactionFilter) throws AsmServicesWs.ASMServicesWSFault
transactionFilter
- The TransactionFilter
. AsmServicesWs.TransactionResult
s according to the given TransactionFilter
.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
One ore more parameters of the given TransactionFilter
are invalid.
See details of this error in the exception message.AsmServicesWs.ErrorCodes.GENERAL_ERROR
in case of an internal error.public void logOffDevice(int certHandle) throws AsmServicesWs.ASMServicesWSFault
certHandle
- The device ID, which shall be logged off.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the device Id is less than 1. AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device ID exists. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<Integer> logOffUser(String userId) throws AsmServicesWs.ASMServicesWSFault
userId
- The ID user whose device shall be logged off.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_MISSING
if the userId is null or empty. AsmServicesWs.ErrorCodes.USER_NOT_FOUND
if user does not exist AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public int[] getUserCertificates(String userId, AsmServicesWs.CertTypeCategory certTypeCategory, boolean onlyOnlineCerts) throws AsmServicesWs.ASMServicesWSFault
getDevices(String, CertTypeCategory, boolean)
.userId
- The primary key of the user in the database, whose certificates shall be returned.certTypeCategory
- Which category of certificates shall be searched: hardware or software or both.onlyOnlineCerts
- true: only certificates, which are online, are returned. false: all found certificates are returned.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_MISSING
if userId is null or empty. AsmServicesWs.ErrorCodes.PARAMETER_MISSING
if certTypeCategory is null. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if database access fails. AsmServicesWs.ErrorCodes.USER_NOT_FOUND
if user does not exist. AsmServicesWs.ErrorCodes.USER_IS_LOCKED
if user is locked. AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_USERID
if no device for the specified user could be found.public AsmServicesWs.AsmDeviceInfo getDeviceInfo(int certHandle) throws AsmServicesWs.ASMServicesWSFault
certHandle
- The ID of the device.AsmServicesWs.AsmDeviceInfo
object, matching to the device Id.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the device Id is less than 1.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exists.AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<AsmServicesWs.AsmDeviceStateInfo> getDevices(String userId, AsmServicesWs.CertTypeCategory certTypeCategory, boolean onlyOnlineCerts) throws AsmServicesWs.ASMServicesWSFault
userId
- The primary key of the user in the database.certTypeCategory
- The category of the certificate (HARDWARE, SOFTWARE or BOTH).onlyOnlineCerts
- If the value is true
, only devices which are currently online will be returned.false
, all registered devices in the database are shown. AsmServicesWs.AsmDeviceStateInfo
.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_MISSING
if userId is null or empty. AsmServicesWs.ErrorCodes.PARAMETER_MISSING
if certTypeCategory is null. AsmServicesWs.ErrorCodes.USER_NOT_FOUND
if user does not exist. AsmServicesWs.ErrorCodes.USER_IS_LOCKED
if user is locked. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] getCertificate(int certHandle) throws AsmServicesWs.ASMServicesWSFault
certHandle
- The ID of the device.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the device Id is less than 1.AsmServicesWs.ErrorCodes.NO_CERT_FOR_CERTHANDLE
if the certificate could not be found for the given device Id. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public List<com.kobil.ssms.kernel.presentation.b2b.SsmsNode> getNodes() throws AsmServicesWs.ASMServicesWSFault
com.kobil.ssms.kernel.presentation.b2b.KernelServicesWs
)SsmsNode
s.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public AsmServicesWs.AsmDeviceStateInfo getDeviceStateInfo(int deviceID) throws AsmServicesWs.ASMServicesWSFault
deviceID
- The ID of the device.AsmServicesWs.AsmDeviceStateInfo
object, matching the given device Id.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than 1. AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exist. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs. @Deprecated public List<AsmServicesWs.NodeTransactionEvent> pollAllTransactionEvents() throws AsmServicesWs.ASMServicesWSFault
pollAllDeviceEvents()
AsmServicesWs.NodeTransactionEvent
objects that contain information about all pending transactions.AsmServicesWs.NodeTransactionEvent
objects that contain information about all pending transactions.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<AsmServicesWs.NodeDeviceEvent> pollDeviceEvents(PollDeviceEventsParam pollDeviceEventsParam) throws AsmServicesWs.ASMServicesWSFault
AsmServicesWs.NodeDeviceEvent
objects that contain information about those device events, which are specified by the filters in PollDeviceEventsParam.pollDeviceEventsParam
- Container class, which holds a list of filter classes (e.g.) (see PollDeviceEventsParam
)AsmServicesWs.NodeDeviceEvent
objects that contain information about the requested device events.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_MISSING
if PollDeviceEventsParam is null or no filters are specified.
AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<AsmServicesWs.NodeDeviceEvent> pollAllDeviceEvents() throws AsmServicesWs.ASMServicesWSFault
AsmServicesWs.NodeDeviceEvent
objects that contain information about all device events.AsmServicesWs.NodeDeviceEvent
objects that contain information about all device events.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public DeviceProperty getDeviceProperty(int deviceId, String key) throws AsmServicesWs.ASMServicesWSFault
getProperty(AstPropertyParam)
DeviceProperty
, matching to the given device Id and the given key.deviceId
- the unique device Idkey
- the key of the device propertyDeviceProperty
, matching to the given device Id and the given key.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of range.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exist.AsmServicesWs.ErrorCodes.REQUESTED_DEVICE_PROPERTY_NOT_FOUND
if no matching DeviceProperty
could be found.public List<DeviceProperty> getDeviceProperties(int deviceId) throws AsmServicesWs.ASMServicesWSFault
#getProperties(AstPropertyParam)
DeviceProperty
objects, matching to the given device Id.deviceId
- the unique device IdDeviceProperty
objects, matching to the given device Id.
An empty list, if no matching certificate could be found.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exist.public List<AstProperty> getProperties(AstPropertyParam astPropertyParam, com.kobil.ssms.kernel.presentation.b2b.RangeInput rangeInput, com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput, Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination) throws AsmServicesWs.ASMServicesWSFault
AstProperty
objects of a device, a user or a group.
astPropertyParam
- The AstPropertyParam
parameter which defines the property to be searched.rangeInput
- - RangeInput object with information about range with "from" and "limit" values orderInput
- - OrderInput object with information about sorting field name and direction pagination
- - Holder for Pagination with information about range and order.
range is an object with "from", "limit" and "moreExist" values AstProperty
if properties were found.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the astPropertyParam is null.AsmServicesWs.ErrorCodes.ID_TYPE_DOES_NOT_MATCH_OWNER
if the id type does not match the owner.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is out of range.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.USER_NOT_FOUND
if the user, which property is searched, does not exist.AsmServicesWs.ErrorCodes.GROUP_DOES_NOT_EXIST
if the group, which property is searched, does not exist.AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exist.AsmServicesWs.ErrorCodes.REQUESTED_PROPERTY_NOT_FOUND
if no matching AstProperty
could be found.AsmServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
if the owner type is null or unknown.AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void setDeviceProperty(DeviceProperty deviceProperty) throws AsmServicesWs.ASMServicesWSFault
setProperty(AstProperty)
DeviceProperty
object to database, or update an existing DeviceProperty
object.
Key values in DeviceProperty
starting with "KS." are reserved for SSMS/ASM internal use.
Unregistered values will not be handled and result as a WARN in the logs.deviceProperty
- a DeviceProperty
objectAsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.AsmServicesWs.ErrorCodes.DEVICE_PROPERTY_INVALID
if the DeviceProperty
parameter is null.
AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of range.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.FLAG_INVALID
if the flag is out of range.AsmServicesWs.ErrorCodes.TYPE_INVALID
if the type is out of range.AsmServicesWs.ErrorCodes.BINARY_VALUE_INVALID
if the binary value is null or out of range.AsmServicesWs.ErrorCodes.ID_TYPE_DOES_NOT_MATCH_OWNER
if the id type does not match the owner.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exist.AsmServicesWs.ErrorCodes.PROPERTY_READ_ONLY
if the property flag READ_ONLY (0x20) is set, it is not possible to update an existing device property.AsmServicesWs.ErrorCodes.UNIQUE_PROPERTY_ALREADY_EXIST
if the flag UNIQUE_TO_USER (0x08) is set and the current user has already a device assigned
with a device property that contains the same key and the same binary value.AsmServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
if the owner type is null or unknown.public List<Integer> searchDevicePropertyValues(String key, byte[] value) throws AsmServicesWs.ASMServicesWSFault
DeviceProperty
objects matching to the given key / value pair and retrieve a list of corresponding device Id's.
key
- the key of the device propertyvalue
- the value of the device propertyAsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of range.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.BINARY_VALUE_INVALID
if the binary value is null or empty.public String requestLoginNonce(String portalSessionId) throws AsmServicesWs.ASMServicesWSFault
portalSessionId
- The portalSessionId related to the login nonce.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_MISSING
if portalSessionId is null or empty.AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public AsmServicesWs.ErrorCodes changePin(String userId, String currentPin, String newPin) throws AsmServicesWs.ASMServicesWSFault
userId
- The ID of the user.currentPin
- The current PIN.newPin
- The new PIN.AsmServicesWs.ErrorCodes.OK
if successful AsmServicesWs.ErrorCodes.USERID_INVALID
if the user does not exist.AsmServicesWs.ErrorCodes.PIN_NOT_MINIMUM_LENGTH
if the PIN does not have the minimum length.AsmServicesWs.ErrorCodes.NO_PIN_SET
if no PIN was set for this userIdAsmServicesWs.ErrorCodes.WRONG_PIN
if the current PIN was wrongAsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.GENERAL_ERROR
in case of an internal error.AsmServicesWs.ErrorCodes.PARAMETER_INVALID
a parameter is invalid (e.g. userId is null).public OfflineOtpResult verifyOfflineOtp(OfflineOtpParam offlineOtpParam) throws AsmServicesWs.ASMServicesWSFault
offlineOtpParam
- An OfflineOtpParam
object, holding all necessary data (OfflineOtpParam.userId
, OfflineOtpParam.otp
, OfflineOtpParam.sessionId
, OfflineOtpParam.challenge
) needed for a verification.OfflineOtpResult
object, holding the result data of the verification.
AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
AsmServicesWs.ErrorCodes.NO_SESSIONID_FOR_NONCE
no nonce is available for the given sessionId. AsmServicesWs.ErrorCodes.USER_INVALID
the given user does not exist. AsmServicesWs.ErrorCodes.USER_IS_LOCKED
the given user is locked. AsmServicesWs.ErrorCodes.OTP_INVALID
if the OTP is null, empty, has a wrong size or contains invalid characters. AsmServicesWs.ErrorCodes.GENERAL_ERROR
an internal error occurred. public OfflineSecureSequenceResultEx verifyOfflineSecureSequence(OfflineSecureSequenceParam offlineSecureSequenceParam) throws AsmServicesWs.ASMServicesWSFault
offlineSecureSequenceParam
- An OfflineSecureSequenceParam
object, holding data: OfflineSecureSequenceParam.secureSequence
and the optional OfflineSecureSequenceParam.userId
.OfflineSecureSequenceResultEx
object, holding the result data of the verification (note: older client versions are aware of OfflineSecureSequenceResult). Result codes:AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
no device exists for the given deviceId. AsmServicesWs.ErrorCodes.USER_IS_LOCKED
the assigned user is locked. AsmServicesWs.ErrorCodes.CERT_IS_LOCKED
the device with the given deviceId is locked. AsmServicesWs.ErrorCodes.GENERAL_ERROR
another error occurred. public OfflineReSyncResult offlineReSync(OfflineReSyncParam offlineReSyncParam) throws AsmServicesWs.ASMServicesWSFault
offlineReSyncParam
- An OfflineReSyncParam
object, holding all necessary data needed for a re-synchronization.OfflineReSyncResult
object, holding the result of the re-synchronization.
AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.OFFLINE_RE_SYNC_PARAM_INVALID
if the parameter is null. AsmServicesWs.ErrorCodes.USERID_INVALID
if the userId is null or empty or if the user does not exist. AsmServicesWs.ErrorCodes.OTP_INVALID
if the OTP is null, empty, has a wrong size or contains invalid characters. AsmServicesWs.ErrorCodes.ATC_INVALID
if the ATC is out of range. AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if both optional values (SessionId and Challenge) are set. AsmServicesWs.ErrorCodes.NO_SESSIONID_FOR_NONCE
if no nonce is available for the given sessionId. AsmServicesWs.ErrorCodes.USER_IS_LOCKED
if the assigned user is locked. AsmServicesWs.ErrorCodes.GENERAL_ERROR
another error occurred. public void sendPushNotification(PushNotificationParam pushNotificationParam) throws AsmServicesWs.ASMServicesWSFault
PushNotificationParam
). pushNotificationParam
- A PushNotificationParam
containing all information to send a push notification.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PUSH_NOTIFICATION_PARAM_INVALID
if the pushNotificationParam is null. AsmServicesWs.ErrorCodes.PUSH_NOTIFICATION_MESSAGE_INVALID
if pushNotificationPayload contains invalid key-value-pairs or if both pushNotificationMessage and pushNotificationPayload are null or empty. AsmServicesWs.ErrorCodes.PUSH_NOTIFICATION_NO_DEVICE_MATCH
No matching devices for given push notification filter. AsmServicesWs.ErrorCodes.TEMPLATE_VARIABLES_INVALID
if pushNotificationMessage is null or empty and templateVariables are not null or empty. AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is 0 or less than -1. AsmServicesWs.ErrorCodes.USERID_INVALID
if the device Id is -1 and the user Id is null or empty. AsmServicesWs.ErrorCodes.USER_NOT_FOUND
if the user does not exist. AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exist. AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs. public static List<Integer> convertToIntegerList(List<com.kobil.ssms.kernel.logic.jgroups.data.NodeResponse<int[]>> nodeResponses)
NodeResponse
objects to a list of Integer objects.nodeResponses
- a list of NodeResponse
objects.NodeResponse
objects.public AstProperty getProperty(AstPropertyParam propertyParam) throws AsmServicesWs.ASMServicesWSFault
AstProperty
object of a device, a user or a group.propertyParam
- The AstPropertyParam
parameter which defines the key to be searched.AstProperty
if a property was found.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the propertyParam is null.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of range.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.USER_DOES_NOT_EXIST
if the user, which property is searched, does not exist.AsmServicesWs.ErrorCodes.GROUP_DOES_NOT_EXIST
if the group, which property is searched, does not exist.AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exist.AsmServicesWs.ErrorCodes.REQUESTED_PROPERTY_NOT_FOUND
if no matching AstProperty
could be found.AsmServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
if the owner type is null or unknown.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.NO_ACCESS_TO_PROPERTY
if portal has no access to this property.AsmServicesWs.ErrorCodes.ID_TYPE_DOES_NOT_MATCH_OWNER
if the id type does not match the owner.AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void setProperty(AstProperty property) throws AsmServicesWs.ASMServicesWSFault
property
- The AstProperty
to be set.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PROPERTY_INVALID
if the property is null.AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the id is null or empty.AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of range.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.FLAG_INVALID
if the flag is out of range.AsmServicesWs.ErrorCodes.TYPE_INVALID
if the type is out of range.AsmServicesWs.ErrorCodes.BINARY_VALUE_INVALID
if the binary value is null or out of range.AsmServicesWs.ErrorCodes.ID_TYPE_DOES_NOT_MATCH_OWNER
if the id type does not match the owner.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exist..AsmServicesWs.ErrorCodes.PROPERTY_READ_ONLY
if the property flag READ_ONLY (0x20) is set, it is not possible to update an existing device property.AsmServicesWs.ErrorCodes.UNIQUE_PROPERTY_ALREADY_EXIST
if the flag UNIQUE_TO_USER (0x08) is set and the current user has already a device assigned
with a device property that contains the same key and the same binary value.AsmServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
if the owner type is null or unknown.AsmServicesWs.ErrorCodes.GROUP_DOES_NOT_EXIST
if the name of the group cannot be found in the database.AsmServicesWs.ErrorCodes.USER_DOES_NOT_EXIST
if the user can not be found in the database.AsmServicesWs.ErrorCodes.NO_ACCESS_TO_PROPERTY
if portal has no access to this property (only in case of changing an existing property)AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void removeProperty(AstProperty property) throws AsmServicesWs.ASMServicesWSFault
property
- The AstProperty
to be removed.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PROPERTY_INVALID
if the property is null.AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the id is null or empty.AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of range.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.ID_TYPE_DOES_NOT_MATCH_OWNER
if the id type does not match the owner.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device exist.AsmServicesWs.ErrorCodes.REQUESTED_PROPERTY_NOT_FOUND
if the property was not found.AsmServicesWs.ErrorCodes.PROPERTY_READ_ONLY
if the property flag READ_ONLY (0x20) is set, it is not possible to update an existing device property.AsmServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
if the owner type is null or unknown.AsmServicesWs.ErrorCodes.GROUP_DOES_NOT_EXIST
if the name of the group cannot be found in the database.AsmServicesWs.ErrorCodes.USER_DOES_NOT_EXIST
if the user can not be found in the database.AsmServicesWs.ErrorCodes.NO_ACCESS_TO_PROPERTY
if portal has no access to this property.
AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public boolean removeDeviceProperty(int deviceId, String key) throws AsmServicesWs.ASMServicesWSFault
removeProperty(AstProperty)
instead.DeviceProperty
object, matching to the given device Id and key, from the database.deviceId
- the unique device Idkey
- the key of the device propertytrue
if the device property was removed successfully from the database.false
if the device property does not exist in the database.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the id is null or empty.AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of range.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.ID_TYPE_DOES_NOT_MATCH_OWNER
if the id type does not match the owner.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device exist.AsmServicesWs.ErrorCodes.PROPERTY_READ_ONLY
if the property flag READ_ONLY (0x20) is set, it is not possible to update an existing device property.AsmServicesWs.ErrorCodes.NO_ACCESS_TO_PROPERTY
if portal has no access to this property.
AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public boolean removeDevicePropertyEx(DeviceProperty deviceProperty) throws AsmServicesWs.ASMServicesWSFault
removeProperty(AstProperty)
instead.DeviceProperty
object, matching to the given device Id and key, from the database.deviceProperty
- The device property that will be removed.DeviceProperty.setDeviceId(int)
- the unique device IdDeviceProperty.setKey(String)
- the key of the device propertyDeviceProperty.setReportingDetails(String)
- the optional details that will be written to SSMS reportingtrue
if the device property was removed successfully from the database.false
if the device property does not exist in the database.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.DEVICE_PROPERTY_INVALID
if the deviceProperty is null.AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the id is null or empty.AsmServicesWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one.AsmServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of range.AsmServicesWs.ErrorCodes.INVALID_CHARACTERS
if the property key contains invalid characters.
Only printable ASCII characters (code 32 to 126) are allowed.AsmServicesWs.ErrorCodes.ID_TYPE_DOES_NOT_MATCH_OWNER
if the id type does not match the owner.AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device exist.AsmServicesWs.ErrorCodes.PROPERTY_READ_ONLY
if the property flag READ_ONLY (0x20) is set, it is not possible to update an existing device property.AsmServicesWs.ErrorCodes.NO_ACCESS_TO_PROPERTY
if portal has no access to this property.
AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public PinVerifyResult verifyPin(String userId, String pin) throws AsmServicesWs.ASMServicesWSFault
userId
- The unique user id for the user.pin
- The clear text pin.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.USERID_INVALID
if the userId is null or empty.
AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the pin is null or empty.
AsmServicesWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found.
AsmServicesWs.ErrorCodes.NOT_AN_ASM_USER
if the requested user was found, but is not an asm user.
AsmServicesWs.ErrorCodes.NO_PIN_SET
if no user pin was set (this is only relevant, if ASM AdvancedSetting 'Use Same Pin For All Devices' is active).
ErrorCodes#RETRIES_EXCEEDED
if the user entered a wrong pin too many times.
AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.public com.kobil.ssms.asm.logic.statistics.response.CountInfo getCountDevice()
CountInfo
. Contains:List
of TypeCount
: the amount of all AsmDevice
grouped by client device.List
of ClientOsVersion
: the amount of all AsmDevice
grouped by OS version.List
of StatusCount
: the amount of all AsmDevice
grouped by active status.List
of DeviceCount
: the amount of all AsmDevice
grouped by device types. List
of OsTypeCount
: the amount of all AsmDevice
grouped by client type. List
of RiskCount
: the amount of all AsmDevice
grouped by Client Risks.List
of LockedCount
: the amount of all AsmDevice
grouped by lock state.List
of DeviceVersionCount
: the amount of all AsmDevice
grouped by ASM versions.public com.kobil.ssms.asm.logic.statistics.response.DeviceInfo getDeviceWithPage(String userId, Integer currentPageNo, Integer elementsPerPage) throws com.kobil.ssms.asm.logic.AsmLogicException, AsmServicesWs.ASMServicesWSFault
userId
- An unique user id value for the user.currentPageNo
- A number of the current page.elementsPerPage
- A count of elements to be retrieved.DeviceInfo
which contains:List
<DeviceInfoList
> deviceinfolist : an amount of all AsmDevice screen at management GUI.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_MISSING
if the currentPageNo or elementsPerPage is null or <= 0.com.kobil.ssms.asm.logic.AsmLogicException
- AsmLogicException.ErrorCode.USER_NOT_FOUND
if user is not found in the system by userId.
AsmLogicException.ErrorCode.USER_IS_LOCKED
if the user is locked.
AsmLogicException.ErrorCode.PAGE_DOES_NOT_EXIST
if data does not exist at the currentPageNo.
AsmLogicException.ErrorCode.GENERAL_ERROR
in case of error while interaction with database.<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.asm.ssms.kobil.com/"> <soapenv:Header/> <soapenv:Body> <ws:getDevicewithPage> <!--Optional:--> <userId></userId> <currentPageNo>1</currentPageNo> <elementsPerPage>10</elementsPerPage> </ws:getDevicewithPage> </soapenv:Body> </soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getDevicewithPageResponse xmlns:ns2="http://ws.asm.ssms.kobil.com/"> <return> <deviceinfolist> <device_id>7</device_id> <userLoginId>ARM_USER_1945000001</userLoginId> <device>VIRTUAL_DEVICE</device> <serialNumber>2033464438</serialNumber> <appName>appMassTestOneAppForAll</appName> <appVersion>0.0.1</appVersion> <deviceversion>0.0.0</deviceversion> <clientRisks>011f0283021f0284</clientRisks> <clientDevice>HTC Desire S</clientDevice> <clientOsVersion>6.1 7600</clientOsVersion> <clientTypeName>ANDROID_ARM</clientTypeName> <status>false</status> <lastLoginTime>2020-08-26T11:05:36+03:00</lastLoginTime> <node>NodeA</node> <locked>true</locked> <sdkVersion>1.2.3</sdkVersion> <userID>eQ0RS3</userID> <deviceType>3</deviceType> <deviceTypeName>VIRTUAL_DEVICE</deviceTypeName> <lockReasonKey>This is the reason #1.</lockReasonKey> <issuerDN>CN=asm internal ca 8a15d13d-9c52-40cc-9fad-15d810ed97e5,UID=4aSixGyFtk,O=KOBIL SYSTEMS,C=DE</issuerDN> <userLocked>true</userLocked> <lockedUntilDate>2020-08-26 13:51:17.0</lockedUntilDate> </deviceinfolist> <isnextpageExist>false</isnextpageExist> </return> </ns2:getDevicewithPageResponse> </S:Body> </S:Envelope>
public PinVerifyResult migrateDevicePinToUserPin(String deviceId, String devicePin, String userPin) throws AsmServicesWs.ASMServicesWSFault
deviceId
- The ID of the device.devicePin
- The clear text pin of the device with the provided deviceId.userPin
- The new clear text user pin.AsmServicesWs.ASMServicesWSFault
- AsmServicesWs.ErrorCodes.PARAMETER_INVALID
if the deviceId is null or empty.
AsmServicesWs.ErrorCodes.NO_DEVICE_FOR_CERTHANDLE
if no matching device for the device Id exists.
AsmServicesWs.ErrorCodes.USERID_INVALID
if the user does not exist.
AsmServicesWs.ErrorCodes.USER_PIN_ALREADY_SET
if the user already had a pin.
AsmServicesWs.ErrorCodes.CERT_IS_LOCKED
if device is locked.
AsmServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.Copyright © 2022 KOBIL Systems GmbH. All rights reserved.