Package org.cyclos.impl.access

Class TokenServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Token,QToken,TokenDTO,TokenData,TokenDataParams>

org.cyclos.impl.access.TokenServiceImpl

All Implemented Interfaces:

TokenServiceLocal, CRUDServiceLocal<Token,TokenDTO,TokenData,TokenDataParams>, TokenService, CRUDService<TokenDTO,TokenData,TokenDataParams>, CRUDWithConfirmationPasswordService<TokenDTO,TokenData,TokenDataParams>, Service

@Service
public class TokenServiceImpl
extends CRUDServiceImpl<Token,QToken,TokenDTO,TokenData,TokenDataParams>
implements TokenServiceLocal

implementation for TokenService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, 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
TokenServiceImpl()

Method Summary

Modifier and Type	Method	Description
Long	activate(TokenActionDTO dto, UserLocatorVO locator)	Searches for a token with the given type and value specified in the TokenActionDTO parameter. The token's status must be TokenStatus.UNASSIGNED orTokenStatus.PENDING_ACTIVATION but assigned to the logged user or one of its operators. If the token is unassigned then this method assigns it to the user specified by the UserLocatorVO parameter and change its status to TokenStatus.ACTIVE. Otherwise (the token is already assigned and is pending by activation) it activates only. This method can be used only by members (i.e.
void	activatePending(Long tokenId)	Activates an already assigned token with status TokenStatus.PENDING_ACTIVATION. This operation can only be done by admins/brokers over tokens of managed users or member over tokens of its operators with permission to activate the corresponding TokenPrincipalTypeVO.
void	assign(@NotNull Long tokenId, @NotNull UserLocatorVO locator)	Assigns a pending token to a user, leaving it in pending status The token status must be TokenStatus.UNASSIGNED.
SerializableInputStream	barcode(TokenBarcodeParams params)	Returns a barcode image of the token
void	block(Long tokenId)	Blocks the given token
void	cancel(Long tokenId)	Cancels the given token
void	cancel(Token token)
void	cancelAll(BasicUser user)	Cancels all active / blocked tokens of the given user
void	cancelNFCToken(TokenActionDTO dto)	Cancels the given NFC token.
DeviceConfirmationVO	createDeviceConfirmationForPersonalizeNFCTag(@NotNull UserLocatorVO locator, @NotNull TokenPrincipalTypeVO tokenTypeVO)	Creates a new pending device confirmation for the specified user.
SerializableInputStream	deviceConfirmationBarcodeForPersonalizeNFCTag(UserLocatorVO locator, @NotNull TokenPrincipalTypeVO tokenTypeVO, DeviceConfirmationBarcodeParams params)	Generates a two-dimensional barcode (QR code), only if the confirmation was not already approved nor rejected for the given payer.
long	expireTokens()	Takes all the tokens and switches their statuses to EXPIRED or ACTIVATION_EXPIRED for those who meet the conditions of these statuses.
FileInfo	exportTokens(@NotNull ExportFormatVO formatVO, @NotNull TokenQuery query)	Exports the token search results to file
Token	firstActive(BasicUser user, TokenPrincipalType type)	Returns the first token for the given basic user, whose status is TokenStatus.ACTIVE
void	generateOnRegistrationTokens(BasicUser user)	Generates the tokens that are configured to be generated upon registration
protected TokenData	getData(Token token)	Returns details data for the given entity
InitializeNFCTagData	getInitializeNFCTagData()	Returns data with the token types available to initialize a blank NFC tag. The available tokens to personalize the tag are returned too to allow initialization and personalization at the same time.
byte[]	getKeyMask(NFCToken nfcToken)	Returns the key mask used to encrypt/decrypt the nfc token's keys (AMK and Operational)
TokensListData	getListData(TokenPrincipalTypeVO tokenType, UserLocatorVO locator)	Returns data for listing tokens of a given type and user
PersonalizeNFCTagData	getPersonalizeNFCTagData(TokenPrincipalTypeVO tokenTypeVO, UserLocatorVO locator)	Returns data needed to personalize a NFC tag for the specified type and user. The PersonalizeNFCTagData.CONFIRMATION_PASSWORD_INPUT will be null if the logged user manages the given user.
List<TokenType>	getReceiveTokenTypes()	Returns a list with the token types used for receive payments
TokenSearchData	getSearchData(TokenPrincipalTypeVO tokenType)	Returns data for searching tokens
boolean	hasReachedMaxTokensPerUser(TokenPrincipalType type, BasicUser user, Token ignoredToken)	Returns if the given user has reached the maximum possible assigned tokens
InitializeNFCTagResult	initializeNFCTag(NFCTagInitializeDTO dto)	Initializes and optionally personalize a NFC tag with the given data.
Token	newEntity(TokenDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(Token token, Token currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(Token token, Token currentCopy)	May be overridden in order to perform custom logic before saving an entity.
void	personalizeNFCTag(NFCTagPersonalizeDTO dto)	Personalizes a NFC tag for the given user.
void	personalizeNFCTag(NFCTagWithChallengeDTO dto, BasicUser user)	Same as TokenService.personalizeNFCTag(NFCTagPersonalizeDTO) but for a new user being registered.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeDeviceConfirmationForPersonalizeNFCTag(@NotNull UserLocatorVO locator, @NotNull TokenPrincipalTypeVO tokenTypeVO, String deviceConfirmationId)	Removes a device confirmation for the given user.
ExternalNFCTagAuthenticateData	requestForExternalAuthenticate(ExternalNFCTagAuthenticateDTO dto)	This method must be invoked to start a mutual authentication process between the server and the NFC tag (e.g.
void	requestNewOTPForPersonalizeNFCTag(UserLocatorVO locator, TokenPrincipalTypeVO tokenTypeVO, SendMedium medium)	Generates a new OTP (removing any previous password, if any) and sends it to the user by the specified medium using the confirmation password type set for the BuiltInChannel.POS channel for the specified user. It has the same security controls as for TokenService.personalizeNFCTag(NFCTagPersonalizeDTO), that is the logged user must be allowed to personalize a NFC Tag for the specified user.
protected Validator	resolveValidator(TokenDTO dto)
Page<TokenVO>	search(TokenQuery params)	Searches for tokens.
void	setActivationDeadline(@NotNull Long tokenId, DateTime dateTime)	Changes the token activation deadline date.
protected void	setActivationDeadline(Token entity)
protected void	setExpiryAndActivationDate(Token entity)
void	setExpiryDate(@NotNull Long tokenId, DateTime dateTime)	Changes the token expiry date.
protected org.apache.commons.collections4.BidiMap<Class<? extends Token>,Class<? extends TokenDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.
TokenDTO	toDTO(Token entity)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
Token	toEntity(TokenDTO dto)	Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
void	unblock(Long tokenId)	Unblocks the given token
void	validateNFCChallenge(String challenge)	Validates the challenge received from a NFC tag/device ensuring it's the same as the previously generated by Cyclos.
DeviceConfirmationVO	viewDeviceConfirmationForPersonalizeNFCTag(@NotNull UserLocatorVO locator, @NotNull TokenPrincipalTypeVO tokenTypeVO, String deviceConfirmationId)	Loads the details of a confirmation belonging to the given user.

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, 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, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, 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, validate

Constructor Detail

TokenServiceImpl

public TokenServiceImpl()

Method Detail

activate

public Long activate(TokenActionDTO dto,
                     UserLocatorVO locator)
              throws MaxTokenActivationAttemptsException,
                     InvalidTokenException

Description copied from interface: TokenService

Searches for a token with the given type and value specified in the TokenActionDTO parameter.
The token's status must be TokenStatus.UNASSIGNED orTokenStatus.PENDING_ACTIVATION but assigned to the logged user or one of its operators.
If the token is unassigned then this method assigns it to the user specified by the UserLocatorVO parameter and change its status to TokenStatus.ACTIVE.
Otherwise (the token is already assigned and is pending by activation) it activates only.
This method can be used only by members (i.e. not administrators) with permission to activate the corresponding TokenPrincipalTypeVO. For administrators / brokers, see TokenService.activatePending(Long)

Specified by:

activate in interface TokenService

Throws:

MaxTokenActivationAttemptsException

InvalidTokenException

activatePending

public void activatePending(Long tokenId)

Description copied from interface: TokenService

Activates an already assigned token with status TokenStatus.PENDING_ACTIVATION.
This operation can only be done by admins/brokers over tokens of managed users or member over tokens of its operators with permission to activate the corresponding TokenPrincipalTypeVO.

Specified by:

activatePending in interface TokenService

assign

public void assign(@NotNull
                   @NotNull Long tokenId,
                   @NotNull
                   @NotNull UserLocatorVO locator)
            throws FrameworkException

Description copied from interface: TokenService

Assigns a pending token to a user, leaving it in pending status The token status must be TokenStatus.UNASSIGNED.

Specified by:

assign in interface TokenService

Throws:

FrameworkException

barcode

public SerializableInputStream barcode(TokenBarcodeParams params)
                                throws FrameworkException

Description copied from interface: TokenService

Returns a barcode image of the token

Specified by:

barcode in interface TokenService

Throws:

FrameworkException

block

public void block(Long tokenId)

Description copied from interface: TokenService

Blocks the given token

Specified by:

block in interface TokenService

cancel

public void cancel(Long tokenId)

Description copied from interface: TokenService

Cancels the given token

Specified by:

cancel in interface TokenService

cancel

public void cancel(Token token)

Specified by:

cancel in interface TokenServiceLocal

See Also:

TokenService.cancel(Long)

cancelAll

public void cancelAll(BasicUser user)

Description copied from interface: TokenServiceLocal

Cancels all active / blocked tokens of the given user

Specified by:

cancelAll in interface TokenServiceLocal

cancelNFCToken

public void cancelNFCToken(TokenActionDTO dto)

Description copied from interface: TokenService

Cancels the given NFC token. Admins and brokers with permissions can cancel a NFC token of type TokenType.NFC_TAG.
In case of a NFC token of type TokenType.NFC_DEVICE only the logged user can cancel its own token.

Specified by:

cancelNFCToken in interface TokenService

createDeviceConfirmationForPersonalizeNFCTag

public DeviceConfirmationVO createDeviceConfirmationForPersonalizeNFCTag(@NotNull
                                                                         @NotNull UserLocatorVO locator,
                                                                         @NotNull
                                                                         @NotNull TokenPrincipalTypeVO tokenTypeVO)
                                                                  throws FrameworkException

Description copied from interface: TokenService

Creates a new pending device confirmation for the specified user. The logged user will be notified after the confirmation was processed. It has the same security controls as for TokenService.personalizeNFCTag(NFCTagPersonalizeDTO), that is the logged user must be allowed to personalize a NFC Tag for the specified user.

Specified by:

createDeviceConfirmationForPersonalizeNFCTag in interface TokenService

tokenTypeVO - the principal type used to personalize the card

Throws:

FrameworkException

deviceConfirmationBarcodeForPersonalizeNFCTag

public SerializableInputStream deviceConfirmationBarcodeForPersonalizeNFCTag(UserLocatorVO locator,
                                                                             @NotNull
                                                                             @NotNull TokenPrincipalTypeVO tokenTypeVO,
                                                                             DeviceConfirmationBarcodeParams params)
                                                                      throws FrameworkException

Description copied from interface: TokenService

Generates a two-dimensional barcode (QR code), only if the confirmation was not already approved nor rejected for the given payer. It has the same security controls as for TokenService.personalizeNFCTag(NFCTagPersonalizeDTO), that is the logged user must be allowed to personalize a NFC Tag for the specified user.

Specified by:

deviceConfirmationBarcodeForPersonalizeNFCTag in interface TokenService

tokenTypeVO - the principal type used to personalize the card

Throws:

FrameworkException

expireTokens

public long expireTokens()

Description copied from interface: TokenServiceLocal

Takes all the tokens and switches their statuses to EXPIRED or ACTIVATION_EXPIRED for those who meet the conditions of these statuses.

Specified by:

expireTokens in interface TokenServiceLocal

exportTokens

public FileInfo exportTokens(@NotNull
                             @NotNull ExportFormatVO formatVO,
                             @NotNull
                             @NotNull TokenQuery query)
                      throws FrameworkException

Description copied from interface: TokenService

Exports the token search results to file

Specified by:

exportTokens in interface TokenService

Throws:

FrameworkException

firstActive

public Token firstActive(BasicUser user,
                         TokenPrincipalType type)
                  throws FrameworkException

Description copied from interface: TokenServiceLocal

Returns the first token for the given basic user, whose status is TokenStatus.ACTIVE

Specified by:

firstActive in interface TokenServiceLocal

Throws:

FrameworkException

generateOnRegistrationTokens

public void generateOnRegistrationTokens(BasicUser user)

Description copied from interface: TokenServiceLocal

Generates the tokens that are configured to be generated upon registration

Specified by:

generateOnRegistrationTokens in interface TokenServiceLocal

getInitializeNFCTagData

public InitializeNFCTagData getInitializeNFCTagData()
                                             throws FrameworkException

Description copied from interface: TokenService

Returns data with the token types available to initialize a blank NFC tag.
The available tokens to personalize the tag are returned too to allow initialization and personalization at the same time. Only allowed for managers (Brokers & Administrators).

Specified by:

getInitializeNFCTagData in interface TokenService

Throws:

FrameworkException

See Also:

TokenService.initializeNFCTag(NFCTagInitializeDTO)

getKeyMask

public byte[] getKeyMask(NFCToken nfcToken)

Description copied from interface: TokenServiceLocal

Returns the key mask used to encrypt/decrypt the nfc token's keys (AMK and Operational)

Specified by:

getKeyMask in interface TokenServiceLocal

getListData

public TokensListData getListData(TokenPrincipalTypeVO tokenType,
                                  UserLocatorVO locator)
                           throws FrameworkException

Description copied from interface: TokenService

Returns data for listing tokens of a given type and user

Specified by:

getListData in interface TokenService

Throws:

FrameworkException

getPersonalizeNFCTagData

public PersonalizeNFCTagData getPersonalizeNFCTagData(TokenPrincipalTypeVO tokenTypeVO,
                                                      UserLocatorVO locator)
                                               throws FrameworkException

Description copied from interface: TokenService

Returns data needed to personalize a NFC tag for the specified type and user.
The PersonalizeNFCTagData.CONFIRMATION_PASSWORD_INPUT will be null if the logged user manages the given user. The PersonalizeNFCTagData.TOKEN_TYPE is the token principal type the tag was initialized for.

Specified by:

getPersonalizeNFCTagData in interface TokenService

Throws:

FrameworkException

getReceiveTokenTypes

public List<TokenType> getReceiveTokenTypes()
                                     throws FrameworkException

Description copied from interface: TokenServiceLocal

Returns a list with the token types used for receive payments

Specified by:

getReceiveTokenTypes in interface TokenServiceLocal

Throws:

FrameworkException

getSearchData

public TokenSearchData getSearchData(TokenPrincipalTypeVO tokenType)

Description copied from interface: TokenService

Returns data for searching tokens

Specified by:

getSearchData in interface TokenService

hasReachedMaxTokensPerUser

public boolean hasReachedMaxTokensPerUser(TokenPrincipalType type,
                                          BasicUser user,
                                          Token ignoredToken)

Description copied from interface: TokenServiceLocal

Returns if the given user has reached the maximum possible assigned tokens

Specified by:

hasReachedMaxTokensPerUser in interface TokenServiceLocal

initializeNFCTag

public InitializeNFCTagResult initializeNFCTag(NFCTagInitializeDTO dto)
                                        throws FrameworkException,
                                               TokenAlreadyInUseException

Description copied from interface: TokenService

Initializes and optionally personalize a NFC tag with the given data. If the TokenActionWithUserDTO.getUser() is not null then the token will be personalized for that user too. Returns the private keys (PICC Master Key (i.e. PMK), Application Master Key (i.e. AMK) and Operational key) to be stored into the tag.
Only allowed for managers (Brokers & Administrators).

Specified by:

initializeNFCTag in interface TokenService

Throws:

FrameworkException

TokenAlreadyInUseException

newEntity

public Token newEntity(TokenDataParams params)

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<Token,TokenDTO,TokenData,TokenDataParams>

Specified by:

newEntity in class CRUDServiceImpl<Token,QToken,TokenDTO,TokenData,TokenDataParams>

personalizeNFCTag

public void personalizeNFCTag(NFCTagPersonalizeDTO dto)
                       throws FrameworkException,
                              TokenAlreadyInUseException

Description copied from interface: TokenService

Personalizes a NFC tag for the given user. If the logged user doesn't manages the user then the confirmation password of that user is required. This method requires a successful previous external authentication ( TokenService.requestForExternalAuthenticate(ExternalNFCTagAuthenticateDTO))
The required NFCTagPersonalizeDTO.CYCLOS_CHALLENGE is the encrypted (hexadecimal string) challenge generated by the server (returned in the previous external authenticate) used to ensure the tag presence (internal authenticate)

Specified by:

personalizeNFCTag in interface TokenService

Throws:

FrameworkException

TokenAlreadyInUseException

See Also:

TokenService.requestForExternalAuthenticate(ExternalNFCTagAuthenticateDTO)

personalizeNFCTag

public void personalizeNFCTag(NFCTagWithChallengeDTO dto,
                              BasicUser user)
                       throws FrameworkException,
                              TokenAlreadyInUseException

Description copied from interface: TokenServiceLocal

Same as TokenService.personalizeNFCTag(NFCTagPersonalizeDTO) but for a new user being registered.

Specified by:

personalizeNFCTag in interface TokenServiceLocal

Throws:

FrameworkException

TokenAlreadyInUseException

removeDeviceConfirmationForPersonalizeNFCTag

public void removeDeviceConfirmationForPersonalizeNFCTag(@NotNull
                                                         @NotNull UserLocatorVO locator,
                                                         @NotNull
                                                         @NotNull TokenPrincipalTypeVO tokenTypeVO,
                                                         String deviceConfirmationId)
                                                  throws FrameworkException

Description copied from interface: TokenService

Removes a device confirmation for the given user. It has the same security controls as for TokenService.personalizeNFCTag(NFCTagPersonalizeDTO), that is the logged user must be allowed to personalize a NFC Tag for the specified user.

Specified by:

removeDeviceConfirmationForPersonalizeNFCTag in interface TokenService

tokenTypeVO - the principal type used to personalize the card

Throws:

FrameworkException

requestForExternalAuthenticate

public ExternalNFCTagAuthenticateData requestForExternalAuthenticate(ExternalNFCTagAuthenticateDTO dto)
                                                              throws FrameworkException

Description copied from interface: TokenService

This method must be invoked to start a mutual authentication process between the server and the NFC tag (e.g. a card) to prove that both share the same secret key.
The authentication process is carried out in the following order:

• Validate the identity of the server: external authenticate
• Validate the identity of the NFc tag: internal authenticate

Specified by:

requestForExternalAuthenticate in interface TokenService

Parameters:

dto - contains the token type id (required), the token value (optional) and an encrypted challenge (required) generated by the tag in hexadecimal notation. If the token value is null then means the authentication process will be using the PICC Master Key (PMK).

Returns:

data containing the following:

• ExternalNFCTagAuthenticateData.CYCLOS_CHALLENGE: encrypted data (hexadecimal string) containing both: a new challenge generated by the server (used to validate the identity of the NFC tag, internal authenticate) and the original challenge generated by the tag processed according to the tag's authentication process. The (processed) original tag challenge will be used by the NFC tag to complete the server identity validation (external authenticate).
• ExternalNFCTagAuthenticateData.SESSION_KEY: A session key needed by the tag to allow send enciphered data to be written into the NFC tag

Throws:

FrameworkException

requestNewOTPForPersonalizeNFCTag

public void requestNewOTPForPersonalizeNFCTag(UserLocatorVO locator,
                                              TokenPrincipalTypeVO tokenTypeVO,
                                              SendMedium medium)
                                       throws FrameworkException,
                                              SmsSendingException

Description copied from interface: TokenService

Generates a new OTP (removing any previous password, if any) and sends it to the user by the specified medium using the confirmation password type set for the BuiltInChannel.POS channel for the specified user.
It has the same security controls as for TokenService.personalizeNFCTag(NFCTagPersonalizeDTO), that is the logged user must be allowed to personalize a NFC Tag for the specified user.

Specified by:

requestNewOTPForPersonalizeNFCTag in interface TokenService

tokenTypeVO - the principal type used to personalize the card

medium - the medium used to send the OTP.

Throws:

SmsSendingException - only if medium is SendMedium.SMS and the OTP could not be sent to any enabled for sms phone.

FrameworkException

search

public Page<TokenVO> search(TokenQuery params)
                     throws FrameworkException,
                            QueryParseException

Description copied from interface: TokenService

Searches for tokens. This method can only be user by administrators or brokers.

Specified by:

search in interface TokenService

Throws:

FrameworkException

QueryParseException

setActivationDeadline

public void setActivationDeadline(@NotNull
                                  @NotNull Long tokenId,
                                  DateTime dateTime)
                           throws FrameworkException

Description copied from interface: TokenService

Changes the token activation deadline date. The token status must be either TokenStatus.PENDING_ACTIVATION or TokenStatus.ACTIVATION_EXPIRED.

Specified by:

setActivationDeadline in interface TokenService

Throws:

FrameworkException

setExpiryDate

public void setExpiryDate(@NotNull
                          @NotNull Long tokenId,
                          DateTime dateTime)
                   throws FrameworkException

Description copied from interface: TokenService

Changes the token expiry date. The token status must be either TokenStatus.ACTIVE, TokenStatus.BLOCKED or TokenStatus.EXPIRED.

Specified by:

setExpiryDate in interface TokenService

Throws:

FrameworkException

toDTO

public TokenDTO toDTO(Token entity)

Description copied from class: CRUDServiceImpl

Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toDTO in interface CRUDServiceLocal<Token,TokenDTO,TokenData,TokenDataParams>

Overrides:

toDTO in class CRUDServiceImpl<Token,QToken,TokenDTO,TokenData,TokenDataParams>

toEntity

public Token toEntity(TokenDTO dto)

Description copied from class: CRUDServiceImpl

Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toEntity in interface CRUDServiceLocal<Token,TokenDTO,TokenData,TokenDataParams>

Overrides:

toEntity in class CRUDServiceImpl<Token,QToken,TokenDTO,TokenData,TokenDataParams>

unblock

public void unblock(Long tokenId)

Description copied from interface: TokenService

Unblocks the given token

Specified by:

unblock in interface TokenService

validateNFCChallenge

public void validateNFCChallenge(String challenge)
                          throws ValidationException

Description copied from interface: TokenServiceLocal

Validates the challenge received from a NFC tag/device ensuring it's the same as the previously generated by Cyclos.

Specified by:

validateNFCChallenge in interface TokenServiceLocal

Parameters:

challenge - the HEXA string send back by a NFC tag/device.

Throws:

ValidationException

viewDeviceConfirmationForPersonalizeNFCTag

public DeviceConfirmationVO viewDeviceConfirmationForPersonalizeNFCTag(@NotNull
                                                                       @NotNull UserLocatorVO locator,
                                                                       @NotNull
                                                                       @NotNull TokenPrincipalTypeVO tokenTypeVO,
                                                                       String deviceConfirmationId)
                                                                throws FrameworkException

Description copied from interface: TokenService

Loads the details of a confirmation belonging to the given user. It has the same security controls as for TokenService.personalizeNFCTag(NFCTagPersonalizeDTO), that is the logged user must be allowed to personalize a NFC Tag for the specified user.

Specified by:

viewDeviceConfirmationForPersonalizeNFCTag in interface TokenService

tokenTypeVO - the principal type used to personalize the card

Throws:

FrameworkException

getData

protected TokenData getData(Token token)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Token,QToken,TokenDTO,TokenData,TokenDataParams>

onAfterSave

protected void onAfterSave(Token token,
                           Token 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<Token,QToken,TokenDTO,TokenData,TokenDataParams>

onBeforeSave

protected Object onBeforeSave(Token token,
                              Token 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<Token,QToken,TokenDTO,TokenData,TokenDataParams>

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

resolveValidator

protected Validator resolveValidator(TokenDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Token,QToken,TokenDTO,TokenData,TokenDataParams>

setActivationDeadline

protected void setActivationDeadline(Token entity)

setExpiryAndActivationDate

protected void setExpiryAndActivationDate(Token entity)

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends Token>,Class<? extends TokenDTO>> 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<Token,QToken,TokenDTO,TokenData,TokenDataParams>