org.exoplatform.addon.ethereum.wallet.rest

Class EthereumWalletAccountREST

java.lang.Object

org.exoplatform.addon.ethereum.wallet.rest.EthereumWalletAccountREST

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

@RolesAllowed(value="users")
public class EthereumWalletAccountREST
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

This class provide a REST endpoint to retrieve detailed information about users and spaces with the associated Ethereum account addresses

Constructor Summary

Constructors

Constructor and Description
EthereumWalletAccountREST(EthereumWalletService ethereumWalletService, EthereumWalletAccountService accountService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	enableWalletByAddress(String address, boolean enable) Enable/Disable wallet
javax.ws.rs.core.Response	getWalletByAddress(String address) Retrieves the user or space details associated to an address
javax.ws.rs.core.Response	getWalletByTypeAndID(String remoteId, String type) Retrieves the user or space details by username or space pretty name
javax.ws.rs.core.Response	getWallets() Get list of wallet accounts
javax.ws.rs.core.Response	isFundRequestSent(String notificationId) Returns fund request status
javax.ws.rs.core.Response	markFundRequestAsSent(String notificationId) Mark a notification as sent
javax.ws.rs.core.Response	removeWalletByAddress(String address) Remove the user or space details associated to an address
javax.ws.rs.core.Response	requestFunds(FundsRequest fundsRequest) Sends a fund request notifications
javax.ws.rs.core.Response	saveAddress(Wallet wallet) Save address a user or space associated address
javax.ws.rs.core.Response	saveOrDeleteAddressLabel(AddressLabel label) Save wallet address label
javax.ws.rs.core.Response	savePreferences(WalletPreferences preferences) Save Wallet preferences

Methods inherited from class java.lang.Object

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

Constructor Detail

EthereumWalletAccountREST

public EthereumWalletAccountREST(EthereumWalletService ethereumWalletService,
                                 EthereumWalletAccountService accountService)

Method Detail

getWalletByTypeAndID

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getWalletByTypeAndID(String remoteId,
                                                                                   String type)

Retrieves the user or space details by username or space pretty name

Parameters:

remoteId - username or space pretty name

type - 'user' or 'space'

Returns:

Rest Response with wallet details object

getWalletByAddress

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getWalletByAddress(String address)

Retrieves the user or space details associated to an address

Parameters:

address - wallet address

Returns:

Rest Response with wallet details object

enableWalletByAddress

@RolesAllowed(value="administrators")
public javax.ws.rs.core.Response enableWalletByAddress(String address,
                                                                                             boolean enable)

Enable/Disable wallet

Parameters:

address - address of wallet to enable/disable

enable - if true enable wallet else disable it

Returns:

Rest Response of request

removeWalletByAddress

@RolesAllowed(value="administrators")
public javax.ws.rs.core.Response removeWalletByAddress(String address)

Remove the user or space details associated to an address

Parameters:

address - wallet address to remove

Returns:

Rest Response of request

saveAddress

@RolesAllowed(value="users")
public javax.ws.rs.core.Response saveAddress(Wallet wallet)

Save address a user or space associated address

Parameters:

wallet - wallet details to save

Returns:

Rest Response with saved pass phrase of wallet

saveOrDeleteAddressLabel

@RolesAllowed(value={"administrators","rewarding"})
public javax.ws.rs.core.Response saveOrDeleteAddressLabel(AddressLabel label)

Save wallet address label

Parameters:

label - a label details to save for a given address

Returns:

Rest Response with saved label detail

savePreferences

@RolesAllowed(value="users")
public javax.ws.rs.core.Response savePreferences(WalletPreferences preferences)

Save Wallet preferences

Parameters:

preferences - wallet preferences to save

Returns:

Rest Response of request

requestFunds

@RolesAllowed(value="users")
public javax.ws.rs.core.Response requestFunds(FundsRequest fundsRequest)

Sends a fund request notifications

Parameters:

fundsRequest - fund request details to send

Returns:

Rest Response of request

markFundRequestAsSent

@RolesAllowed(value="users")
public javax.ws.rs.core.Response markFundRequestAsSent(String notificationId)

Mark a notification as sent

Parameters:

notificationId - web notification id of fund request to mark as sent

Returns:

Rest Response of request

isFundRequestSent

@RolesAllowed(value="users")
public javax.ws.rs.core.Response isFundRequestSent(String notificationId)

Returns fund request status

Parameters:

notificationId - web notification id of fund request to check if sent

Returns:

Rest Response 'true' if sent else 'false'

getWallets

@RolesAllowed(value={"administrators","rewarding"})
public javax.ws.rs.core.Response getWallets()

Get list of wallet accounts

Returns:

Rest Responseof type json with the list of wallets