Package org.cyclos.impl.access

Class PrincipalTypeServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

org.cyclos.impl.access.PrincipalTypeServiceImpl

All Implemented Interfaces:

PrincipalTypeServiceLocal, CRUDServiceLocal<PrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>, PrincipalTypeService, CRUDService<PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>, CRUDWithConfirmationPasswordService<PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>, Service

@Service
public class PrincipalTypeServiceImpl
extends CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>
implements PrincipalTypeServiceLocal

Implementation for PrincipalTypeService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
PrincipalTypeServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomInternalNameValidations(Property internalName, PrincipalTypeDTO dto)	This method may be overridden to add custom validations for the INTERNAL_NAME property.
PrincipalType	find(String internalName, Network network)	Finds a principal by internal name in the specified network
BuiltInPrincipalType	getAccountNumber()	Returns the account number principal type
CustomFieldPrincipalType	getCustomField(UserCustomField field)	Returns the principal type for the given custom field
protected PrincipalTypeData	getData(PrincipalType principalType)	Returns details data for the given entity
BuiltInPrincipalType	getEmail()	Returns the e-mail principal type
BuiltInPrincipalType	getMobilePhone()	Returns the mobilePhone principal type
byte[]	getPiccMasterKey(NFCTokenPrincipalType nfcTokenPrincipalType)	Returns the encryption key set for the given NFCTokenPrincipalType.
BuiltInPrincipalType	getTrustedDevice()	Returns the trustedDevice principal type
BuiltInPrincipalType	getUsername()	Returns the username principal type
void	initialize()	Validated the NFC token type key
List<PrincipalTypeVO>	list()	List all available principal types
List<AccessClientPrincipalType>	listAccessClients()	Returns a list with all access clients
List<PrincipalType>	listAll()	Returns all principal types
List<PrincipalType>	listByNatures(PrincipalTypeNature... natures)	List the principal types filtering by principal type natures
List<TokenPrincipalType>	listByType(TokenType type)	List the token principal types filtering by token type
List<PrincipalType>	listForConfiguration(ConfigurationAccessor configuration, Channel channel, PrincipalTypeContext context)	Returns the principal types which can be used on channel configurations under the given channel and context
List<PrincipalType>	listForLogin()	Returns the principal types which can be used for login
List<PrincipalType>	listForLogin(ChannelConfiguration channelConfiguration)	Returns the principal types which can be used for login in the given channel configuration
List<TokenPrincipalType>	listTokens()
List<TokenPermissionsVO>	listUserTokenPermissions(BasicUser user)	Returns the permissions over tokens for the given user.
List<TokenPermissionsVO>	listUserTokenPermissions(UserGroup group, boolean asMember)	Returns the permissions over tokens on a user registration.
List<TokenPermissionsVO>	listUserTokenPermissions(UserLocatorVO user)	Returns the permissions over tokens for the given user.
List<AccessClientPrincipalType>	listVisibleAccessClients(User user)	Returns the access client types the logged user can see over the given user
PrincipalType	load(String internalName)	Loads a principal type by internal name
PrincipalType	newEntity(PrincipalTypeNature nature)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(PrincipalType entity, PrincipalType currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(PrincipalType entity, PrincipalType currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Class<? extends PrincipalTypeDTO>	resolveDTOType(PrincipalType entity)	Uses the CRUDServiceImpl.subClassMappings() mappings to find a suitable class for an EntityDTO for the given entity.
protected Class<? extends PrincipalType>	resolveEntityType(PrincipalTypeDTO dto)	Uses the CRUDServiceImpl.subClassMappings() mappings, find a suitable class for an BaseEntity according to the given dto.
protected Validator	resolveValidator(PrincipalTypeDTO dto)
void	sort(List<PrincipalType> principalTypes)	Sorts the given list of principal types according to the search order
protected org.apache.commons.collections4.BidiMap<Class<? extends PrincipalType>,Class<? extends PrincipalTypeDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, toDTO, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Constructor Detail

PrincipalTypeServiceImpl

public PrincipalTypeServiceImpl()

Method Detail

find

public PrincipalType find(String internalName,
                          Network network)

Description copied from interface: PrincipalTypeServiceLocal

Finds a principal by internal name in the specified network

Specified by:

find in interface PrincipalTypeServiceLocal

getAccountNumber

public BuiltInPrincipalType getAccountNumber()
                                      throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns the account number principal type

Specified by:

getAccountNumber in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

getCustomField

public CustomFieldPrincipalType getCustomField(UserCustomField field)
                                        throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns the principal type for the given custom field

Specified by:

getCustomField in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

getEmail

public BuiltInPrincipalType getEmail()
                              throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns the e-mail principal type

Specified by:

getEmail in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

getMobilePhone

public BuiltInPrincipalType getMobilePhone()
                                    throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns the mobilePhone principal type

Specified by:

getMobilePhone in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

getPiccMasterKey

public byte[] getPiccMasterKey(NFCTokenPrincipalType nfcTokenPrincipalType)

Description copied from interface: PrincipalTypeServiceLocal

Returns the encryption key set for the given NFCTokenPrincipalType. This plain key will be sent at NFCToken's initialization.

Specified by:

getPiccMasterKey in interface PrincipalTypeServiceLocal

See Also:

TokenService.initializeNFCTag(org.cyclos.model.access.tokens.NFCTagInitializeDTO)

getTrustedDevice

public BuiltInPrincipalType getTrustedDevice()
                                      throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns the trustedDevice principal type

Specified by:

getTrustedDevice in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

getUsername

public BuiltInPrincipalType getUsername()
                                 throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns the username principal type

Specified by:

getUsername in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

initialize

@PostConstruct
public void initialize()

Validated the NFC token type key

list

public List<PrincipalTypeVO> list()
                           throws FrameworkException

Description copied from interface: PrincipalTypeService

List all available principal types

Specified by:

list in interface PrincipalTypeService

Throws:

FrameworkException

listAccessClients

public List<AccessClientPrincipalType> listAccessClients()

Description copied from interface: PrincipalTypeServiceLocal

Returns a list with all access clients

Specified by:

listAccessClients in interface PrincipalTypeServiceLocal

listAll

public List<PrincipalType> listAll()
                            throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns all principal types

Specified by:

listAll in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

listByNatures

public List<PrincipalType> listByNatures(PrincipalTypeNature... natures)

Description copied from interface: PrincipalTypeServiceLocal

List the principal types filtering by principal type natures

Specified by:

listByNatures in interface PrincipalTypeServiceLocal

listByType

public List<TokenPrincipalType> listByType(TokenType type)

Description copied from interface: PrincipalTypeServiceLocal

List the token principal types filtering by token type

Specified by:

listByType in interface PrincipalTypeServiceLocal

listForConfiguration

public List<PrincipalType> listForConfiguration(ConfigurationAccessor configuration,
                                                Channel channel,
                                                PrincipalTypeContext context)
                                         throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns the principal types which can be used on channel configurations under the given channel and context

Specified by:

listForConfiguration in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

listForLogin

public List<PrincipalType> listForLogin()

Description copied from interface: PrincipalTypeServiceLocal

Returns the principal types which can be used for login

Specified by:

listForLogin in interface PrincipalTypeServiceLocal

listForLogin

public List<PrincipalType> listForLogin(ChannelConfiguration channelConfiguration)

Description copied from interface: PrincipalTypeServiceLocal

Returns the principal types which can be used for login in the given channel configuration

Specified by:

listForLogin in interface PrincipalTypeServiceLocal

listTokens

public List<TokenPrincipalType> listTokens()

listUserTokenPermissions

public List<TokenPermissionsVO> listUserTokenPermissions(BasicUser user)

Description copied from interface: PrincipalTypeServiceLocal

Returns the permissions over tokens for the given user. If the user is null, returns permissions over other managed users.

Specified by:

listUserTokenPermissions in interface PrincipalTypeServiceLocal

listUserTokenPermissions

public List<TokenPermissionsVO> listUserTokenPermissions(UserGroup group,
                                                         boolean asMember)

Description copied from interface: PrincipalTypeServiceLocal

Returns the permissions over tokens on a user registration. If the group is null, don't filter by enabled token types for that group.

Specified by:

listUserTokenPermissions in interface PrincipalTypeServiceLocal

listUserTokenPermissions

public List<TokenPermissionsVO> listUserTokenPermissions(UserLocatorVO user)
                                                  throws FrameworkException

Description copied from interface: PrincipalTypeService

Returns the permissions over tokens for the given user. If the user is null, returns permissions over other managed users.

Specified by:

listUserTokenPermissions in interface PrincipalTypeService

Throws:

FrameworkException

listVisibleAccessClients

public List<AccessClientPrincipalType> listVisibleAccessClients(User user)
                                                         throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Returns the access client types the logged user can see over the given user

Specified by:

listVisibleAccessClients in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

load

public PrincipalType load(String internalName)
                   throws FrameworkException

Description copied from interface: PrincipalTypeServiceLocal

Loads a principal type by internal name

Specified by:

load in interface PrincipalTypeServiceLocal

Throws:

FrameworkException

newEntity

public PrincipalType newEntity(PrincipalTypeNature nature)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<PrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

Specified by:

newEntity in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

sort

public void sort(List<PrincipalType> principalTypes)

Description copied from interface: PrincipalTypeServiceLocal

Sorts the given list of principal types according to the search order

Specified by:

sort in interface PrincipalTypeServiceLocal

addCustomInternalNameValidations

protected void addCustomInternalNameValidations(Property internalName,
                                                PrincipalTypeDTO dto)

Description copied from class: CRUDServiceImpl

This method may be overridden to add custom validations for the INTERNAL_NAME property.

Overrides:

addCustomInternalNameValidations in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

getData

protected PrincipalTypeData getData(PrincipalType principalType)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

onAfterSave

protected void onAfterSave(PrincipalType entity,
                           PrincipalType currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

onBeforeSave

protected Object onBeforeSave(PrincipalType entity,
                              PrincipalType currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveDTOType

protected Class<? extends PrincipalTypeDTO> resolveDTOType(PrincipalType entity)

Description copied from class: CRUDServiceImpl

Uses the CRUDServiceImpl.subClassMappings() mappings to find a suitable class for an EntityDTO for the given entity. When not found defaults to CRUDServiceImpl.dtoClass.

Overrides:

resolveDTOType in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

resolveEntityType

protected Class<? extends PrincipalType> resolveEntityType(PrincipalTypeDTO dto)

Description copied from class: CRUDServiceImpl

Uses the CRUDServiceImpl.subClassMappings() mappings, find a suitable class for an BaseEntity according to the given dto. When not found defaults to CRUDServiceImpl.entityClass

Overrides:

resolveEntityType in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

resolveValidator

protected Validator resolveValidator(PrincipalTypeDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends PrincipalType>,Class<? extends PrincipalTypeDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<PrincipalType,QPrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>