public class AsmManagementWs extends Object
Modifier and Type | Class and Description |
---|---|
static class |
AsmManagementWs.ASMManagementWSFault
Own exception class for the ASMManagement SOAP interface.
|
static class |
AsmManagementWs.ErrorCodes
Class with all possible error codes listed.
|
Modifier and Type | Field and Description |
---|---|
static String |
ERROR_MSG_USER_NOT_FOUND |
Constructor and Description |
---|
AsmManagementWs() |
Modifier and Type | Method and Description |
---|---|
boolean |
addActivationCode(String userID,
Calendar activationNotAfter,
String activationCode)
Deprecated.
|
boolean |
addAppBundleRequest(AddBundleRequestParam params) |
void |
addGroup(String groupName)
Adds a group to SSMS.
|
boolean |
addMassReactivationConfiguration(AsmMassReactivationConfigParam asmMassReactivationConfigurationParam)
Add Mass Reactivation configuration.
|
boolean |
addPolicy(PolicyParam policyParam)
Adds a new token policy in SSMS.
|
boolean |
addPushNotificationConfiguration(AsmPushNotificationConfigParam asmPushNotificationConfigurationParam)
Deprecated.
|
boolean |
addPushNotificationConfigurationEx(PushNotificationConfigParam pushNotificationConfigParam)
Add push notification configuration.
|
boolean |
addSigner(SignerParam signerParam)
Adds a new token signer in SSMS.
|
boolean |
addUser(String userID)
Adds a new user to the database.
|
boolean |
addVersion(VersionParam versionParam)
Add APP / FIRMWARE version.
|
void |
assignGroupToUser(String groupName,
String userID)
Assigns a user to a group.
|
void |
assignVersionUpdate(VersionUpdateParam versionUpdateParam)
Assign a version update for a specific version or for all older versions.
|
void |
clearIAMCachedKeys()
This method removes all cached IAM keys from SVC nodes.
|
List<Integer> |
copyPin(int deviceID,
List<Integer> deviceIDs)
Copy the password from one virtual device
deviceID to a list of virtual devices deviceIDs . |
boolean |
createActivationCode(String userID,
Calendar activationNotAfter)
Deprecated.
|
AsmActivationCodeInfo |
createActivationCodeEx(ActivationCodeParam activationCodeParam)
Adds a new activation code to the database.
|
byte[] |
createAppBundle(AppBundleParam appBundleParam)
This method creates an app configuration bundle ZIP file, which contains sdk_config.xml to develop apps
using AST SDK.
|
byte[] |
createCaCertificate(String passPhrase)
This method creates Asm CA Certificate.
|
byte[] |
createUsageReport(String passPhrase,
String sinceDate)
This method create a report for activate devices.
|
byte[] |
createUserCertificate(String certProfile,
String pkcs10B64)
This method creates an X.509 user certificate based on the given certificate profile and provided certificate signing
request (CSR).
|
boolean |
editMassReactivationConfiguration(AsmMassReactivationConfigParam asmMassReactivationConfigurationParam)
Edit Mass Reactivation configuration.
|
void |
editPolicy(EditPolicyParam editPolicyParam)
Edit existing token policy in SSMS.
|
void |
editPushNotificationConfiguration(AsmPushNotificationConfigParam asmPushNotificationConfigurationParam)
Deprecated.
|
void |
editPushNotificationConfigurationEx(PushNotificationConfigParam pushNotificationConfigParam)
+
Edit push notification configuration.
|
void |
editSigner(EditSignerParam editSignerParam)
Edit an existing token signer in SSMS.
|
void |
editVersion(VersionParam versionParam)
Update existing APP / FIRMWARE version.
|
void |
editVersionUpdate(VersionUpdateParam versionUpdateParam)
Modifies the 'mandatory from' date of an existing 'version update'.
|
List<AsmActivationCodeInfo> |
getActivationCodes(String userID,
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)
Returns a list of all activation codes of the given user ID.
|
List<com.kobil.ssms.asm.presentation.jsf.iam.IAMKey> |
getAllIAMCachedKeys()
This method returns whole list of all cached IAM keys from SVC nodes.
|
byte[] |
getCertificate(String issuerDN,
BigInteger serialNumber)
Returns the matching certificate to the given parameters.
|
byte[] |
getCertificateByDeviceId(int deviceID)
Returns the matching certificate.
|
AsmDeviceMgtInfo |
getDeviceMgtInfo(int deviceId)
Retrieve an
AsmDeviceMgtInfo object, containing device information. |
List<AsmDeviceMgtInfo> |
getDevicesForUser(String userID)
Returns a list of all
AsmDeviceMgtInfo , which are assigned to the given user ID. |
List<String> |
getGroups(String filter,
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)
Returns a list of all groups that are matching to the filter.
|
List<AsmMassReactivationConfigParam> |
getMassReactivationConfigurations()
Get mass Reactivation configuration as a list.
|
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.KernelManagementWs ) |
TokenPolicyInfo |
getPolicy(String name)
Get existing token policy.
|
List<AsmPushNotificationConfigParam> |
getPushNotificationConfigurations(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)
Get push notification configuration as a list.
|
ReportingInfo |
getReportingItems(ReportingFilter reportingFilter,
com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput,
Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination)
Returns entries of the ASM reporting.
|
TokenSignerInfo |
getSigner(String name)
Get existing token signer.
|
byte[] |
getSignerCertificate(String name)
Get a certificate (DER encoded) by name of the signer.
|
String |
getStatistic(StatisticTypeInfo statisticTypeInfo,
List<String> statisticParameters)
Retrieve the selected statistic as a CSV string.
|
byte[] |
getTextResources(String language)
Deprecated.
Use the method with the same name but from the kernel SOAP interface (class
com.kobil.ssms.kernel.presentation.b2b.KernelManagementWs ) |
String |
getUserGroup(String userID)
Retrieves the group name to which the given user is assigned to.
|
UserInfo |
getUserInfo(String userId)
Retrieve the
UserInfo object, containing user information. |
List<String> |
getUsers(String filter,
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)
Returns a list of all userIDs that are matching to the given filter.
|
List<VersionParam> |
getVersions(String filter,
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)
Returns a list of all versions that are matching to the given filter.
|
boolean |
lockDevice(String issuerDN,
BigInteger serialNumber,
String lockReason)
Locks a device with the specified lock reason.
|
boolean |
lockDeviceByDeviceId(int deviceID,
String lockReason)
Lock a device (specified by deviceId) with the specified lock reason.
|
boolean |
lockUser(String userID,
String lockReason)
Changes an unlocked user to the state of locked.
|
void |
modifyGroup(String oldGroupName,
String newGroupName,
boolean removeAutoGroup)
Modify Group name and "auto group" flag of the given group.
|
boolean |
removeActivationCode(String userID,
String activationCode)
Removes an activation code from the database.
|
int |
removeAllActivationCodes(String userID)
Removes all activation codes of the given user.
|
boolean |
removeDevice(String issuerDN,
BigInteger serialNumber)
Deprecated.
Use
removeDeviceEx(DeviceParam) instead. |
boolean |
removeDeviceByDeviceId(int deviceID)
Deprecated.
Use
removeDeviceEx(DeviceParam) instead. |
boolean |
removeDeviceEx(DeviceParam deviceParam)
Removes a device from the database.
|
void |
removeGroup(String groupName)
Removes a group from SSMS.
|
void |
removeIAMCachedKeys(List<String> keyIds)
This method removes cached IAM keys from SVC nodes by list of specified keys.
|
boolean |
removeMassReactivationConfiguration(String name)
Remove a mass reactivation by name.
|
boolean |
removePin(String userId)
Note: This feature is only available, if the setting "Use Same Pin For All Devices" is enabled in the
"Advanced Settings" of ASM.
|
boolean |
removePolicy(String name)
Remove a token policy by name.
|
boolean |
removePushNotificationConfiguration(String name)
Add push notification configuration.
|
boolean |
removeSigner(String name)
Remove the token signer by name.
|
boolean |
removeUser(String userID)
Deletes a user from the SSMS database.
|
boolean |
removeVersion(SoftwareTypes softwareType,
String clientType,
String deviceType,
String versionStr,
String appName)
Remove existing APP / FIRMWARE version.
|
boolean |
removeVersionChecksum(SoftwareTypes softwareType,
String clientType,
String deviceType,
String versionStr,
String appName)
Remove the checksum of the APP / FIRMWARE version matching the given parameter.
|
String |
resetPin(String userId)
Note: This feature is only available, if the setting "Use Same Pin For All Devices" is enabled in the
"Advanced Settings" of ASM.
|
boolean |
setPin(String userId,
String pin)
Note: This feature is only available, if the setting "Use Same Pin For All Devices" is enabled in the
"Advanced Settings" of ASM.
|
void |
storeTextResources(String language,
byte[] contents)
Deprecated.
Use the method with the same name but from the kernel SOAP interface (class
com.kobil.ssms.kernel.presentation.b2b.KernelManagementWs ) |
void |
unassignGroupFromUser(String userID)
Unassigns a user from a group.
|
void |
unassignVersionUpdate(VersionUpdateParam versionUpdateParam)
Unassigns a version update for a specific version or for all older versions.
|
boolean |
unlockDevice(String issuerDN,
BigInteger serialNumber)
Unlocks a device.
|
boolean |
unlockDeviceByDeviceId(int deviceID)
Unlocks a device (specified by deviceId).
|
boolean |
unlockUser(String userID)
Changes a locked user to the state of unlocked.
|
public static final String ERROR_MSG_USER_NOT_FOUND
public boolean addUser(String userID) throws AsmManagementWs.ASMManagementWSFault
userID
- A new user ID that does not exist in SSMS yet. Must not be null or empty.true
if the user was added to the databasefalse
if the user already exists.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurspublic boolean removeUser(String userID) throws AsmManagementWs.ASMManagementWSFault
userID
- The user ID of an existing user in SSMS.true
if the user was removed successfully from the databasefalse
if the user does not exist in the databaseAsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurspublic boolean lockUser(String userID, String lockReason) throws AsmManagementWs.ASMManagementWSFault
userID
- The user ID of an existing user in SSMS.lockReason
- The lock reason. It must be one of the currently configured ones.true
if an unlocked user is locked now.false
if the user is already locked.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.LOCK_REASON_INVALID
if the lock reason empty or unknown. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurspublic boolean unlockUser(String userID) throws AsmManagementWs.ASMManagementWSFault
userID
- The user ID of an existing user in SSMS.true
if a locked user is unlocked now.false
if the user is already unlocked.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurspublic List<String> getUsers(String filter, 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 AsmManagementWs.ASMManagementWSFault
filter
- 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 AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.FILTER_INVALID
if the filter is null, empty or invalid. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs@Deprecated public boolean createActivationCode(String userID, Calendar activationNotAfter) throws AsmManagementWs.ASMManagementWSFault
createActivationCodeEx(ActivationCodeParam)
userID
- The user ID of an existing user in SSMS.activationNotAfter
- Expiration date of the activation code.true
if the activation code was added to the database successfully.false
if the activation code already exist in the database.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty AsmManagementWs.ErrorCodes.ACTIVATION_TIME_INVALID
if the activation time is null. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.ACTIVATION_TIME_HAS_EXPIRED
if the activation time is already expired. AsmLogicException.ErrorCode.ACTIVATION_TIME_EXCEED_MAX_DURATION
if activationNotAfter date exceeds the maximum duration. AsmManagementWs.ErrorCodes.DEVICE_NOT_FOUND
if the deviceId is set, but no device exists with this deviceId. AsmManagementWs.ErrorCodes.DEVICE_NOT_ASSIGNED
if the deviceId is set, but it is not assigned to the specified userId. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public boolean addActivationCode(String userID, Calendar activationNotAfter, String activationCode) throws AsmManagementWs.ASMManagementWSFault
createActivationCodeEx(ActivationCodeParam)
userID
- The user ID of an existing user in SSMS.activationNotAfter
- Expiration date of activation code.activationCode
- Activation code to add.true
if the activation code was added successfully.false
if the activation code could not be added.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.ACTIVATION_TIME_INVALID
if the activation time is null. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.ACTIVATION_TIME_HAS_EXPIRED
if the activation time has already expired. AsmManagementWs.ErrorCodes.ACTIVATION_CODE_INVALID
if the given activation code is invalid or empty. AsmLogicException.ErrorCode.ACTIVATION_TIME_EXCEED_MAX_DURATION
if activationNotAfter date exceeds the maximum
duration. AsmLogicException.ErrorCode.ACTIVATION_CODE_LENGTH_INVALID
if the length of the activation code exceeds the maximum of
64 digits. AsmManagementWs.ErrorCodes.DEVICE_NOT_FOUND
if the deviceId is set, but no device exists with this deviceId. AsmManagementWs.ErrorCodes.DEVICE_NOT_ASSIGNED
if the deviceId is set, but it is not assigned to the specified userId. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public AsmActivationCodeInfo createActivationCodeEx(ActivationCodeParam activationCodeParam) throws AsmManagementWs.ASMManagementWSFault
activationCodeParam
- An ActivationCodeParam
object, containing all necessary parameters to add an activation code.AsmActivationCodeInfo
object, containing the new created activation code.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.ACTIVATION_CODE_INVALID
if the ActivationCodeParam
object is null. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.ACTIVATION_INFO_INVALID
if an information is set, but the text is too long. The maximum
allowed is 255 (printable ASCII) characters.AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the given user cannot be found. AsmManagementWs.ErrorCodes.ACTIVATION_TIME_INVALID
if the activation time is after 2038-01-19. AsmManagementWs.ErrorCodes.ACTIVATION_TIME_HAS_EXPIRED
if the activation time has already expired. AsmManagementWs.ErrorCodes.ACTIVATION_CODE_ALREADY_EXIST
if the activation code does already exist for the given
user. AsmManagementWs.ErrorCodes.ACTIVATION_TIME_EXCEED_MAX_DURATION
if activationNotAfter date exceeds the maximum
duration. AsmManagementWs.ErrorCodes.ACTIVATION_CODE_LENGTH_INVALID
if the length of the activation code exceeds the maximum of
64 digits. AsmManagementWs.ErrorCodes.INVALID_CHARACTERS
if the activation code contains invalid characters. Only printable
ASCII characters between 32 and 126 (decimal code) are allowed. AsmManagementWs.ErrorCodes.PARAMETER_INVALID
if the length of the metaData exceeds the limit of 65000bytes. AsmManagementWs.ErrorCodes.DEVICE_ID_INVALID
if the deviceId is set, but it does not hold a positive integer value. AsmManagementWs.ErrorCodes.DEVICE_NOT_FOUND
if the deviceId is set, but no device exists with this deviceId. AsmManagementWs.ErrorCodes.DEVICE_NOT_ASSIGNED
if the deviceId is set, but it is not assigned to the specified userId. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<AsmActivationCodeInfo> getActivationCodes(String userID, 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 AsmManagementWs.ASMManagementWSFault
userID
- The user ID of an existing user in SSMS.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 AsmActivationCodeInfo
s of the given user ID.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<AsmDeviceMgtInfo> getDevicesForUser(String userID) throws AsmManagementWs.ASMManagementWSFault
AsmDeviceMgtInfo
, which are assigned to the given user ID.
userID
- The user ID of an existing user in SSMS.AsmDeviceMgtInfo
s, that are assigned to the given userID.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] getCertificate(String issuerDN, BigInteger serialNumber) throws AsmManagementWs.ASMManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty. AsmManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null. AsmManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public int removeAllActivationCodes(String userID) throws AsmManagementWs.ASMManagementWSFault
userID
- The user ID of an existing user in SSMS.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean removeActivationCode(String userID, String activationCode) throws AsmManagementWs.ASMManagementWSFault
userID
- The user ID of an existing user in SSMS.activationCode
- The activation code id of the respective activation code.true
if the activation code was removed from the database.false
if the activation code does not exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.ACTIVATION_CODE_INVALID
if the activationCode is null or empty. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean lockDevice(String issuerDN, BigInteger serialNumber, String lockReason) throws AsmManagementWs.ASMManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.lockReason
- The lock reason. It must be one of the currently configured ones.true
if the device was successfully locked.false
if the device is already locked.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty. AsmManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null. AsmManagementWs.ErrorCodes.LOCK_REASON_INVALID
if the lock reason is null, empty or unknown. AsmManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean unlockDevice(String issuerDN, BigInteger serialNumber) throws AsmManagementWs.ASMManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.true
if the device was successfully unlocked.false
if the device is already unlocked.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty. AsmManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null. AsmManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public boolean removeDevice(String issuerDN, BigInteger serialNumber) throws AsmManagementWs.ASMManagementWSFault
removeDeviceEx(DeviceParam)
instead.issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.true
if the device was successfully removed from the database.false
if the device does not exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty. AsmManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public boolean removeDeviceByDeviceId(int deviceID) throws AsmManagementWs.ASMManagementWSFault
removeDeviceEx(DeviceParam)
instead.deviceID
- ID of the device in the database.true
if the device was successfully removed from the database.false
if the device does not exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean removeDeviceEx(DeviceParam deviceParam) throws AsmManagementWs.ASMManagementWSFault
deviceParam
- Identifies the device either by its ID or certificate. See DeviceParam
.true
if the device was successfully removed from the database.false
if the device does not exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.DEVICE_PARAMETER_INVALID
if either the deviceParam is null, or its content is invalid,
i.e.:AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] getCertificateByDeviceId(int deviceID) throws AsmManagementWs.ASMManagementWSFault
deviceID
- ID of the device in the database.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one. AsmManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean lockDeviceByDeviceId(int deviceID, String lockReason) throws AsmManagementWs.ASMManagementWSFault
deviceID
- ID of the device in the database.lockReason
- The lock reason key. The keys and the according values (which can be localized) are configured in file
SSMS_INSTALL/modules/svm/resources/lockReasonsBundle/usercertificate-lock-reasons-config.properties. The key must be contained in this file.true
if the device was locked successfully.false
if the device is already locked.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one. AsmManagementWs.ErrorCodes.LOCK_REASON_INVALID
if the lock reason is null, empty or unknown. AsmManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean unlockDeviceByDeviceId(int deviceID) throws AsmManagementWs.ASMManagementWSFault
deviceID
- ID of the device in the database.true
if the device was unlocked successfully.false
if the device is already unlocked.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one. AsmManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public List<com.kobil.ssms.kernel.presentation.b2b.SsmsNode> getNodes() throws AsmManagementWs.ASMManagementWSFault
com.kobil.ssms.kernel.presentation.b2b.KernelManagementWs
)SsmsNode
s.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void addGroup(String groupName) throws AsmManagementWs.ASMManagementWSFault
groupName
- Unique name of a new group.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.GROUP_NAME_INVALID
if group name is empty. AsmManagementWs.ErrorCodes.GROUP_NAME_NOT_START_WITH_AUTO_GROUP
if group name starts with the String "AUTO_GROUP". AsmManagementWs.ErrorCodes.GROUP_ALREADY_EXIST
if given group already exists in SSMS. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void modifyGroup(String oldGroupName, String newGroupName, boolean removeAutoGroup) throws AsmManagementWs.ASMManagementWSFault
oldGroupName
- Unique name of groupnewGroupName
- New unique name of groupremoveAutoGroup
- Set to @true@ to remove the "auto group" flag from this group.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.GROUP_NAME_INVALID
if old/new group name is empty. AsmManagementWs.ErrorCodes.GROUP_NAME_NOT_START_WITH_AUTO_GROUP
if new group name start with the String "AUTO_GROUP". AsmManagementWs.ErrorCodes.GROUP_NOT_FOUND
if the given group does not exist in SSMS. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void removeGroup(String groupName) throws AsmManagementWs.ASMManagementWSFault
groupName
- Name of an existing groupAsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.GROUP_NAME_INVALID
if the group name is empty. AsmManagementWs.ErrorCodes.GROUP_NOT_FOUND
if the given group does not exist in SSMS. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public String getUserGroup(String userID) throws AsmManagementWs.ASMManagementWSFault
userID
- The user ID of an existing user in SSMS.null
is returned, if the user is not assigned to any group.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.USERID_INVALID
if userID is empty. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void assignGroupToUser(String groupName, String userID) throws AsmManagementWs.ASMManagementWSFault
groupName
- The group name of an existing group in SSMS.userID
- The user ID of an existing user in SSMS.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.GROUP_NAME_INVALID
if group name is empty. AsmManagementWs.ErrorCodes.GROUP_NOT_FOUND
if given group does not exist in SSMS. AsmManagementWs.ErrorCodes.USERID_INVALID
if userID is empty. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.USER_ALREADY_ASSIGNED_TO_GROUP
if user is already assigned to a group. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void unassignGroupFromUser(String userID) throws AsmManagementWs.ASMManagementWSFault
userID
- The user ID of an existing user in SSMS.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.USERID_INVALID
if userID is empty. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.USER_ALREADY_UNASSIGNED_FROM_GROUP
if the user not assigned to any group. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean setPin(String userId, String pin) throws AsmManagementWs.ASMManagementWSFault
userId
- The user ID of an existing user in SSMS.pin
- The new PIN.true
if the PIN was set successfully.false
if the PIN does have the minimum lengthAsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the user does not exist. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.USER_PIN_NOT_CONFIGURED
if the option 'Use Same Pin For All Devices' is not set in the Advanced Settings of the ASM module. AsmManagementWs.ErrorCodes.PARAMETER_INVALID
if the PIN is empty (null or empty string) AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.public String resetPin(String userId) throws AsmManagementWs.ASMManagementWSFault
userId
- The user ID of an existing user in SSMS.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the user does not exist. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.USER_PIN_NOT_CONFIGURED
if the option 'Use Same Pin For All Devices' is not set in the Advanced Settings of the ASM module. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.public boolean removePin(String userId) throws AsmManagementWs.ASMManagementWSFault
userId
- The user ID of an existing user in SSMS.true
if current pin was removed. false
if user has no pin.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the user does not exist. AsmManagementWs.ErrorCodes.USER_PIN_NOT_CONFIGURED
if the option 'Use Same Pin For All Devices' is not set in the Advanced Settings of the ASM module. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.public List<String> getGroups(String filter, 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 AsmManagementWs.ASMManagementWSFault
filter
- 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 AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.FILTER_INVALID
if the filter is null, empty or invalid. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.public String getStatistic(StatisticTypeInfo statisticTypeInfo, List<String> statisticParameters) throws AsmManagementWs.ASMManagementWSFault
statisticTypeInfo
- The selected statistic. StatisticTypeInfo
statisticParameters
- A list of statistic parameters. AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.STATISTIC_TYPE_INVALID
if the statistic type is null or invalid AsmManagementWs.ErrorCodes.STATISTIC_PARAMETERS_INVALID
if the statistic parameters are invalid AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.public AsmDeviceMgtInfo getDeviceMgtInfo(int deviceId) throws AsmManagementWs.ASMManagementWSFault
AsmDeviceMgtInfo
object, containing device information.deviceId
- ID of the device in the database.AsmDeviceMgtInfo
object, containing device information.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than one. AsmManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested device Id cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.public List<VersionParam> getVersions(String filter, 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 AsmManagementWs.ASMManagementWSFault
filter
- 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 AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.FILTER_INVALID
if the filter is null, empty or invalid. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurspublic UserInfo getUserInfo(String userId) throws AsmManagementWs.ASMManagementWSFault
UserInfo
object, containing user information.userId
- The user ID of an existing user in SSMS.UserInfo
object, containing user information.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred.@Deprecated public void storeTextResources(String language, byte[] contents) throws AsmManagementWs.ASMManagementWSFault
com.kobil.ssms.kernel.presentation.b2b.KernelManagementWs
)language
- The language for which the resource bundle shall be saved (Must be a 2-letter language code defined in
ISO 639), e.g. "en" or "de". If language is null, the default will be used.contents
- The resource bundle which shall be saved (given as byte array, containing ASM text resources).AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.LANGUAGE_INVALID
if the language is empty or invalid. AsmManagementWs.ErrorCodes.CONTENTS_INVALID
if the contents is null or empty. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred. @Deprecated public byte[] getTextResources(String language) throws AsmManagementWs.ASMManagementWSFault
com.kobil.ssms.kernel.presentation.b2b.KernelManagementWs
)language
- This is an optional parameter. Set it to null to receive the default language. The language for which
the resource bundle shall be returned (Must be a 2-letter language code defined in ISO 639), e.g. "en"
or "de". If language is null, the default will be used.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.LANGUAGE_INVALID
if the language is empty or invalid. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs. public ReportingInfo getReportingItems(ReportingFilter reportingFilter, com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput, Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination) throws AsmManagementWs.ASMManagementWSFault
ReportingFilter
.reportingFilter
- A ReportingFilter
object to filter the returned result. This filter must not be null.orderInput
- - OrderInput object with information about sorting field name and direction orderResult
- - Holder for OrderResult with information about sorting field name and direction. AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.PARAMETER_MISSING
if the reportingFilter is null. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] createAppBundle(AppBundleParam appBundleParam) throws AsmManagementWs.ASMManagementWSFault
appBundleParam
- An AppBundleParam
object, containing all parameters needed to create an app configuration
bundle.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.APP_BUNDLE_PARAM_INVALID
AsmManagementWs.ErrorCodes.INVALID_PIN_FOR_CA
if the CA password is incorrect. AsmManagementWs.ErrorCodes.INVALID_PORT
if the port in secure ASM URL is invalid. AsmManagementWs.ErrorCodes.UNKNOWN_HOST
if the host in secure ASM URL is unknown. AsmManagementWs.ErrorCodes.CONNECTION_FAILED
if the connection to the secure ASM URL failed. AsmManagementWs.ErrorCodes.UNTRUSTED_CERTIFICATE_CHAIN
if the retrieval of SSL certificate chain from secure ASM URL
failed. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] createUserCertificate(String certProfile, String pkcs10B64) throws AsmManagementWs.ASMManagementWSFault
The profile must have one of the following values:
certProfile
- pkcs10B64
- AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.PARAMETER_INVALID
if the certificate profile parameter or the pkcs10B64 parameter is null or emptyAsmManagementWs.ErrorCodes.CERT_PROFILE_INVALID
if the provided certificate profile is invalid. AsmManagementWs.ErrorCodes.CERTIFICATE_SIGNING_REQUEST_INVALID
if the CSR is invalid, e.g. bad encoding, no subject provided AsmManagementWs.ErrorCodes.CERTIFICATE_SIGNING_REQUEST_INVALID_SIGNATURE
if signature of provided CSR is invalid
AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the user, provided by the subjectCN part within the CSR, for which the certificate creation is requested does not exist. AsmManagementWs.ErrorCodes.CERT_CREATION_FAILED
if an error during certificate creation or signing occurs (e.g. signer not available, encoding), or if the created certificate cannot be persisted, or if the created certificate already exists.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean addVersion(VersionParam versionParam) throws AsmManagementWs.ASMManagementWSFault
versionParam
- An VersionParam
object, containing all parameters needed to create an app version entry in the database.true
if the version was added successfully to database. false
if the version
already exists.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.VERSION_PARAM_INVALID
if version parameter is null. AsmManagementWs.ErrorCodes.SOFTWARE_TYPE_INVALID
if software type is null. AsmManagementWs.ErrorCodes.CLIENT_TYPE_INVALID
if client type is null or empty. Or, if software type is FIRMWARE and client type
is not installable. AsmManagementWs.ErrorCodes.DEVICE_TYPE_INVALID
if software type is FIRMWARE and device type is null or empty. Or, if software type
is FIRMWARE and device type does not contain firmware. Or, if software type is APP and device type is not
null. AsmManagementWs.ErrorCodes.USERID_INVALID
if software type is FIRMWARE and the user, which is allowed to register app
digest, is not null. Or, if software type is APP and the user, which is allowed to register app digest, is null or empty. AsmManagementWs.ErrorCodes.APP_NAME_INVALID
if software type is FIRMWARE and the app name is not null. Or, if software
type is APP and the app name contains only white spaces. Or, if software type is APP and the app name is
invalid (too long / invalid characters). AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if version string is null, empty or invalid. AsmManagementWs.ErrorCodes.INSTALLER_INVALID
if the required installation file is null. Or, if the installation file is
not required but present. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the user, which is allowed to register app digest, does not exist. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.
AsmManagementWs.ErrorCodes.EXIST_APP_VERSION_ON_MASTER
if exist oneappforall version on master also tenant want to add version with same app name get error.
AsmManagementWs.ErrorCodes.EXIST_APP_VERSION_ON_TENANT
if exist version on tenant also master want to add 1app4all version with same app name get error.public void editVersion(VersionParam versionParam) throws AsmManagementWs.ASMManagementWSFault
versionParam
- An VersionParam
object, containing all parameters needed to update a version.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.VERSION_PARAM_INVALID
if version parameter is null. AsmManagementWs.ErrorCodes.SOFTWARE_TYPE_INVALID
if software type is null. AsmManagementWs.ErrorCodes.CLIENT_TYPE_INVALID
if client type is null or empty. Or, if software type is FIRMWARE and client type
is not installable. AsmManagementWs.ErrorCodes.DEVICE_TYPE_INVALID
if software type is FIRMWARE and device type is null or empty. Or, if software type
is FIRMWARE and device type does not contain firmware. Or, if software type is APP and device type is not
null. AsmManagementWs.ErrorCodes.USERID_INVALID
if software type is FIRMWARE and the user, which is allowed to register app
digest, is not null. Or, if software type is APP and the user, which is allowed to register app digest,
is null or empty. AsmManagementWs.ErrorCodes.APP_NAME_INVALID
if software type is FIRMWARE and the app name is not null. Or, if software
type is APP and the app name contains only white spaces. Or, if software type is APP and the app name is
invalid (too long / invalid characters). AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if version string is null, empty or invalid. AsmManagementWs.ErrorCodes.INSTALLER_INVALID
if the required installation file is null. Or, if the installation file is
not required but present. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. AsmManagementWs.ErrorCodes.REQUESTED_VERSION_NOT_FOUND
if the version does not exist. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.
AsmManagementWs.ErrorCodes.EXIST_APP_VERSION_ON_MASTER
if exist oneappforall version on master also tenant want to add version with same app name get error.
AsmManagementWs.ErrorCodes.EXIST_APP_VERSION_ON_TENANT
if exist version on tenant also master want to add 1app4all version with same app name get error.public boolean removeVersion(SoftwareTypes softwareType, String clientType, String deviceType, String versionStr, String appName) throws AsmManagementWs.ASMManagementWSFault
softwareType
- This is the software type, such as: APP or FIRMWARE. This is a required parameter.clientType
- This is the name of the client type, such as: {ANDROID_ARM, iOS_ARMv7, WINDOWS, MAC_OS, LINUX, ANDROID_x86, iOS_ARMv7s, iOS_ARM64, WindowsPhone_ARMV7, WindowsPhone_Emu}.
This is a required parameter.deviceType
- This is the name of the device type, such as: MIDENTITY_MINI, MIDENTITY_AIR, MIDENTITY_AIR_PLUS.
This is an optional parameter. It must be set in case of softwareType=FIRMWARE and must not be set for softwareType=APP.versionStr
- This is the version string (supposed to be x.y.zzzz). This is a required parameter.appName
- The application name. This is an optional parameter. It must be set in case of softwareType=APP and must not be set for softwareType=FIRMWARE.true
if the version was removed from database. false
if the version does not
exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.SOFTWARE_TYPE_INVALID
if software type is null. AsmManagementWs.ErrorCodes.CLIENT_TYPE_INVALID
if the client type is null. AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if version string is null, empty or invalid. AsmManagementWs.ErrorCodes.VERSION_DELETION_PROHIBITED
if version is used by some devices or has version-updates available. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean removeVersionChecksum(SoftwareTypes softwareType, String clientType, String deviceType, String versionStr, String appName) throws AsmManagementWs.ASMManagementWSFault
softwareType
- This is the software type, such as: APP or FIRMWARE. This is a required parameter.clientType
- This is the name of the client type, such as: {ANDROID_ARM, iOS_ARMv7, WINDOWS, MAC_OS, LINUX, ANDROID_x86, iOS_ARMv7s, iOS_ARM64, WindowsPhone_ARMV7, WindowsPhone_Emu}.
This is a required parameter.deviceType
- This is the name of the device type, such as: MIDENTITY_MINI, MIDENTITY_AIR, MIDENTITY_AIR_PLUS.
This is an optional parameter. It must be set in case of softwareType=FIRMWARE and must not be set for softwareType=APP.versionStr
- This is the version string (supposed to be x.y.zzzz). This is a required parameter.appName
- The application name. This is an optional parameter.It must be set in case of softwareType=APP and must not be set for softwareType=FIRMWARE.true
if the checksum was removed from version. false
if the version does not
exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.SOFTWARE_TYPE_INVALID
if the software type is null. AsmManagementWs.ErrorCodes.CLIENT_TYPE_INVALID
if the client type is null. AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if version string is null, empty or invalid. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void assignVersionUpdate(VersionUpdateParam versionUpdateParam) throws AsmManagementWs.ASMManagementWSFault
versionUpdateParam
- An VersionUpdateParam
object, containing all parameters needed to assign a version update.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.VERSION_UPDATE_PARAM_INVALID
if version update parameter is null. AsmManagementWs.ErrorCodes.SOFTWARE_TYPE_INVALID
if the software type is null. AsmManagementWs.ErrorCodes.CLIENT_TYPE_INVALID
if software type is APP and client type is null or empty. Or, if software type is
FIRMWARE and client type in not null. AsmManagementWs.ErrorCodes.DEVICE_TYPE_INVALID
if software type is FIRMWARE and device type is null or empty. Or, if software type
is APP and device type is not null. AsmManagementWs.ErrorCodes.APP_NAME_INVALID
if software type is FIRMWARE and the app name is not null.
Or, if software type is APP and the app name is null or empty.
Or, if software type is APP and the app name is invalid (too long / invalid characters). AsmManagementWs.ErrorCodes.GROUP_NOT_FOUND
if the group does not exist. AsmManagementWs.ErrorCodes.MANDATORY_FROM_INVALID
if mandatory from date is null or older than today's date. AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if version string is null, empty or invalid. AsmManagementWs.ErrorCodes.REQUESTED_VERSION_NOT_FOUND
if the version does not exist. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void unassignVersionUpdate(VersionUpdateParam versionUpdateParam) throws AsmManagementWs.ASMManagementWSFault
versionUpdateParam
- An VersionUpdateParam
object, containing all parameters needed to unassigns a version update.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.VERSION_UPDATE_PARAM_INVALID
if version update parameter is null. AsmManagementWs.ErrorCodes.SOFTWARE_TYPE_INVALID
if the software type is null. AsmManagementWs.ErrorCodes.CLIENT_TYPE_INVALID
if software type is APP and client type is null or empty. Or, if software type is
FIRMWARE and client type in not null. AsmManagementWs.ErrorCodes.DEVICE_TYPE_INVALID
if software type is FIRMWARE and device type is null or empty. Or, if software type
is APP and device type is not null. AsmManagementWs.ErrorCodes.APP_NAME_INVALID
if software type is FIRMWARE and the app name is not null.
Or, if software type is APP and the app name is null or empty.
Or, if software type is APP and the app name is invalid (too long / invalid characters). AsmManagementWs.ErrorCodes.GROUP_NOT_FOUND
if the group does not exist. AsmManagementWs.ErrorCodes.MANDATORY_FROM_INVALID
if mandatory from date is not null. AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if version string is null, empty or invalid. AsmManagementWs.ErrorCodes.VERSION_UPDATE_NOT_FOUND
if version update does not exist. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void editVersionUpdate(VersionUpdateParam versionUpdateParam) throws AsmManagementWs.ASMManagementWSFault
versionUpdateParam
- An VersionUpdateParam
object, containing all parameters needed to edit a version update.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.VERSION_UPDATE_PARAM_INVALID
if version update parameter is null. AsmManagementWs.ErrorCodes.SOFTWARE_TYPE_INVALID
if the software type is null. AsmManagementWs.ErrorCodes.CLIENT_TYPE_INVALID
if software type is APP and client type is null or empty. Or, if software type is
FIRMWARE and client type in not null. AsmManagementWs.ErrorCodes.DEVICE_TYPE_INVALID
if software type is FIRMWARE and device type is null or empty. Or, if software type
is APP and device type is not null. AsmManagementWs.ErrorCodes.APP_NAME_INVALID
if software type is FIRMWARE and the app name is not null.
Or, if software type is APP and the app name is null or empty.
Or, if software type is APP and the app name is invalid (too long / invalid characters). AsmManagementWs.ErrorCodes.GROUP_NOT_FOUND
if the group does not exist. AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if version string is null, empty or invalid. AsmManagementWs.ErrorCodes.MANDATORY_FROM_INVALID
if mandatory from date is null or older than today's date. AsmManagementWs.ErrorCodes.VERSION_UPDATE_NOT_FOUND
if version update does not exist. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<Integer> copyPin(int deviceID, List<Integer> deviceIDs) throws AsmManagementWs.ASMManagementWSFault
deviceID
to a list of virtual devices deviceIDs
.
These target devices must be assigned to the same user as the source device.
NOTE:deviceIDs
of the user, the list of
virtual devices deviceIDs
must only contain -1.deviceID
- The password of the regarding virtual device will be copied to the list of virtual devices deviceIDs
.deviceIDs
- The password of the regarding virtual device deviceID
will be copied to all virtual devices of that list.
If the list contains only -1 as an entry for device ID, the password will be copied to all virtual devices of the same user.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. AsmManagementWs.ErrorCodes.DEVICE_ID_INVALID
if the device Id is less than 1. AsmManagementWs.ErrorCodes.PARAMETER_INVALID
if the list of deviceIDs is null, empty, contains invalid deviceIDs,
or the marker [-1] for ALL deviceID(s) is set but the list contains more than one entry. AsmManagementWs.ErrorCodes.DEVICE_NOT_FOUND
if no device exists with the specified deviceID. AsmManagementWs.ErrorCodes.CERT_IS_LOCKED
if the device is locked. AsmManagementWs.ErrorCodes.CERT_IS_TEMPORARY_LOCKED
if the device is temporary locked. AsmManagementWs.ErrorCodes.DEVICE_TYPE_INVALID
if the device is no virtual device. AsmManagementWs.ErrorCodes.DEVICE_NOT_ASSIGNED
if no user is assigned for the regarding device. AsmManagementWs.ErrorCodes.USER_NOT_FOUND
if the user, assigned for the regarding device, cannot be found. AsmManagementWs.ErrorCodes.USER_IS_LOCKED
if the user, assigned for the regarding device, is locked. AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean addSigner(SignerParam signerParam) throws AsmManagementWs.ASMManagementWSFault
signerParam
- An SignerParam
object, containing all necessary parameters to add new signer.true
if the token signer was added to the databasefalse
if the token signer already exists.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_SIGNERS_MANAGE
permission.AsmManagementWs.ErrorCodes.SIGNER_PARAM_INVALID
if the SignerParam
object is null.AsmManagementWs.ErrorCodes.TOKEN_SIGNER_NAME_INVALID
if the token signer name is null or blank
or greater than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.AsmManagementWs.ErrorCodes.SERVICE_OWNER_INVALID
if the token signer service owner is null or blank.AsmManagementWs.ErrorCodes.SIGNATURE_ALGORITHM_INVALID
if the token signer signature algorithm is not RS256 or HS256.AsmManagementWs.ErrorCodes.SERVICE_OWNER_NOT_FOUND
if the token signer service owner not found in SSMS.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurspublic boolean addPolicy(PolicyParam policyParam) throws AsmManagementWs.ASMManagementWSFault
policyParam
- An PolicyParam
object, containing all necessary parameters to add a new policy.true
if the token policy was added to the databasefalse
if the token policy already exists.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_POLICIES_MANAGE
permission.AsmManagementWs.ErrorCodes.POLICY_PARAM_INVALID
if the PolicyParam
object is null.AsmManagementWs.ErrorCodes.TOKEN_POLICY_NAME_INVALID
if the token policy name is null or blank
or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_NAME
characters.AsmManagementWs.ErrorCodes.AUDIENCE_MATCHER_INVALID
if the token policy audience matcher is null or blank
or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_AUDIENCE_MATCHER
characters.AsmManagementWs.ErrorCodes.VALID_FOR_INVALID
if the token policy validFor is null
or negative or greater than Integer.MAX_VALUE
(2147483647).AsmManagementWs.ErrorCodes.ISSUER_INVALID
if the token policy issuer is null or blank
or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_ISSUER
characters.AsmManagementWs.ErrorCodes.SIGNER_INVALID
if the token policy signer is null or blank
or greater than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.AsmManagementWs.ErrorCodes.ACTIVE_FLAG_INVALID
if the token policy active flag is null.AsmManagementWs.ErrorCodes.SIGNER_NOT_FOUND
if the token policy signer cannot be found in SSMS.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void editSigner(EditSignerParam editSignerParam) throws AsmManagementWs.ASMManagementWSFault
editSignerParam
- An EditSignerParam
object, containing all necessary parameters to edit an existing token signer.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_SIGNERS_MANAGE
permission.AsmManagementWs.ErrorCodes.EDIT_SIGNER_PARAM_INVALID
if the EditSignerParam
object is null.AsmManagementWs.ErrorCodes.TOKEN_SIGNER_NAME_INVALID
if the token signer name is null or blank
or greater than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.AsmManagementWs.ErrorCodes.SERVICE_OWNER_INVALID
if the token signer service owner is blank.AsmManagementWs.ErrorCodes.SIGNATURE_ALGORITHM_INVALID
if the token signer signature algorithm is not RS256 or HS256.AsmManagementWs.ErrorCodes.SIGNER_NOT_FOUND
if the token signer not found in SSMS.AsmManagementWs.ErrorCodes.SERVICE_OWNER_NOT_FOUND
if the token signer service owner not found in SSMS.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurspublic void editPolicy(EditPolicyParam editPolicyParam) throws AsmManagementWs.ASMManagementWSFault
editPolicyParam
- An EditPolicyParam
object, containing all necessary parameters to edit an existing token policy.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_POLICIES_MANAGE
permission.AsmManagementWs.ErrorCodes.EDIT_POLICY_PARAM_INVALID
if the EditPolicyParam
object is null.AsmManagementWs.ErrorCodes.TOKEN_POLICY_NAME_INVALID
if the token policy name is null or blank
or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_NAME
characters.AsmManagementWs.ErrorCodes.AUDIENCE_MATCHER_INVALID
if the token policy audience matcher is blank
or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_AUDIENCE_MATCHER
characters.AsmManagementWs.ErrorCodes.VALID_FOR_INVALID
if the token policy validFor
is negative or greater than Integer.MAX_VALUE
(2147483647).AsmManagementWs.ErrorCodes.ISSUER_INVALID
if the token policy issuer is blank
or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_ISSUER
characters.AsmManagementWs.ErrorCodes.SIGNER_INVALID
if the token policy signer is blank
or greater than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.AsmManagementWs.ErrorCodes.SIGNER_NOT_FOUND
if the token policy signer cannot be found.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurspublic boolean removeSigner(String name) throws AsmManagementWs.ASMManagementWSFault
name
- A name of a token signer that exist in SSMS. Must not be null
or blank or greater than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.true
if the token signer was removed from the databasefalse
if the token signer does not exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_SIGNERS_MANAGE
permission.AsmManagementWs.ErrorCodes.TOKEN_SIGNER_NAME_INVALID
if the token signer name is null or blank
or greater than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean removePolicy(String name) throws AsmManagementWs.ASMManagementWSFault
name
- A name of a token policy that exist in SSMS. Must not be null
or blank or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_NAME
characters.true
if the token policy was removed from the databasefalse
if the token policy does not exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_POLICIES_MANAGE
permission.AsmManagementWs.ErrorCodes.TOKEN_POLICY_NAME_INVALID
if the token policy name is null or blank
or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_NAME
characters.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] getSignerCertificate(String name) throws AsmManagementWs.ASMManagementWSFault
name
- A name of a token signer that exist in SSMS. Must not be null
or blank or greater than {@link TokenSignerLogic#MAX_LENGTH_SIGNER_NAME characters.byte[]
DER encoded certificate of token signer found by name.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_SIGNERS_VIEW
permission.AsmManagementWs.ErrorCodes.TOKEN_SIGNER_NAME_INVALID
if the token signer name is null or blank
or greater than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.AsmManagementWs.ErrorCodes.SIGNER_NOT_FOUND
if the token signer not found in SSMS.AsmManagementWs.ErrorCodes.CERTIFICATE_NOT_FOUND
if the certificate not found in SSMS.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public TokenSignerInfo getSigner(String name) throws AsmManagementWs.ASMManagementWSFault
name
- A name of a token signer that exist in SSMS. Must not be null
or blank or greater than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.TokenSignerInfo
of token signer found by name.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_SIGNERS_VIEW
permission.AsmManagementWs.ErrorCodes.TOKEN_SIGNER_NAME_INVALID
if the token signer name is null or blank
or length more than TokenSignerLogic.MAX_LENGTH_SIGNER_NAME
characters.AsmManagementWs.ErrorCodes.SIGNER_NOT_FOUND
if the token signer not found in SSMS.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public TokenPolicyInfo getPolicy(String name) throws AsmManagementWs.ASMManagementWSFault
name
- A name of a token policy that exist in SSMS. Must not be null
or blank or greater than TokenPolicyLogic.MAX_LENGTH_POLICY_NAME
characters.TokenPolicyInfo
of token policy found by name.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_TOKEN_POLICIES_VIEW
permission.AsmManagementWs.ErrorCodes.TOKEN_POLICY_NAME_INVALID
if the token signer name is null or blank
or length more than TokenPolicyLogic.MAX_LENGTH_POLICY_NAME
characters.AsmManagementWs.ErrorCodes.POLICY_NOT_FOUND
if the token policy not found in SSMS.AsmManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] createCaCertificate(String passPhrase) throws AsmManagementWs.ASMManagementWSFault, com.kobil.ssms.asm.logic.AsmLogicException
AsmManagementWs.ASMManagementWSFault
com.kobil.ssms.asm.logic.AsmLogicException
public boolean addMassReactivationConfiguration(AsmMassReactivationConfigParam asmMassReactivationConfigurationParam) throws AsmManagementWs.ASMManagementWSFault, com.kobil.ssms.asm.logic.AsmLogicException
asmMassReactivationConfigurationParam
- An AsmMassReactivationConfigParam
object, containing all necessary parameters to add a new Mass Reactivation configuration.true
if asmMassReactivationConfig was added to the databasefalse
if the asmMassReactivationConfig already exists.AsmManagementWs.ASMManagementWSFault
com.kobil.ssms.asm.logic.AsmLogicException
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_MASS_REACTIVATION_MANAGE
permission.AsmManagementWs.ErrorCodes.PARAMETER_MISSING
if the AsmMassReactivationConfigParam
object is null AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CONFIG_NAME_MISSING
if the Config Name is null or blank AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CLIENT_TYPE_MISSING
if the Client Type is null or blank AsmManagementWs.ErrorCodes.MASS_REACTIVATION_APP_NAME_MISSING
if the App Name is null or blank AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CLIENT_TYPE_INVALID
if the Client Type is invalid AsmManagementWs.ErrorCodes.MASS_REACTIVATION_MAX_APP_VERSION_MISSING
if the max App version is null or blank AsmManagementWs.ErrorCodes.APPNAME_INVALID
if the App Name is invalid AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if the max App Version is invalid AsmManagementWs.ErrorCodes.MASS_REACTIVATION_MAX_APP_VERSION_MUST_LONG
if the max App Version contains values different from long type AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CONFIG_NAME_ALREADY_EXIST
if the Config Name is already exist on database AsmManagementWs.ErrorCodes.GENERAL_ERROR
Any Other error while adding Configuration public boolean editMassReactivationConfiguration(AsmMassReactivationConfigParam asmMassReactivationConfigurationParam) throws AsmManagementWs.ASMManagementWSFault, com.kobil.ssms.asm.logic.AsmLogicException
asmMassReactivationConfigurationParam
- An AsmMassReactivationConfigParam
object, containing all necessary parameters to add a new Mass Reactivation configuration.true
if asmMassReactivationConfig was edited properlyfalse
if the asmMassReactivationConfig was not edited.AsmManagementWs.ASMManagementWSFault
com.kobil.ssms.asm.logic.AsmLogicException
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_MASS_REACTIVATION_MANAGE
permission.AsmManagementWs.ErrorCodes.PARAMETER_MISSING
if the AsmMassReactivationConfigParam
object is null AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CONFIG_NAME_MISSING
if the Config Name is null or blank AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CLIENT_TYPE_MISSING
if the Client Type is null or blank AsmManagementWs.ErrorCodes.MASS_REACTIVATION_APP_NAME_MISSING
if the App Name is null or blank AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CLIENT_TYPE_INVALID
if the Client Type is invalid AsmManagementWs.ErrorCodes.MASS_REACTIVATION_MAX_APP_VERSION_MISSING
if the max App version is null or blank AsmManagementWs.ErrorCodes.APPNAME_INVALID
if the App Name is invalid AsmManagementWs.ErrorCodes.VERSION_STR_INVALID
if the max App Version is invalid AsmManagementWs.ErrorCodes.MASS_REACTIVATION_MAX_APP_VERSION_MUST_LONG
if the max App Version contains values different from long type AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CONFIGURATION_NOT_FOUND
if the Configuration is not found on database AsmManagementWs.ErrorCodes.GENERAL_ERROR
Any Other error while adding Configuration public boolean removeMassReactivationConfiguration(String name) throws AsmManagementWs.ASMManagementWSFault
name
- A name of a mass Reactivation configuration that exist in SSMS. Must not be null
or blank.true
if the mass Reactivation configuration was removed from the databasefalse
if the mass Reactivation configuration not removed.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_MASS_REACTIVATION_MANAGE
permission.AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CONFIG_NAME_MISSING
if the Config Name is null or blank AsmManagementWs.ErrorCodes.MASS_REACTIVATION_CONFIGURATION_NOT_FOUND
if the Configuration is not found on database AsmManagementWs.ErrorCodes.MASS_REACTIVATION__CONFIGURATION_COULDNT_BE_REMOVED
if the Configuration not removed properly.public List<AsmMassReactivationConfigParam> getMassReactivationConfigurations() throws AsmManagementWs.ASMManagementWSFault, com.kobil.ssms.asm.logic.management.massreactivation.AsmMassReactivationLogicException
AsmMassReactivationConfigParam
s.AsmManagementWs.ASMManagementWSFault
com.kobil.ssms.asm.logic.management.massreactivation.AsmMassReactivationLogicException
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_MASS_REACTIVATION_MANAGE
permission.@Deprecated public boolean addPushNotificationConfiguration(AsmPushNotificationConfigParam asmPushNotificationConfigurationParam) throws AsmManagementWs.ASMManagementWSFault
asmPushNotificationConfigurationParam
- An AsmPushNotificationConfigParam
object, containing all necessary parameters to add a new push notification configuration.true
if asmPushNotificationConfig was added to the databasefalse
if the asmPushNotificationConfig already exists.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_PUSH_NOTIFICATION_MANAGE
permission.AsmManagementWs.ErrorCodes.PARAMETER_MISSING
if the AsmPushNotificationConfigParam
object is null AsmManagementWs.ErrorCodes.APPNAME_INVALID
if the App Name is null or App Name does not exist AsmManagementWs.ErrorCodes.APNS_PUSH_TYPE_INVALID
if Authentication Push Type parameter is null or invalid AsmManagementWs.ErrorCodes.ANDROD_APIKEY_MISSING
if Android Api Key is null AsmManagementWs.ErrorCodes.IOS_CERTIFICATE_MISSING
if iOS Certificate is null AsmManagementWs.ErrorCodes.IOS_TOKEN_MISSING
if IOS Token parameters is null AsmManagementWs.ErrorCodes.IOS_TEAM_ID_MISSING
if IOS TeamId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.IOS_KEY_ID_MISSING
if IOS KeyId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.IOS_BUNDLE_ID_MISSING
if IOS BundleId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.ANDROD_APIKEY_INVALID
if Android Api Key parameter length is bigger than limit AsmManagementWs.ErrorCodes.INVALID_KEYSTORE_ISSUER
if APNS certificate key store is invalid AsmManagementWs.ErrorCodes.INVALID_APNS_CERT
if loading of APNS certificate is not valid AsmManagementWs.ErrorCodes.IOS_CERTIFICATE_PASSWORD_MISSING
if pass of Ios certificate is null AsmManagementWs.ErrorCodes.APN_CONFIGURATION_COULDNT_BE_SAVED
if IllegalArgumentException or EntityExistsException is exist @Deprecated public void editPushNotificationConfiguration(AsmPushNotificationConfigParam asmPushNotificationConfigurationParam) throws AsmManagementWs.ASMManagementWSFault
asmPushNotificationConfigurationParam
- An AsmPushNotificationConfigParam
object, containing all necessary parameters to edit a new push notification configuration.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_PUSH_NOTIFICATION_MANAGE
permission.AsmManagementWs.ErrorCodes.PARAMETER_MISSING
if the AsmPushNotificationConfigParam
object is null AsmManagementWs.ErrorCodes.APPNAME_INVALID
if the App Name is null or App Name does not exist AsmManagementWs.ErrorCodes.APNS_PUSH_TYPE_INVALID
if Authentication Push Type parameter is null or invalid AsmManagementWs.ErrorCodes.ANDROD_APIKEY_MISSING
if Android Api Key is null AsmManagementWs.ErrorCodes.IOS_CERTIFICATE_MISSING
if iOS Certificate is null AsmManagementWs.ErrorCodes.IOS_TOKEN_MISSING
if IOS Token parameters is null AsmManagementWs.ErrorCodes.IOS_TEAM_ID_MISSING
if IOS TeamId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.IOS_KEY_ID_MISSING
if IOS KeyId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.IOS_BUNDLE_ID_MISSING
if IOS BundleId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.ANDROD_APIKEY_INVALID
if Android Api Key parameter length is bigger than limit AsmManagementWs.ErrorCodes.INVALID_KEYSTORE_ISSUER
if APNS certificate key store is invalid AsmManagementWs.ErrorCodes.INVALID_APNS_CERT
if loading of APNS certificate is not valid AsmManagementWs.ErrorCodes.IOS_CERTIFICATE_PASSWORD_MISSING
if pass of Ios certificate is null AsmManagementWs.ErrorCodes.APN_CONFIGURATION_COULDNT_BE_SAVED
if IllegalArgumentException or EntityExistsException is exist public List<AsmPushNotificationConfigParam> getPushNotificationConfigurations(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 AsmManagementWs.ASMManagementWSFault
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 AsmPushNotificationConfigParam
s.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_PUSH_NOTIFICATION_MANAGE
permission.public boolean removePushNotificationConfiguration(String name) throws AsmManagementWs.ASMManagementWSFault
name
- A name of a appName that exist in SSMS. Must not be null
or blank.true
if asmPushNotificationConfig was removed to the databasefalse
if the asmPushNotificationConfig does not exist.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_PUSH_NOTIFICATION_MANAGE
permission.AsmManagementWs.ErrorCodes.PARAMETER_MISSING
if the AsmPushNotificationConfigParam
object is null AsmManagementWs.ErrorCodes.APPNAME_INVALID
if the App Name is null or App Name does not exist AsmManagementWs.ErrorCodes.APN_CONFIGURATION_COULDNT_BE_REMOVED
if configuration is not removed public boolean addPushNotificationConfigurationEx(PushNotificationConfigParam pushNotificationConfigParam) throws AsmManagementWs.ASMManagementWSFault
pushNotificationConfigParam
- An PushNotificationConfigParam
object, containing all necessary parameters to add a new push notification configuration.true
if asmPushNotificationConfig was added to the databasefalse
if the asmPushNotificationConfig already exists.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_PUSH_NOTIFICATION_MANAGE
permission.AsmManagementWs.ErrorCodes.PARAMETER_MISSING
if the PushNotificationConfigParam
object is null AsmManagementWs.ErrorCodes.APPNAME_INVALID
if the App Name is null or App Name does not exist AsmManagementWs.ErrorCodes.APNS_PUSH_TYPE_INVALID
if Authentication Push Type parameter is null or invalid AsmManagementWs.ErrorCodes.ANDROD_APIKEY_MISSING
if Android Api Key is null AsmManagementWs.ErrorCodes.ANDROD_APIKEY_INVALID
if Android Api Key parameter length is bigger than limit AsmManagementWs.ErrorCodes.IOS_CERTIFICATE_MISSING
if iOS Certificate is null AsmManagementWs.ErrorCodes.ONLY_IOS_CERTIFICATE_PUSH
if Configuration contains param except Ios cert AsmManagementWs.ErrorCodes.IOS_TOKEN_MISSING
if IOS Token parameters is null AsmManagementWs.ErrorCodes.IOS_TEAM_ID_MISSING
if IOS TeamId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.IOS_KEY_ID_MISSING
if IOS KeyId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.IOS_BUNDLE_ID_MISSING
if IOS BundleId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.ONLY_IOS_TOKEN_PUSH
if Configuration contains param except Ios token AsmManagementWs.ErrorCodes.INVALID_KEYSTORE_ISSUER
if APNS certificate key store is invalid AsmManagementWs.ErrorCodes.INVALID_APNS_CERT
if loading of APNS certificate is not valid AsmManagementWs.ErrorCodes.IOS_CERTIFICATE_PASSWORD_MISSING
if pass of Ios certificate is null AsmManagementWs.ErrorCodes.APN_CONFIGURATION_COULDNT_BE_SAVED
if IllegalArgumentException or EntityExistsException is exist public void editPushNotificationConfigurationEx(PushNotificationConfigParam pushNotificationConfigParam) throws AsmManagementWs.ASMManagementWSFault
pushNotificationConfigParam
- An PushNotificationConfigParam
object, containing all necessary parameters to edit a new push notification configuration.AsmManagementWs.ASMManagementWSFault
- AsmManagementWs.ErrorCodes.PERMISSION_DENIED
if user does not have ASMPermissions.ASM_PUSH_NOTIFICATION_MANAGE
permission.AsmManagementWs.ErrorCodes.PARAMETER_MISSING
if the PushNotificationConfigParam
object is null AsmManagementWs.ErrorCodes.APPNAME_INVALID
if the App Name is null or App Name does not exist AsmManagementWs.ErrorCodes.APNS_PUSH_TYPE_INVALID
if Authentication Push Type parameter is null or invalid AsmManagementWs.ErrorCodes.ANDROD_APIKEY_MISSING
if Android Api Key is null AsmManagementWs.ErrorCodes.ANDROD_APIKEY_INVALID
if Android Api Key parameter length is bigger than limit AsmManagementWs.ErrorCodes.IOS_CERTIFICATE_MISSING
if iOS Certificate is null AsmManagementWs.ErrorCodes.ONLY_IOS_CERTIFICATE_PUSH
if Configuration contains param except Ios cert AsmManagementWs.ErrorCodes.IOS_TOKEN_MISSING
if IOS Token parameters is null AsmManagementWs.ErrorCodes.IOS_TEAM_ID_MISSING
if IOS TeamId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.IOS_KEY_ID_MISSING
if IOS KeyId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.IOS_BUNDLE_ID_MISSING
if IOS BundleId parameters is null for token-based push notification AsmManagementWs.ErrorCodes.ONLY_IOS_TOKEN_PUSH
if Configuration contains param except Ios token AsmManagementWs.ErrorCodes.INVALID_KEYSTORE_ISSUER
if APNS certificate key store is invalid AsmManagementWs.ErrorCodes.INVALID_APNS_CERT
if loading of APNS certificate is not valid AsmManagementWs.ErrorCodes.IOS_CERTIFICATE_PASSWORD_MISSING
if pass of Ios certificate is null AsmManagementWs.ErrorCodes.APN_CONFIGURATION_COULDNT_BE_SAVED
if IllegalArgumentException or EntityExistsException is exist public List<com.kobil.ssms.asm.presentation.jsf.iam.IAMKey> getAllIAMCachedKeys() throws AsmManagementWs.ASMManagementWSFault
rangeInput
- - RangeInput object with information about range with "from" and "limit" values rangeResult
- - Holder for RangeResult with information about range with "from", "limit" and "moreExist" values orderInput
- - OrderInput object with information about sorting field name and direction orderResult
- - Holder for OrderResult with information about sorting field name and direction. List
of IAMKey
- list of keys with details about them(nodes, source, exp date)AsmManagementWs.ASMManagementWSFault
public void clearIAMCachedKeys() throws AsmManagementWs.ASMManagementWSFault
public void removeIAMCachedKeys(List<String> keyIds) throws AsmManagementWs.ASMManagementWSFault
keyIds
- - list of key IDs to be removedAsmManagementWs.ASMManagementWSFault
public byte[] createUsageReport(String passPhrase, String sinceDate) throws com.kobil.ssms.asm.logic.AsmLogicException, AsmManagementWs.ASMManagementWSFault, ParseException
passPhrase
- sinceDate
- com.kobil.ssms.asm.logic.AsmLogicException
AsmManagementWs.ASMManagementWSFault
ParseException
public boolean addAppBundleRequest(AddBundleRequestParam params) throws AsmManagementWs.ASMManagementWSFault
AsmManagementWs.ASMManagementWSFault
- ErrorCodes.MISSING_PARAMETER if app bundle request object or missing parameters of app bundle request null
ErrorCodes.ADD_APP_BUNDLE_REQUEST_FAILED dont create app bundle request
ErrorCodes.GENERAL_ERROR if an internal error occurs.Copyright © 2022 KOBIL Systems GmbH. All rights reserved.