public class UserCertificateManagementWs extends Object
Modifier and Type | Class and Description |
---|---|
static class |
UserCertificateManagementWs.CertificateManagementWSFault
Own exception class for the soap interface CertificateManagement.
|
static class |
UserCertificateManagementWs.ErrorCodes
Class with all possible error codes listed.
|
Constructor and Description |
---|
UserCertificateManagementWs() |
Modifier and Type | Method and Description |
---|---|
boolean |
addCertificate(byte[] derEncodedCertificate)
Adds a DER encoded certificate to database.
|
boolean |
addUser(String userID)
Adds a new user to the database.
|
boolean |
assignCertificate(String issuerDN,
BigInteger serialNumber,
String userID)
Assigns a certificate to a user.
|
byte[] |
getCertificate(String issuerDN,
BigInteger serialNumber)
Returns the matching certificate.
|
List<com.kobil.ssms.svm.logic.SVMCertificateInfo> |
getCertificatesInfo(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 SVMCertificateInfo objects, that are matching
the filter.
|
String |
getUserByDEREncodedCertificate(byte[] derEncodedCertificate)
Returns the matching userID referenced by derEncodedCertificate.
|
String |
getUserByIssuerAndSerial(String issuerDN,
BigInteger serialNumber)
Returns the matching userID referenced by issuerDN and serial number.
|
boolean |
lockCertificate(String issuerDN,
BigInteger serialNumber,
String lockReason)
Changes an unlocked certificate to the state of locked.
|
boolean |
removeCertificate(String issuerDN,
BigInteger serialNumber)
Removes the certificate from database, referenced by
issuerDN and serial number.
|
boolean |
removeUser(String userID)
Removes an user from the database.
|
boolean |
unassignCertificate(String issuerDN,
BigInteger serialNumber)
Unassigns a certificate from a user.
|
boolean |
unlockCertificate(String issuerDN,
BigInteger serialNumber)
Changes a locked certificate to the state of unlocked.
|
public boolean addCertificate(byte[] derEncodedCertificate) throws UserCertificateManagementWs.CertificateManagementWSFault
derEncodedCertificate
- A DER encoded certificate.true
if the certificate was added successfully.false
if the certificate already exist.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.CERTIFICATE_INVALID
if the DER encoded certificate is null, empty or not decodable.
UserCertificateManagementWs.ErrorCodes.ISSUER_CERTIFICATE_NOT_FOUND
if the issuer certificate cannot be found.
UserCertificateManagementWs.ErrorCodes.VERIFICATION_FAILED
if the verification failed.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public boolean removeCertificate(String issuerDN, BigInteger serialNumber) throws UserCertificateManagementWs.CertificateManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.true
if the certificate was removed.false
if the certificate does not exist or the deletion is prohibited.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty.
UserCertificateManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public boolean assignCertificate(String issuerDN, BigInteger serialNumber, String userID) throws UserCertificateManagementWs.CertificateManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.userID
- The given userID.true
if the user was successfully assigned.false
if the user is already assigned to the certificate.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty.
UserCertificateManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null.
UserCertificateManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty.
UserCertificateManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found.
UserCertificateManagementWs.ErrorCodes.REQUESTED_USER_NOT_FOUND
if the requested user cannot be found.
UserCertificateManagementWs.ErrorCodes.CERTIFICATE_ALREADY_ASSIGNED_TO_DIFFERENT_USER
if the certificate is already assigned to a different user.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public boolean unassignCertificate(String issuerDN, BigInteger serialNumber) throws UserCertificateManagementWs.CertificateManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.true
if the user was successfully unassigned.false
if no user was assigned to the certificate or the unassignment is prohibited.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty.
UserCertificateManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null.
UserCertificateManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public boolean lockCertificate(String issuerDN, BigInteger serialNumber, String lockReason) throws UserCertificateManagementWs.CertificateManagementWSFault
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.
Default lock reasons are: retry.limit, pin.invalid, stolen, lost, defect, unknown.true
if an unlocked certificate is locked now.
false
if the certificate is already locked.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty.
UserCertificateManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null.
UserCertificateManagementWs.ErrorCodes.LOCK_REASON_INVALID
if the lock reason is null, empty or invalid.
UserCertificateManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public boolean unlockCertificate(String issuerDN, BigInteger serialNumber) throws UserCertificateManagementWs.CertificateManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.true
if a locked certificate is unlocked now.false
if the certificate is already unlocked.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty.
UserCertificateManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null.
UserCertificateManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public List<com.kobil.ssms.svm.logic.SVMCertificateInfo> getCertificatesInfo(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 UserCertificateManagementWs.CertificateManagementWSFault
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 UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.FILTER_INVALID
if the filter is null, empty or invalid.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public byte[] getCertificate(String issuerDN, BigInteger serialNumber) throws UserCertificateManagementWs.CertificateManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty.
UserCertificateManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null.
UserCertificateManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public String getUserByIssuerAndSerial(String issuerDN, BigInteger serialNumber) throws UserCertificateManagementWs.CertificateManagementWSFault
issuerDN
- The issuerDN of the certificate.serialNumber
- The serial number of the certificate.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.ISSUERDN_INVALID
if the issuer DN is null or empty.
UserCertificateManagementWs.ErrorCodes.SERIAL_NUMBER_INVALID
if the serial number is null.
UserCertificateManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found.
UserCertificateManagementWs.ErrorCodes.REQUESTED_USER_NOT_FOUND
if the requested user cannot be found.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public String getUserByDEREncodedCertificate(byte[] derEncodedCertificate) throws UserCertificateManagementWs.CertificateManagementWSFault
derEncodedCertificate
- a DER encoded certificate.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.CERTIFICATE_INVALID
if the DER encoded certificate is null, empty or not decodable.
UserCertificateManagementWs.ErrorCodes.REQUESTED_CERTIFICATE_NOT_FOUND
if the requested certificate cannot be found.
UserCertificateManagementWs.ErrorCodes.REQUESTED_USER_NOT_FOUND
if the requested user cannot be found.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public boolean addUser(String userID) throws UserCertificateManagementWs.CertificateManagementWSFault
userID
- The given userID.true
if the user was added.false
if the user already exist.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public boolean removeUser(String userID) throws UserCertificateManagementWs.CertificateManagementWSFault
userID
- The given userID.true
if the user was removed.false
if the user does not exist.UserCertificateManagementWs.CertificateManagementWSFault
- UserCertificateManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied.
UserCertificateManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty.
UserCertificateManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.Copyright © 2022 KOBIL Systems GmbH. All rights reserved.