org.cyclos.services.access

Interface TokenService

All Superinterfaces:

CRUDService<TokenDTO,TokenData,TokenDataParams>, Service

All Known Subinterfaces:

TokenServiceLocal

public interface TokenService
extends CRUDService<TokenDTO,TokenData,TokenDataParams>

Service for managing tokens, NFC tokens and NFC devices

Author:

jcomas, ameyer

Method Summary

Methods

Modifier and Type	Method and Description
ActivateNFCDeviceDTO	activateNFCDevice(NFCDeviceActionDTO dto) Activates the specified NFC device for the logged user (e.g.: to make payments).
ActivateNFCTagDTO	activateNFCTag(NFCTagActionDTO dto) Generates personalized data to be stored in a NFC tag for the specified user.
void	activatePending(java.lang.Long tokenId) Activates the given token.
void	assign(TokenActionDTO dto) Assigns and activates an unassigned token with the given type and value for the logged user.
void	block(java.lang.Long tokenId) Blocks the given token
void	cancel(java.lang.Long tokenId) Cancels the given token
void	cancelNFCDevice(TokenActionDTO dto) Cancels the specified NFC device for the logged user.
void	cancelNFCTag(NFCTagActionDTO dto) Cancels the a NFC tag.
ActivateNFCDeviceData	getActivateNFCDeviceData() Returns the data needed to allow the personalization of a NFC device for the logged user.
ActivateNFCTagData	getActivateNFCTagData(UserLocatorVO locator) Returns the data needed to allow the personalization of a NFC tag for the specified user locator.
TokensListData	getListData(TokenPrincipalTypeVO tokenType, UserLocatorVO user) Returns data for listing tokens of a given type and user
TokenSearchData	getSearchData(TokenPrincipalTypeVO tokenType) Returns data for searching tokens
ExternalNFCTagAuthenticateData	requestForExternalAuthenticate(ExternalNFCTagAuthenticateDTO dto) 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 on in the following order: Validate the identity of the server: external authenticate Validate the identity of the card: internal authenticate
void	requestNewOTPForActivateNFCTag(UserLocatorVO locator, TokenPrincipalTypeVO tokenType, OTPSendMedium 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 for the BuiltInChannel.POS channel for the specified user. It has the same security controls as for activateNFCTag(NFCTagActionDTO), that is the logged user must be allowed to personalize a NFC Tag for the specified user.
Page<TokenVO>	search(TokenQuery query) Searches for tokens
void	unblock(java.lang.Long tokenId) Unblocks the given token

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

activateNFCDevice

ActivateNFCDeviceDTO activateNFCDevice(NFCDeviceActionDTO dto)
                                       throws FrameworkException

Activates the specified NFC device for the logged user (e.g.: to make payments).

Returns:

a dto containing, among other things, a hexadecimal string representing the private key generated for the specified device that must be stored on it for further use.

Throws:

FrameworkException

activateNFCTag

ActivateNFCTagDTO activateNFCTag(NFCTagActionDTO dto)
                                 throws FrameworkException

Generates personalized data to be stored in a NFC tag for the specified user.

Returns:

a dto containing, among other things, a hexadecimal string representing the private key generated for the specified tag that must be stored on it for further user.

Throws:

FrameworkException

activatePending

void activatePending(java.lang.Long tokenId)
                     throws FrameworkException

Activates the given token. This operation can only be done by admins or brokers over tokens of managed users.

Throws:

FrameworkException

assign

void assign(TokenActionDTO dto)
            throws FrameworkException,
                   MaxTokenActivationAttemptsException,
                   InvalidTokenException

Assigns and activates an unassigned token with the given type and value for the logged user.

Throws:

FrameworkException

MaxTokenActivationAttemptsException

InvalidTokenException

block

void block(java.lang.Long tokenId)
           throws FrameworkException

Blocks the given token

Throws:

FrameworkException

cancel

void cancel(java.lang.Long tokenId)
            throws FrameworkException

Cancels the given token

Throws:

FrameworkException

cancelNFCDevice

void cancelNFCDevice(TokenActionDTO dto)
                     throws FrameworkException

Cancels the specified NFC device for the logged user.

Throws:

FrameworkException

cancelNFCTag

void cancelNFCTag(NFCTagActionDTO dto)
                  throws FrameworkException

Cancels the a NFC tag. Admins, brokers an members with permissions can cancels a NFC tag.

Throws:

FrameworkException

getActivateNFCDeviceData

ActivateNFCDeviceData getActivateNFCDeviceData()
                                               throws FrameworkException

Returns the data needed to allow the personalization of a NFC device for the logged user.

Throws:

FrameworkException

getActivateNFCTagData

ActivateNFCTagData getActivateNFCTagData(UserLocatorVO locator)
                                         throws FrameworkException

Returns the data needed to allow the personalization of a NFC tag for the specified user locator.

Throws:

FrameworkException

getListData

TokensListData getListData(TokenPrincipalTypeVO tokenType,
                         UserLocatorVO user)
                           throws FrameworkException

Returns data for listing tokens of a given type and user

Throws:

FrameworkException

getSearchData

TokenSearchData getSearchData(TokenPrincipalTypeVO tokenType)
                              throws FrameworkException

Returns data for searching tokens

Throws:

FrameworkException

requestForExternalAuthenticate

ExternalNFCTagAuthenticateData requestForExternalAuthenticate(ExternalNFCTagAuthenticateDTO dto)
                                                              throws FrameworkException

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 on in the following order:

• Validate the identity of the server: external authenticate
• Validate the identity of the card: internal authenticate

Parameters:

dto - contains the token type id, the token value and an encrypted challenge generated by the tag encoded as base64.

Returns:

a dto containing the user located using the pair <token type, token value> and an encrypted data (encoded as base64) containing a new challenge generated by the server (used to validate the identity of the card) plus the original challenge generated by the tag (used by the card to complete the server identity validation).

Throws:

FrameworkException

requestNewOTPForActivateNFCTag

void requestNewOTPForActivateNFCTag(UserLocatorVO locator,
                                  TokenPrincipalTypeVO tokenType,
                                  OTPSendMedium medium)
                                    throws FrameworkException,
                                           SmsSendingException

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 for the BuiltInChannel.POS channel for the specified user.
It has the same security controls as for activateNFCTag(NFCTagActionDTO), that is the logged user must be allowed to personalize a NFC Tag for the specified user.

Parameters:

-

medium - the medium used to send the OTP.

Throws:

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

FrameworkException

search

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

Searches for tokens

Throws:

FrameworkException

QueryParseException

unblock

void unblock(java.lang.Long tokenId)
             throws FrameworkException

Unblocks the given token

Throws:

FrameworkException