Class MsKeyStoreManagementService

java.lang.Object

de.xima.fc.certificate.ms.impl.rpc.MsKeyStoreManagementService

All Implemented Interfaces:

RpcKeyStoreManagementService, RpcHandler, Serializable

public class MsKeyStoreManagementService
extends Object
implements RpcKeyStoreManagementService

Since:

13.03.25

Author:

tobias

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MsKeyStoreManagementService(SystemPersistenceManager spm, IDaoFactory daoFactory, IUserAccessController userAccessController, IAuditServiceFactory auditServiceFactory, ICertificateEventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
KeyStoreInfoDTO	createCustomKeyStore(NewKeyStoreDefinition newKeyStoreDefinition, CertificateManagementUser user)	Creates a new custom keystore with the specified name, description, assignee type, and assignee ID.
void	deleteKeyStore(Long keyStoreId, CertificateManagementUser user)	Deletes the keystore with the specified ID.
byte[]	exportKeyStore(Long keyStoreId, char[] password, CertificateManagementUser user)	Exports the keystore with the specified ID
Optional<KeyStoreInfoDTO>	findById(Long keyStoreId, CertificateManagementUser user)	Retrieves the keystore with the specified ID.
Optional<KeyStoreInfoDTO>	findByName(String name, KeyStoreScope scope, CertificateManagementUser user)	Retrieves the keystore with the specified name in the given scope if it exists.
KeyStoreInfoDTO	findByUserId(Long userId, CertificateManagementUser user)	Retrieves the keystore of the user with the specified ID.
Set<KeyStoreInfoDTO>	getAllByAssigneeType(Set<EAssigneeType> assigneeTypes, CertificateManagementUser user)	Retrieves a list of all keystores assigned to the specified type of assignee.
Set<KeyStoreInfoDTO>	getAllByKeyStoreScopes(Set<KeyStoreScope> keyStoreScopes, CertificateManagementUser user)	Retrieves a list of all keystores for the given scopes.
KeyStoreInfoDTO	getDefaultKeyStore(KeyStoreScope defaultScope, CertificateManagementUser user)	Retrieves the default keystore for the specified scope.
Set<CertificateInfoDTO>	getKeyStoreListing(Long keyStoreId, CertificateManagementUser user)	Retrieves a list of certificates stored in the specified keystore.

Methods inherited from class Object

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

Constructor Details

MsKeyStoreManagementService

public MsKeyStoreManagementService(SystemPersistenceManager spm,
 IDaoFactory daoFactory,
 IUserAccessController userAccessController,
 IAuditServiceFactory auditServiceFactory,
 ICertificateEventPublisher eventPublisher)

Method Details

createCustomKeyStore

public KeyStoreInfoDTO createCustomKeyStore(NewKeyStoreDefinition newKeyStoreDefinition,
 CertificateManagementUser user)
                                     throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Creates a new custom keystore with the specified name, description, assignee type, and assignee ID.

Specified by:

createCustomKeyStore in interface RpcKeyStoreManagementService

Parameters:

newKeyStoreDefinition - the definition of the new keystore to be created, containing the name, description, and scope.

user - the user who is creating the keystore.

Returns:

a KeyStoreInfoDTO object containing information about the created keystore.

Throws:

FcCertificateManagementException - if the keystore already exists for the specified name and/or scope or if the user does not have permission to create it.

deleteKeyStore

public void deleteKeyStore(Long keyStoreId,
 CertificateManagementUser user)
                    throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Deletes the keystore with the specified ID.

Specified by:

deleteKeyStore in interface RpcKeyStoreManagementService

Parameters:

keyStoreId - the ID of the keystore to delete.

user - the user who is deleting the keystore.

Throws:

FcCertificateManagementException - if the keystore does not exist, cannot be deleted, or if the user does not have permission to delete it.

exportKeyStore

public byte[] exportKeyStore(Long keyStoreId,
 char[] password,
 CertificateManagementUser user)
                      throws FcCertificateManagementException,
IOException

Description copied from interface: RpcKeyStoreManagementService

Exports the keystore with the specified ID

Specified by:

exportKeyStore in interface RpcKeyStoreManagementService

Parameters:

keyStoreId - the ID of the keystore to export.

password - the password to use for the keystore.

user - the user who is exporting the keystore.

Returns:

a byte array containing the exported keystore data.

Throws:

FcCertificateManagementException - if the keystore does not exist, cannot be exported, or if the user does not have permission to export it.

IOException

findById

public Optional<KeyStoreInfoDTO> findById(Long keyStoreId,
 CertificateManagementUser user)
                                   throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Retrieves the keystore with the specified ID.

Specified by:

findById in interface RpcKeyStoreManagementService

Parameters:

keyStoreId - the ID of the keystore to retrieve.

user - the user who is requesting the keystore.

Returns:

an Optional containing the KeyStoreInfoDTO object with the specified ID.

Throws:

FcCertificateManagementException - if the user does not have permission to access the keystore.

findByName

public Optional<KeyStoreInfoDTO> findByName(String name,
 KeyStoreScope scope,
 CertificateManagementUser user)
                                     throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Retrieves the keystore with the specified name in the given scope if it exists.

Specified by:

findByName in interface RpcKeyStoreManagementService

Parameters:

name - the name of the keystore to retrieve.

scope - the scope of the keystore to retrieve.

user - the user who is requesting the keystore.

Returns:

an Optional containing the KeyStoreInfoDTO object with the specified name and scope if it exists.

Throws:

FcCertificateManagementException - if the user does not have permission to access the keystore.

findByUserId

public KeyStoreInfoDTO findByUserId(Long userId,
 CertificateManagementUser user)
                             throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Retrieves the keystore of the user with the specified ID. There can only be one keystore per user, the default keystore. If the keystore does not exist, it will be created automatically.

Specified by:

findByUserId in interface RpcKeyStoreManagementService

Parameters:

userId - the ID of the user the keystore is assigned to.

user - the user who is requesting the keystore.

Returns:

a KeyStoreInfoDTO object containing information about the keystore.

Throws:

FcCertificateManagementException - if the user does not have permission to access the keystore.

getAllByAssigneeType

public Set<KeyStoreInfoDTO> getAllByAssigneeType(Set<EAssigneeType> assigneeTypes,
 CertificateManagementUser user)
                                          throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Retrieves a list of all keystores assigned to the specified type of assignee.

Specified by:

getAllByAssigneeType in interface RpcKeyStoreManagementService

Parameters:

assigneeTypes - the types of the assignee (e.g., user, group).

user - the user who is requesting the keystores.

Returns:

a set of KeyStoreInfoDTO objects containing information about the keystores assigned to the specified assignee if the user has permission to access them.

Throws:

FcCertificateManagementException - if an error occurs while retrieving the keystores.

getAllByKeyStoreScopes

public Set<KeyStoreInfoDTO> getAllByKeyStoreScopes(Set<KeyStoreScope> keyStoreScopes,
 CertificateManagementUser user)
                                            throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Retrieves a list of all keystores for the given scopes.

Note: If the default keystore for a given scope does not exist, it will be created automatically and returned with the list of keystores.

Specified by:

getAllByKeyStoreScopes in interface RpcKeyStoreManagementService

Parameters:

keyStoreScopes - the scopes of the keystores to retrieve.

user - the user who is requesting the keystores.

Returns:

a set of KeyStoreInfoDTO objects containing information about the keystores for the specified scopes if the user has permission to access them.

Throws:

FcCertificateManagementException - if an error occurs while retrieving the keystores.

getDefaultKeyStore

public KeyStoreInfoDTO getDefaultKeyStore(KeyStoreScope defaultScope,
 CertificateManagementUser user)
                                   throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Retrieves the default keystore for the specified scope. If the default keystore does not exist, it will be created.

Note: The default keystore is a special keystore that is automatically created for each scope. There can only be one default keystore per scope.

Specified by:

getDefaultKeyStore in interface RpcKeyStoreManagementService

Parameters:

defaultScope - the scope for which to retrieve the default keystore.

user - the user who is requesting the default keystore.

Returns:

a KeyStoreInfoDTO object containing information about the default keystore.

Throws:

FcCertificateManagementException - if the user does not have permission to access the keystore.

getKeyStoreListing

public Set<CertificateInfoDTO> getKeyStoreListing(Long keyStoreId,
 CertificateManagementUser user)
                                           throws FcCertificateManagementException

Description copied from interface: RpcKeyStoreManagementService

Retrieves a list of certificates stored in the specified keystore.

Specified by:

getKeyStoreListing in interface RpcKeyStoreManagementService

Parameters:

keyStoreId - the ID of the keystore.

user - the user who is requesting the certificate listing.

Returns:

a set of CertificateInfoDTO objects containing information about the certificates in the keystore if the user has permission to access them.

Throws:

FcCertificateManagementException