public class KernelManagementWs extends Object
Modifier and Type | Class and Description |
---|---|
static class |
KernelManagementWs.ErrorCodes
Enum with all possible error codes listed.
|
static class |
KernelManagementWs.KernelManagementWSFault
Own exception class for the KernelManagementWs soap interface.
|
Constructor and Description |
---|
KernelManagementWs() |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptTenantDeactivation()
Accepts Tenant Deactivation Request.
|
boolean |
activateRole(String roleName)
active Role.
|
boolean |
activateTenant(String subTenantId)
Activates Tenant.
|
void |
addGroup(String groupName)
Adds a group to SSMS.
|
boolean |
addOperator(KernelOperator operator) |
boolean |
addOperatorRequest(KernelOperatorRequest operatorReq) |
void |
addPortalService(PortalServiceParam newPortal)
Adds Portal Service.
|
boolean |
addRenewCerticicateRequest(AddRenewEventRequestParams requestParam) |
boolean |
addRole(AddRoleParam addRoleParam)
Adds Role.
|
boolean |
addRolePermissions(String permission,
String roleName)
Deprecated.
below role_permissions is changed or divided to sub-role permissions so they will be removed in coming releases.
SSMS_USER_VIEW
SSMS_ADVANCED_SETTINGS_VIEW
Please use new role permissions instead of deprecated ones.
SSMS_USER_VIEW --> KERNEL_USER_VIEW
SSMS_ADVANCED_SETTINGS_VIEW --> each module own advance settings permissions.(KERNEL_ADVANCED_SETTINGS_VIEW,
ASM_ADVANCED_SETTINGS_VIEW,PAM_ADVANCED_SETTINGS_VIEW, SECOVID_ADVANCED_SETTINGS_VIEW,SOM_ADVANCED_SETTINGS_VIEW )
|
boolean |
addTenant(AddKernelTenantParam kernelTenantParam)
Adds Tenant.
|
boolean |
addTextResourcesKey(String moduleId,
String language,
String key,
String value)
This method can be add key from Text Resource tab on the Advance Settings page
|
boolean |
addUser(String userID)
Adds a new user to the database.
|
void |
assignGroupToUser(String groupName,
String userID)
Assigns a user to a group.
|
byte[] |
createServerSSLCertificate(byte[] certificateRequest,
byte[] caPassphrase)
This method creates an X.509 Server SSL certificate based on provided certificate signing request (CSR).
|
boolean |
deactivateRole(String roleName)
Deactive Role.
|
boolean |
deactivateTenant(String subTenantId)
Sends Deactivation Request to Tenant.
|
boolean |
deleteOperator(String issuerDn,
BigInteger certSN) |
void |
deletePortalService(String portalService)
Deletes Portal Service information.
|
boolean |
deleteRolePermissions(String permission,
String roleName)
Deprecated.
below role_permissions is changed or divided to sub-role permissions so they will be removed in coming releases.
SSMS_USER_VIEW
SSMS_ADVANCED_SETTINGS_VIEW
Please use new role permissions instead of deprecated ones.
SSMS_USER_VIEW --> KERNEL_USER_VIEW
SSMS_ADVANCED_SETTINGS_VIEW --> each module own advance settings permissions.(KERNEL_ADVANCED_SETTINGS_VIEW,
ASM_ADVANCED_SETTINGS_VIEW,PAM_ADVANCED_SETTINGS_VIEW, SECOVID_ADVANCED_SETTINGS_VIEW,SOM_ADVANCED_SETTINGS_VIEW )
|
boolean |
deleteTextResourcesKey(String moduleId,
String language,
String key)
This method can be delete key from Text Resource tab on the Advance Settings page
|
boolean |
deleteTextResourcesLanguage(String moduleId,
String language)
This method can be delete language from Text Resource tab on the Advance Settings page
|
boolean |
editOperator(EditOperatorParam operator)
This method are used edit operator.
|
boolean |
editTenant(EditKernelTenantParam editKernelTenantParam)
Updates Tenant.
|
byte[] |
exportRolePermissions()
Returns a XML byte array, containing all role permission settings.
|
byte[] |
exportTextResources(String moduleId,
String language)
This method can be export text resource data on the Advance Settings page
|
String |
getAdvancedSetting(SettingParam settingParam)
Returns the value of a module's Advanced Setting.
|
List<AdvancedSettingDto> |
getAdvancedSettings(List<SettingParam> settingParams)
Returns the values of Advanced Settings.
|
KernelAuditingInfo |
getAuditingItems(KernelAuditingFilter auditingFilter,
com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput,
Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination)
Returns entries of the SSMS auditing.
|
byte[] |
getDiagnostic()
Create the a file for get diagnostic information
|
List<EventRequestDTO> |
getEventRequests(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 list of event requests based on the filter provided.
|
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 group names in the database that are matching to the filter.
|
List<IamSettingDto> |
getIamSettings(List<String> settingNames)
Returns the values of IAM settings.
|
MonitoringResult |
getMonitoring(MonitoringParam monitoringParam)
Returns the monitoring data collected by the SSMS during the given time period.
|
List<com.kobil.ssms.kernel.presentation.b2b.SsmsNode> |
getNodes()
Retrieve information about all SSMS nodes.
|
List<OperatorDto> |
getOperators(OperatorFilter operatorFilter,
com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput,
Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination)
Returns list of operators based on the filter provided.
|
PortalServiceParam |
getPortalService(String portal)
Returns Portal Service for the given Portal-ID.
|
List<String> |
getPortalServices()
Returns list of Portal Services.
|
List<KernelRoleDto> |
getRoles(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 list of kernelRole based on the filter provided.
|
List<KernelTenantDto> |
getTenants(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 list of Tenants.
|
byte[] |
getTextResources(String moduleId,
String language)
Returns a resource bundle from the database.
|
String |
getUserGroup(String userID)
Retrieves the group name to which the given user is assigned to.
|
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 or range of userIDs that are matching to the given filter.
|
com.kobil.ssms.kernel.presentation.b2b.RangeResponse<String> |
getUsersPageable(String filter,
Integer currentPageNo,
Integer elementsPerPage)
Deprecated.
|
void |
importRolePermissions(byte[] rolePermissions)
Deprecated.
below role_permissions is changed or divided to sub-role permissions so they will be removed in coming releases.
SSMS_USER_VIEW
SSMS_ADVANCED_SETTINGS_VIEW
Please use new role permissions instead of deprecated ones.
SSMS_USER_VIEW --> KERNEL_USER_VIEW
SSMS_ADVANCED_SETTINGS_VIEW --> each module own advance settings permissions.(KERNEL_ADVANCED_SETTINGS_VIEW,
ASM_ADVANCED_SETTINGS_VIEW,PAM_ADVANCED_SETTINGS_VIEW, SECOVID_ADVANCED_SETTINGS_VIEW,SOM_ADVANCED_SETTINGS_VIEW )
|
boolean |
lockOperator(String issuerDN,
BigInteger certSN) |
void |
modifyGroup(String oldGroupName,
String newGroupName,
boolean removeAutoGroup)
Modify Group name and "auto group" flag of the given group.
|
boolean |
modifyRole(ModifyRoleParam modifyRoleParam)
Modify Role.
|
boolean |
rejectTenantDeactivation()
Rejects Deactivation Request.
|
void |
removeGroup(String groupName)
Removes a group from SSMS.
|
boolean |
removeRole(String ksRole)
Remove Role.
|
boolean |
removeUser(String userID)
Deletes a user from the database.
|
void |
renameUser(String userID,
String newUserID)
Rename a user.
|
boolean |
resumeTenant()
Resumes the current tenant.
|
void |
setAdvancedSetting(SetAdvancedSettingParam setAdvancedSettingParam)
Set the value of a module's Advanced Setting variable.
|
void |
setAdvancedSettings(List<SetAdvancedSettingParam> setAdvancedSettingParams)
Set the values for modules' Advanced Setting variables.
|
void |
setIamSettings(List<SetIamSettingParam> setIamSettingParams)
Set the values for IAM settings variables.
|
void |
storeTextResources(String moduleId,
String language,
byte[] contents)
Saves a resource bundle to the database.
|
boolean |
suspendTenant()
Suspends the Current Tenant.
|
void |
unassignGroupFromUser(String userID)
Unassigns a user from a group.
|
boolean |
unLockOperator(String issuerDN,
BigInteger certSN) |
boolean |
updateEventRequestStatus(String requestId,
String requestStatus,
String signerKeyPass,
String rejectReason) |
void |
updatePortalService(PortalServiceParam newPortal)
Updates Portal Service information.
|
public boolean addUser(String userID) throws KernelManagementWs.KernelManagementWSFault
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 database.false
if the user already exists.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is SSMS_USER_MANAGE.KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.KernelManagementWs.ErrorCodes.USERID_INVALID
public void renameUser(String userID, String newUserID) throws KernelManagementWs.KernelManagementWSFault
userID
- The name of user to be renamed.newUserID
- The new user name.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is SSMS_USER_MANAGE.KernelManagementWs.ErrorCodes.USERID_CHANGE_NOT_ALLOWED
if change of userID is not allowed by SSMS.KernelManagementWs.ErrorCodes.USER_NOT_FOUND
if a user with given userID is not found in the SSMS database.KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.KernelManagementWs.ErrorCodes.USER_ALREADY_EXISTS
if a user with given newUserID already exists in the SSMS database.KernelManagementWs.ErrorCodes.USERID_INVALID
public List<com.kobil.ssms.kernel.presentation.b2b.SsmsNode> getNodes() throws KernelManagementWs.KernelManagementWSFault
SsmsNode
objects.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is KERNEL_VIEW.KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occur.public boolean removeUser(String userID) throws KernelManagementWs.KernelManagementWSFault
userID
- The userID of an existing user in SSMS.true
if the user was successfully removed from the databasefalse
if the user does not exist in the databaseKernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is SSMS_USER_MANAGE.KernelManagementWs.ErrorCodes.USERID_INVALID
if the userID is null or empty.KernelManagementWs.ErrorCodes.USER_DELETION_PROHIBITED
if one or more existing assignments prohibit the deletion of the user.
KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public 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 KernelManagementWs.KernelManagementWSFault
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 KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.FILTER_INVALID
if the filter is null, empty or invalid. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.@Deprecated public com.kobil.ssms.kernel.presentation.b2b.RangeResponse<String> getUsersPageable(String filter, Integer currentPageNo, Integer elementsPerPage) throws KernelManagementWs.KernelManagementWSFault
RangeResponseDto
containing a list of matching userIDs and flag that indicates
whether additional user login ids are available on the next page.filter
- currentPageNo
- - index of page. Numerations starts from 1.elementsPerPage
- - max number of userLoginIds in each pageRangeResponseDto
- DTO with list of users and flag whether next page will be emptyKernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.FILTER_INVALID
if the filter is null, empty or invalid. KernelManagementWs.ErrorCodes.PARAMETER_INVALID
if currentPageNo and/or elementsPerPage are null or <0. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void addGroup(String groupName) throws KernelManagementWs.KernelManagementWSFault
groupName
- Unique name of a new group. KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.GROUP_NAME_INVALID
if group name is empty. KernelManagementWs.ErrorCodes.GROUP_NAME_NOT_START_WITH_AUTO_GROUP
if group name starts with the String "AUTO_GROUP". KernelManagementWs.ErrorCodes.GROUP_ALREADY_EXIST
if given group already exists in SSMS. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void modifyGroup(String oldGroupName, String newGroupName, boolean removeAutoGroup) throws KernelManagementWs.KernelManagementWSFault
oldGroupName
- Unique name of groupnewGroupName
- New unique name of groupremoveAutoGroup
- boolean flag to remove the "auto group" flag. Set to @true@ to remove the flag.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.GROUP_NAME_INVALID
if old/new group name is empty. KernelManagementWs.ErrorCodes.GROUP_NAME_NOT_START_WITH_AUTO_GROUP
if new group name start with the String "AUTO_GROUP". KernelManagementWs.ErrorCodes.GROUP_NOT_FOUND
if the given group does not exist in SSMS. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void removeGroup(String groupName) throws KernelManagementWs.KernelManagementWSFault
groupName
- Name of an existing groupKernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.GROUP_NAME_INVALID
if group name is empty. KernelManagementWs.ErrorCodes.GROUP_NOT_FOUND
if the given group does not exist in SSMS. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.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 KernelManagementWs.KernelManagementWSFault
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 KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.FILTER_INVALID
if the filter is null, empty or invalid. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public String getUserGroup(String userID) throws KernelManagementWs.KernelManagementWSFault
userID
- The user ID of an existing user in SSMS.null
is returned, if the user is not assigned to any group.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.USERID_INVALID
if userID is empty. KernelManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void assignGroupToUser(String groupName, String userID) throws KernelManagementWs.KernelManagementWSFault
groupName
- The group name of an existing group in SSMS.userID
- The user ID of an existing user in SSMS.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.GROUP_NAME_INVALID
if group name is empty. KernelManagementWs.ErrorCodes.GROUP_NOT_FOUND
if given group does not exist in SSMS. KernelManagementWs.ErrorCodes.USERID_INVALID
if userID is empty. KernelManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. KernelManagementWs.ErrorCodes.USER_ALREADY_ASSIGNED_TO_GROUP
if user is already assigned to a group. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void unassignGroupFromUser(String userID) throws KernelManagementWs.KernelManagementWSFault
userID
- The user ID of an existing user in SSMS.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.USERID_INVALID
if userID is empty. KernelManagementWs.ErrorCodes.USER_NOT_FOUND
if the requested user cannot be found. KernelManagementWs.ErrorCodes.USER_ALREADY_UNASSIGNED_FROM_GROUP
if the user not assigned to any group. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] createServerSSLCertificate(byte[] certificateRequest, byte[] caPassphrase) throws KernelManagementWs.KernelManagementWSFault
Access to this function requires permission KernelPermissions.SSMS_SERVER_SSL_CERT_CREATE.
certificateRequest
- caPassphrase
- KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
KernelManagementWs.ErrorCodes.PARAMETER_INVALID
KernelManagementWs.ErrorCodes.CERTIFICATE_SIGNING_REQUEST_INVALID
KernelManagementWs.ErrorCodes.CERTIFICATE_SIGNING_REQUEST_INVALID_SIGNATURE
KernelManagementWs.ErrorCodes.INVALID_SUBJECT_CN
KernelManagementWs.ErrorCodes.INVALID_IP_ADDRESS
KernelManagementWs.ErrorCodes.INVALID_PIN_FOR_CA
KernelManagementWs.ErrorCodes.CERT_CREATION_FAILED
KernelManagementWs.ErrorCodes.GENERAL_ERROR
public MonitoringResult getMonitoring(MonitoringParam monitoringParam) throws KernelManagementWs.KernelManagementWSFault
monitoringParam
- A MonitoringParam
object, containing all parameters needed to return the monitoring results.
For example you can specify the time period (from - to) of the monitoring results to be returned.MonitoringResult
object, monitoring result information.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is KERNEL_MONITORING_VIEW.KernelManagementWs.ErrorCodes.MISSING_PARAMETER
if the monitoringParam is null.KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public KernelAuditingInfo getAuditingItems(KernelAuditingFilter auditingFilter, com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput, Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination) throws KernelManagementWs.KernelManagementWSFault
KernelAuditingFilter
.auditingFilter
- A KernelAuditingFilter
object to filter the returned results. This filter must not be null.orderInput
- - OrderInput object with information about sorting field name and direction pagination
- - Holder for Pagination with information about order.
order is an object with information about sorting field name and direction. KernelAuditingInfo
entries.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is KERNEL_AUDITING_VIEW.KernelManagementWs.ErrorCodes.MISSING_PARAMETER
if the auditingFilter is null, or if the both dates KernelAuditingFilter.from and KernelAuditingFilter.to are nullKernelManagementWs.ErrorCodes.PARAMETER_INVALID
if date KernelAuditingFilter.to is before date KernelAuditingFilter.fromKernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean deleteOperator(String issuerDn, BigInteger certSN) throws KernelManagementWs.KernelManagementWSFault
issuerDn
- certSN
- KernelManagementWs.KernelManagementWSFault
- ErrorCodes.MISSING_PARAMETER if parameters not have null
ErrorCodes.FAILED_OPERATOR_FOUND not found ssl certificate for operator
ErrorCodes.FAILED_OPERATOR_REMOVE not remove ssl certificate for operatorpublic boolean addOperator(KernelOperator operator) throws KernelManagementWs.KernelManagementWSFault
operator
- RoleType
KernelManagementWs.KernelManagementWSFault
- ErrorCodes.MISSING_PARAMETER if operator object or missing parameters of operator null
ErrorCodes.ADD_OPERATOR_FAILED dont create operator
ErrorCodes.GENERAL_ERROR if an internal error occurs.
ErrorCodes.INVALID_ROLE_ID_OR_ROLE_NAME if roleName or roleId is incorrectpublic boolean editOperator(EditOperatorParam operator) throws KernelManagementWs.KernelManagementWSFault, com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException, com.kobil.ssms.kernel.logic.rolecertificatemanagement.RoleCertificateLogicException
KernelManagementWs.KernelManagementWSFault
- ErrorCodes.MISSING_PARAMETER if operator object or missing parameters of operator null
ErrorCodes.EDIT_OPERATOR_FAILED dont edit operator
ErrorCodes.GENERAL_ERROR if an internal error occurs.com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException
com.kobil.ssms.kernel.logic.rolecertificatemanagement.RoleCertificateLogicException
public boolean lockOperator(String issuerDN, BigInteger certSN) throws com.kobil.ssms.kernel.logic.rolecertificatemanagement.RoleCertificateLogicException, KernelManagementWs.KernelManagementWSFault
issuerDN
- certSN
- KernelManagementWs.KernelManagementWSFault
- ErrorCodes.MISSING_PARAMETER if operator object or missing parameters of operator null
ErrorCodes.EDIT_OPERATOR_FAILED don't edit operator
ErrorCodes.GENERAL_ERROR if an internal error occurs.com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException
com.kobil.ssms.kernel.logic.rolecertificatemanagement.RoleCertificateLogicException
public boolean unLockOperator(String issuerDN, BigInteger certSN) throws KernelManagementWs.KernelManagementWSFault, com.kobil.ssms.kernel.logic.rolecertificatemanagement.RoleCertificateLogicException
issuerDN
- certSN
- KernelManagementWs.KernelManagementWSFault
- ErrorCodes.MISSING_PARAMETER if operator object or missing parameters of operator null
ErrorCodes.EDIT_OPERATOR_FAILED don't edit operator
ErrorCodes.GENERAL_ERROR if an internal error occurs.com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException
com.kobil.ssms.kernel.logic.rolecertificatemanagement.RoleCertificateLogicException
public List<KernelRoleDto> getRoles(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 KernelManagementWs.KernelManagementWSFault
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 KernelRoleDto
entries containing KernelRoles information.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is SSMS_ROLE_VIEW.KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<OperatorDto> getOperators(OperatorFilter operatorFilter, com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput, Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination) throws KernelManagementWs.KernelManagementWSFault
operatorFilter
- An OperatorFilter
object to filter the returned results. The filter is optional, and so can be null.OperatorFilter
.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 OperatorDto
entries containing operator information. The result can be empty.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is SSMS_OPERATOR_VIEW.KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public byte[] exportRolePermissions() throws KernelManagementWs.KernelManagementWSFault
KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_ROLEPERMISSION_MANAGE.KernelManagementWs.ErrorCodes.ROLE_PERMISSION_EXPORT_FAILED
The creation of role permission XML data failed.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public boolean addRolePermissions(String permission, String roleName) throws KernelManagementWs.KernelManagementWSFault, com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException
permission
- You can enter permission on the this parameter For instance ASM_APP_BUNDLE, ASM_APP_VERSIONS_MANAGE etc.roleName
- You can enter role name on the this parameter For instance SUPER_ADMIN, ADMIN, HELPDESK and REVIEWER etc.com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException
KernelManagementWs.KernelManagementWSFault
public boolean deleteRolePermissions(String permission, String roleName) throws KernelManagementWs.KernelManagementWSFault
permission
- You can enter permission on the this parameter For instance ASM_APP_BUNDLE, ASM_APP_VERSIONS_MANAGE etc.roleName
- You can enter role name on the this parameter For instance SUPER_ADMIN, ADMIN, HELPDESK and REVIEWER etc.KernelManagementWs.KernelManagementWSFault
public void importRolePermissions(byte[] rolePermissions) throws KernelManagementWs.KernelManagementWSFault
rolePermissions
- the import data (XML formatted)KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_ROLEPERMISSION_MANAGE.KernelManagementWs.ErrorCodes.FAILED_PARSING_DATA
The given XML data could not be parsed.KernelManagementWs.ErrorCodes.ROLE_PERMISSION_IMPORT_FAILED
The import of the role permissions failed.KernelManagementWs.ErrorCodes.MISSING_PARAMETER
If the passed rolePermission is null.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public boolean addTenant(AddKernelTenantParam kernelTenantParam) throws KernelManagementWs.KernelManagementWSFault
kernelTenantParam
- The AddKernelTenantParam
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_TENANT_MANAGE.KernelManagementWs.ErrorCodes.INVALID_TENANT_ID
If invalid Tenant Id.KernelManagementWs.ErrorCodes.TENANT_ALREADY_EXIST
If tenant already exists.KernelManagementWs.ErrorCodes.INVALID_EMAIL
If invalid Email.KernelManagementWs.ErrorCodes.INVALID_CONTACT_PHONE
If invalid Phone.KernelManagementWs.ErrorCodes.INVALID_PASS_PHRASE
If invalid Passphrase.KernelManagementWs.ErrorCodes.PASS_PHRASES_NOT_SAME
If ConfirmPassPhrase not same as Passphrase.KernelManagementWs.ErrorCodes.INVALID_CA_KEY_STORE
If invalid CA-Keystore Passphrase.KernelManagementWs.ErrorCodes.INVALID_COMMON_NAME
If invalid Common Name.KernelManagementWs.ErrorCodes.INVALID_ORGANIZATION
If invalid Organisation.KernelManagementWs.ErrorCodes.INVALID_COUNTRY_CODE
If invalid Country Code.KernelManagementWs.ErrorCodes.DEFAULT_TENANT_ALREADY_EXIST
If default tenant already exists.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public boolean editTenant(EditKernelTenantParam editKernelTenantParam) throws KernelManagementWs.KernelManagementWSFault
editKernelTenantParam
- The EditKernelTenantParam
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_TENANT_MANAGE.KernelManagementWs.ErrorCodes.INVALID_TENANT_ID
If invalid Tenant Id.KernelManagementWs.ErrorCodes.INVALID_NEW_TENANT_ID
If tenant already exists.KernelManagementWs.ErrorCodes.TENANT_NOT_FOUND
If tenant not found.KernelManagementWs.ErrorCodes.INVALID_EMAIL
If invalid Email.KernelManagementWs.ErrorCodes.INVALID_CONTACT_PHONE
If invalid Phone.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public boolean deactivateTenant(String subTenantId) throws KernelManagementWs.KernelManagementWSFault
subTenantId
- sub-tenant's tenantId to deactivate.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_TENANT_MANAGE.KernelManagementWs.ErrorCodes.INVALID_TENANT_ID
If invalid Tenant Id.KernelManagementWs.ErrorCodes.TENANT_NOT_FOUND
If tenant not found.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public boolean activateTenant(String subTenantId) throws KernelManagementWs.KernelManagementWSFault
subTenantId
- sub-tenant's tenantId to activate.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_TENANT_MANAGE.KernelManagementWs.ErrorCodes.INVALID_TENANT_ID
If invalid Tenant Id.KernelManagementWs.ErrorCodes.TENANT_NOT_FOUND
If tenant not found.KernelManagementWs.ErrorCodes.FAILED_DUE_TO_MAX_PORTALS_RESTRICTIONS
If tenant reactivation will exceed portal license restrictions.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public boolean acceptTenantDeactivation() throws KernelManagementWs.KernelManagementWSFault
KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permissions: SSMS_TENANT_MANAGE, SSMS_EVENT_REQUEST_MANAGE.KernelManagementWs.ErrorCodes.INVALID_TENANT_ID
If invalid Tenant Id.KernelManagementWs.ErrorCodes.TENANT_NOT_FOUND
If tenant not found.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.KernelManagementWs.ErrorCodes.UPDATE_EVENT_REQUEST_STATUS_FAILED
If an error occurs during event request approval.public boolean rejectTenantDeactivation() throws KernelManagementWs.KernelManagementWSFault
KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permissions: SSMS_TENANT_MANAGE, SSMS_EVENT_REQUEST_MANAGE.KernelManagementWs.ErrorCodes.INVALID_TENANT_ID
If invalid Tenant Id.KernelManagementWs.ErrorCodes.TENANT_NOT_FOUND
If tenant not found.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.KernelManagementWs.ErrorCodes.UPDATE_EVENT_REQUEST_STATUS_FAILED
If an error occurs during event request rejection.public boolean addRole(AddRoleParam addRoleParam) throws KernelManagementWs.KernelManagementWSFault
addRoleParam
- The AddRoleParam
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.MISSING_PARAMETER
Parameter is not missing.KernelManagementWs.ErrorCodes.PERMISSION_ROLE_NOT_FOUND
Permissions of Role should be equal to roles.KernelManagementWs.ErrorCodes.ADD_ROLE_FAILED
Error, adding role failed.public boolean modifyRole(ModifyRoleParam modifyRoleParam) throws com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException, KernelManagementWs.KernelManagementWSFault
modifyRoleParam
- The ModifyRoleParam
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.MISSING_PARAMETER
Parameter is not missing.KernelManagementWs.ErrorCodes.ROLE_NAME_NOT_FOUND
Role not found.KernelManagementWs.ErrorCodes.MODIFY_ROLE_FAILED
Error, modifying role failed.com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException
public boolean removeRole(String ksRole) throws KernelManagementWs.KernelManagementWSFault
ksRole
- The string.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.MISSING_PARAMETER
Parameter is not missing.KernelManagementWs.ErrorCodes.ROLE_NAME_NOT_FOUND
Role not found.KernelManagementWs.ErrorCodes.REMOVE_ROLE_FAILED
Error, deleting role failed.public boolean deactivateRole(String roleName) throws KernelManagementWs.KernelManagementWSFault
roleName
- The roleName
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.MISSING_PARAMETER
Parameter is not missing.KernelManagementWs.ErrorCodes.ROLE_NAME_NOT_FOUND
Role not found on database public boolean activateRole(String roleName) throws KernelManagementWs.KernelManagementWSFault
roleName
- The roleName
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.MISSING_PARAMETER
Parameter is not missing.KernelManagementWs.ErrorCodes.ROLE_NAME_NOT_FOUND
Role not found on database public boolean suspendTenant() throws KernelManagementWs.KernelManagementWSFault
KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_TENANT_SUSPEND.KernelManagementWs.ErrorCodes.INVALID_TENANT_ID
If invalid Tenant Id.KernelManagementWs.ErrorCodes.TENANT_NOT_FOUND
If tenant not found.KernelManagementWs.ErrorCodes.TENANT_SUSPENDED
If tenant is in 'suspended' state.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public boolean resumeTenant() throws KernelManagementWs.KernelManagementWSFault
KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_TENANT_RESUME.KernelManagementWs.ErrorCodes.INVALID_TENANT_ID
If invalid Tenant Id.KernelManagementWs.ErrorCodes.TENANT_NOT_FOUND
If tenant not found.KernelManagementWs.ErrorCodes.TENANT_ALREADY_ACTIVED
If tenant is not in 'suspended' state.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public List<KernelTenantDto> getTenants(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 KernelManagementWs.KernelManagementWSFault
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 KernelTenantDto
objectsKernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_TENANT_VIEW.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public List<String> getPortalServices() throws KernelManagementWs.KernelManagementWSFault
String
KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_PORTAL_SERVICES_VIEW.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public PortalServiceParam getPortalService(String portal) throws KernelManagementWs.KernelManagementWSFault
PortalServiceParam
objectKernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_PORTAL_SERVICES_VIEW.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public void addPortalService(PortalServiceParam newPortal) throws KernelManagementWs.KernelManagementWSFault
newPortal
- The PortalServiceParam
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_PORTAL_SERVICES_MANAGE.KernelManagementWs.ErrorCodes.PORTAL_SERVICE_ALREADY_EXIST
If Portal service already exists.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public void updatePortalService(PortalServiceParam newPortal) throws KernelManagementWs.KernelManagementWSFault
newPortal
- The PortalServiceParam
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_PORTAL_SERVICES_MANAGE.KernelManagementWs.ErrorCodes.PORTAL_SERVICE_NOT_FOUND
If Portal Service not found.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public void deletePortalService(String portalService) throws KernelManagementWs.KernelManagementWSFault
portalService
- The PortalServiceParam
object.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
If the permission is denied. Required role permission is SSMS_PORTAL_SERVICES_MANAGE.KernelManagementWs.ErrorCodes.PORTAL_SERVICE_NOT_FOUND
If Portal Service not found.KernelManagementWs.ErrorCodes.GENERAL_ERROR
If an internal error occurs.public void setAdvancedSetting(SetAdvancedSettingParam setAdvancedSettingParam) throws KernelManagementWs.KernelManagementWSFault
setAdvancedSettingParam
- A SetAdvancedSettingParam
object to define the module and variable name and value.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.INVALID_FORMAT
if the value could not be transformed to the variable format or the setting type is not supported.KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if module ID is invalid or not installed. KernelManagementWs.ErrorCodes.PARAMETER_INVALID
if the SettingParam is invalid (SettingParam null; moduleId null or empty; settingName null or empty),
the settingName does not exist or the value is null or not valid.KernelManagementWs.ErrorCodes.MISSING_PARAMETER
if setAdvancedSettingParam is null. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void setAdvancedSettings(List<SetAdvancedSettingParam> setAdvancedSettingParams) throws KernelManagementWs.KernelManagementWSFault
setAdvancedSettingParams
- A List
of SetAdvancedSettingParam
to define the modules and variable-names and values.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.INVALID_FORMAT
if the value could not be transformed to the variable format or the setting type is not supported. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if module ID is invalid or not installed. KernelManagementWs.ErrorCodes.PARAMETER_INVALID
if the SettingParam is invalid (SettingParam null; moduleId null or empty; settingName null or empty),
the settingName does not exist or the value is null or not valid.KernelManagementWs.ErrorCodes.MISSING_PARAMETER
if setAdvancedSettingParams is null. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void setIamSettings(List<SetIamSettingParam> setIamSettingParams) throws KernelManagementWs.KernelManagementWSFault
setIamSettingParams
- A List
of SetIamSettingParam
to define the variable-names and values.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.INVALID_FORMAT
if the value could not be transformed to the variable format or the setting type is not supported. KernelManagementWs.ErrorCodes.PARAMETER_INVALID
if the settingName is null, blank or does not exist. KernelManagementWs.ErrorCodes.MISSING_PARAMETER
if setIamSettingParams is null. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<IamSettingDto> getIamSettings(List<String> settingNames) throws KernelManagementWs.KernelManagementWSFault
settingNames
- A List
of String to define the setting names.List
of IamSettingDto
.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.PARAMETER_INVALID
if the setting name is null, blank or does not exist. KernelManagementWs.ErrorCodes.MISSING_PARAMETER
if settingNames is null. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public String getAdvancedSetting(SettingParam settingParam) throws KernelManagementWs.KernelManagementWSFault
settingParam
- A SettingParam
object to define the module and variable-name.String
representation of the variable-value.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if module ID is invalid or not installed. KernelManagementWs.ErrorCodes.PARAMETER_INVALID
if the SettingParam is invalid (SettingParam null; moduleId null or empty; settingName null or empty)
or the settingName does not exist. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public List<AdvancedSettingDto> getAdvancedSettings(List<SettingParam> settingParams) throws KernelManagementWs.KernelManagementWSFault
settingParams
- A List
of SettingParam
to define the modules and variable-names.List
of AdvancedSettingDto
.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if module ID is invalid or not installed. KernelManagementWs.ErrorCodes.PARAMETER_INVALID
if the SettingParam is invalid (SettingParam null; moduleId null or empty; settingName null or empty)
or the settingName does not exist. KernelManagementWs.ErrorCodes.MISSING_PARAMETER
if settingParams is null. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public void storeTextResources(String moduleId, String language, byte[] contents) throws KernelManagementWs.KernelManagementWSFault
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).KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.LANGUAGE_INVALID
if the language is empty or invalid. KernelManagementWs.ErrorCodes.CONTENTS_INVALID
if the contents is null or empty. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if a module does not exist. public boolean deleteTextResourcesLanguage(String moduleId, String language) throws KernelManagementWs.KernelManagementWSFault
moduleId
- You can enter module name include this method (For instance: kernel, secovid etc.)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".KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.LANGUAGE_INVALID
if the language is null or empty or invalid. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if a module does not exist. public boolean addTextResourcesKey(String moduleId, String language, String key, String value) throws KernelManagementWs.KernelManagementWSFault
moduleId
- You can enter module name include this method (For instance: kernel, secovid etc.)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.key
- You must enter keyvalue
- You must enter valueKernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.LANGUAGE_INVALID
if the language is empty or invalid. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if a module does not exist. KernelManagementWs.ErrorCodes.TEXT_RESOURCE_KEY_INVALID
if a key is null or empty. KernelManagementWs.ErrorCodes.TEXT_RESOURCE_VALUE_INVALID
if a value is null or empty. KernelManagementWs.ErrorCodes.TEXT_RESOURCE_NOT_FOUND
if the text resource for given module ID and language not found. KernelManagementWs.ErrorCodes.CONTENTS_INVALID
if the contents is null or empty. public boolean deleteTextResourcesKey(String moduleId, String language, String key) throws KernelManagementWs.KernelManagementWSFault
moduleId
- You can enter module name include this method (For instance: kernel, secovid etc.)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.key
- You must enter keyKernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.LANGUAGE_INVALID
if the language is empty or invalid. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if a module does not exist. KernelManagementWs.ErrorCodes.TEXT_RESOURCE_KEY_INVALID
if a key is null or empty. KernelManagementWs.ErrorCodes.TEXT_RESOURCE_NOT_FOUND
if the text resource for given module ID and language not found. KernelManagementWs.ErrorCodes.CONTENTS_INVALID
if the contents is null or empty. KernelManagementWs.KernelManagementWSFault
public byte[] exportTextResources(String moduleId, String language) throws KernelManagementWs.KernelManagementWSFault
moduleId
- You can enter module name include this method (For instance: kernel, secovid etc.)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.KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.LANGUAGE_INVALID
if the language is empty or invalid. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurred. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if a module does not exist. KernelManagementWs.ErrorCodes.TEXT_RESOURCE_NOT_FOUND
if the text resource for given module ID and language not found. KernelManagementWs.KernelManagementWSFault
public byte[] getTextResources(String moduleId, String language) throws KernelManagementWs.KernelManagementWSFault
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.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. KernelManagementWs.ErrorCodes.LANGUAGE_INVALID
if the language is empty or invalid. KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs. KernelManagementWs.ErrorCodes.INVALID_MODULE_ID
if a module does not exist. public byte[] getDiagnostic() throws Exception
getDiagnostic
- hasn't any parameterException
public List<EventRequestDTO> getEventRequests(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 KernelManagementWs.KernelManagementWSFault
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 KernelEventRequest
entries containing event request information. The result can be empty.KernelManagementWs.KernelManagementWSFault
- KernelManagementWs.ErrorCodes.PERMISSION_DENIED
if the permission is denied. Required role permission is SSMS_OPERATOR_VIEW.KernelManagementWs.ErrorCodes.GENERAL_ERROR
if an internal error occurs.public boolean addOperatorRequest(KernelOperatorRequest operatorReq) throws KernelManagementWs.KernelManagementWSFault
KernelOperatorRequest
- KernelManagementWs.KernelManagementWSFault
- ErrorCodes.MISSING_PARAMETER if operator object or missing parameters of operator null
ErrorCodes.ADD_OPERATOR_FAILED dont create operator
ErrorCodes.GENERAL_ERROR if an internal error occurs.
ErrorCodes.INVALID_ROLE_ID_OR_ROLE_NAME if roleName or roleId is incorrectpublic boolean addRenewCerticicateRequest(AddRenewEventRequestParams requestParam) throws KernelManagementWs.KernelManagementWSFault, com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException, com.kobil.ssms.kernel.logic.rolecertificatemanagement.RoleCertificateLogicException
AddRenewEventRequestParams
- KernelManagementWs.KernelManagementWSFault
- ErrorCodes.MISSING_PARAMETER if AddRenewEventRequestParam object or missing parameters of event request null
ErrorCodes.ADD_RENEW_CERTIFICATE_REQUEST_FAILED don't create event request
ErrorCodes.GENERAL_ERROR if an internal error occurs.com.kobil.ssms.kernel.logic.rolepermission.RolePermissionLogicException
com.kobil.ssms.kernel.logic.rolecertificatemanagement.RoleCertificateLogicException
public boolean updateEventRequestStatus(String requestId, String requestStatus, String signerKeyPass, String rejectReason) throws KernelManagementWs.KernelManagementWSFault
requestId
- - string (required)requestStatus
- - string (required)signerKeyPass
- - stringrejectReason
- - stringKernelManagementWs.KernelManagementWSFault
- ErrorCodes.MISSING_PARAMETER if parameters not have null
ErrorCodes.UPDATE_EVENT_REQUEST_STATUS_FAILED
ErrorCodes.INVALID_EVENT_REQUEST_STATUS invalid value of new status
ErrorCodes.PERMISSION_DENIED only recipient user has permission to update statusCopyright © 2022 KOBIL Systems GmbH. All rights reserved.