org.exoplatform.addon.ethereum.wallet.service

Interface WalletAccountService

public interface WalletAccountService

Method Summary

Modifier and Type	Method and Description
void	checkCanSaveWallet(Wallet wallet, Wallet storedWallet, String currentUser) Throws an exception if the user is not allowed to modify wallet information
void	enableWalletByAddress(String address, boolean enable, String currentUser) Enable/Disable User or Space wallet
Set<AddressLabel>	getAddressesLabelsVisibleBy(String currentUser) List of labels that current user can access
String	getPrivateKeyByTypeAndId(String type, String remoteId, String currentUser) Retrieve wallet private key by identity type and remoteId
Wallet	getWalletByAddress(String address) Retrieve wallet by address
Wallet	getWalletByIdentityId(long identityId) Retrieve wallet details by identity technical id
Wallet	getWalletByTypeAndId(String type, String remoteId) Retrieve wallet details by identity type and remoteId
Wallet	getWalletByTypeAndId(String type, String remoteId, String currentUser) Retrieve wallet details by identity type and remoteId accessed by a user
long	getWalletsCount() Retrieve wallets count
boolean	isWalletOwner(Wallet wallet, String currentUser) Return true if user is accessing his wallet or is accessing a space that he manages wallet
Set<Wallet>	listWallets() Retrieves the list registered wallets
void	removePrivateKeyByTypeAndId(String type, String remoteId, String currentUser) Removes wallet private key by identity type and remoteId
void	removeWalletByAddress(String address, String currentUser) Remove User or Space wallet address association
AddressLabel	saveOrDeleteAddressLabel(AddressLabel label, String currentUser) Saves label if label is not empty else, delete it
void	savePrivateKeyByTypeAndId(String type, String remoteId, String content, String currentUser) Save wallet private key for a wallet identified by identity type and remoteId
void	saveWalletAddress(Wallet wallet, String currentUser, boolean broadcast) Save wallet address to currentUser or to a space managed by current user
void	setInitializationStatus(String address, WalletInitializationState initializationState, String currentUserId) Change wallet initialization status

Method Detail

listWallets

Set<Wallet> listWallets()

Retrieves the list registered wallets

Returns:

list of associated wallets to users and spaces

getWalletsCount

long getWalletsCount()

Retrieve wallets count

Returns:

associated wallets count

getWalletByIdentityId

Wallet getWalletByIdentityId(long identityId)

Retrieve wallet details by identity technical id

Parameters:

identityId - User/Space identity technical id

Returns:

Wallet wallet details identified by identity technical id

getWalletByTypeAndId

Wallet getWalletByTypeAndId(String type,
                            String remoteId,
                            String currentUser)

Retrieve wallet details by identity type and remoteId accessed by a user

Parameters:

type - 'user' or 'space'

remoteId - username or space pretty name

currentUser - current username saving wallet private key

Returns:

Wallet wallet details identified by type and remote Id

getWalletByTypeAndId

Wallet getWalletByTypeAndId(String type,
                            String remoteId)

Retrieve wallet details by identity type and remoteId

Parameters:

type - 'user' or 'space'

remoteId - username or space pretty name

Returns:

Wallet wallet details identified by type and remote Id

savePrivateKeyByTypeAndId

void savePrivateKeyByTypeAndId(String type,
                               String remoteId,
                               String content,
                               String currentUser)
                        throws IllegalAccessException

Save wallet private key for a wallet identified by identity type and remoteId

Parameters:

type - 'user' or 'space'

remoteId - username or space pretty name

content - crypted private key

Throws:

IllegalAccessException - when the current user is not allowed to save the encrypted private key of wallet

getPrivateKeyByTypeAndId

String getPrivateKeyByTypeAndId(String type,
                                String remoteId,
                                String currentUser)
                         throws IllegalAccessException

Retrieve wallet private key by identity type and remoteId

Parameters:

type - 'user' or 'space'

remoteId - username or space pretty name

currentUser - current username getting wallet private key

Returns:

encrypted wallet private key identified by type and remote Id

Throws:

IllegalAccessException - when the current user is not allowed to get the encrypted private key of wallet

removePrivateKeyByTypeAndId

void removePrivateKeyByTypeAndId(String type,
                                 String remoteId,
                                 String currentUser)
                          throws IllegalAccessException

Removes wallet private key by identity type and remoteId

Parameters:

type - 'user' or 'space'

remoteId - username or space pretty name

currentUser - current username removing wallet private key

Throws:

IllegalAccessException - when the current user is not an owner of wallet

getWalletByAddress

Wallet getWalletByAddress(String address)

Retrieve wallet by address

Parameters:

address - address of wallet to retrieve

Returns:

Wallet wallet details identified by type and remote Id

saveWalletAddress

void saveWalletAddress(Wallet wallet,
                       String currentUser,
                       boolean broadcast)
                throws IllegalAccessException

Save wallet address to currentUser or to a space managed by current user

Parameters:

wallet - Wallet wallet details to save

currentUser - current username saving wallet details

broadcast - broadcast saving event or not

Throws:

IllegalAccessException - when the current user is not able to save a new address to the wallet

removeWalletByAddress

void removeWalletByAddress(String address,
                           String currentUser)
                    throws IllegalAccessException

Remove User or Space wallet address association

Parameters:

address - wallet address association to remove

currentUser - current username removing wallet details

Throws:

IllegalAccessException - if current user is not an administrator

enableWalletByAddress

void enableWalletByAddress(String address,
                           boolean enable,
                           String currentUser)
                    throws IllegalAccessException

Enable/Disable User or Space wallet

Parameters:

address - address of wallet to enable/disable

enable - whether enable or disable wallet

currentUser - username of current user making the operation

Throws:

IllegalAccessException - if current user is not an administrator

checkCanSaveWallet

void checkCanSaveWallet(Wallet wallet,
                        Wallet storedWallet,
                        String currentUser)
                 throws IllegalAccessException

Throws an exception if the user is not allowed to modify wallet information

Parameters:

wallet - wallet details to save

storedWallet - stored wallet in database

currentUser - current username that is making the modification

Throws:

IllegalAccessException - if current user is not allowed to modify wallet

isWalletOwner

boolean isWalletOwner(Wallet wallet,
                      String currentUser)

Return true if user is accessing his wallet or is accessing a space that he manages wallet

Parameters:

wallet -

currentUser -

Returns:

saveOrDeleteAddressLabel

AddressLabel saveOrDeleteAddressLabel(AddressLabel label,
                                      String currentUser)

Saves label if label is not empty else, delete it

Parameters:

label - label details object to process

currentUser - current user making the label creation/modification/deletion

Returns:

AddressLabel saved or deleted label details

getAddressesLabelsVisibleBy

Set<AddressLabel> getAddressesLabelsVisibleBy(String currentUser)

List of labels that current user can access

Parameters:

currentUser - current username accessing the list of addresses labels

Returns:

a Set of label details

setInitializationStatus

void setInitializationStatus(String address,
                             WalletInitializationState initializationState,
                             String currentUserId)
                      throws IllegalAccessException

Change wallet initialization status

Parameters:

address - wallet address

initializationState - wallet initialization status of type WalletInitializationState

currentUserId - user changing wallet status

Throws:

IllegalAccessException - if current user is not allowed to modify wallet initialization status