Package org.cyclos.security.banking

Class AccountServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.banking.AccountServiceSecurity

All Implemented Interfaces:

AccountService, Service

@Security
public class AccountServiceSecurity
extends BaseServiceSecurity
implements AccountService

Security layer for AccountService

Field Summary

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

Fields inherited from interface org.cyclos.services.banking.AccountService

MAX_BALANCE_HISTORY_DATAPOINTS

Constructor Summary

Constructors

Constructor	Description
AccountServiceSecurity()

Method Summary

Modifier and Type	Method	Description
void	checkAccessibleAccounts(InternalAccountOwner owner)
protected void	checkAccountHistoriesOverviewQuery(AccountHistoriesOverviewQuery params)
protected void	checkAccountHistoryQuery(AccountHistoryQuery params)
protected void	checkAccountLimitsOverviewQuery(AccountLimitsOverviewQuery params)
void	checkTransQuery(AbstractTransQuery query)
FileInfo	exportAccountBalanceLimitsOverview(@NotNull ExportFormatVO format, @NotNull AccountBalanceLimitsOverviewQuery params)	Generates a file with the query result listing the account balance limits
FileInfo	exportAccountHistoriesOverview(@NotNull ExportFormatVO format, @NotNull AccountHistoriesOverviewQuery params)	Exports the account histories overview result to file
FileInfo	exportAccountHistory(@NotNull ExportFormatVO format, @NotNull AccountHistoryQuery params)	Exports the account history result to file
FileInfo	exportAccountPaymentAmountLimitsOverview(@NotNull ExportFormatVO format, @NotNull AccountPaymentAmountLimitsOverviewQuery params)	Generates a file with the query result listing the account balance limits
FileInfo	exportUsersWithBalances(@NotNull ExportFormatVO format, @NotNull UserWithBalanceQuery params)	Generates a file with the query result listing the user balances
AccountBalanceHistoryVO	getAccountBalanceHistory(@NotNull AccountBalanceHistoryParams params)	Returns the balance at each data point for a given account.
AccountLimitsOverviewData	getAccountBalanceLimitsOverviewData()	Account limits (balance and payment amounts) overview data for performing searches.
AccountHistoriesOverviewData	getAccountHistoriesOverviewData()	Gets the details for viewing an account histories overview
AccountHistoriesOverviewStatusVO	getAccountHistoriesOverviewStatus(AccountHistoriesOverviewQuery params)	Returns the statuses by currency for the result of searching transactions with the given parameters
AccountHistoryData	getAccountHistoryData(AccountVO account, RateVisibility rateVisibility)	Gets the details for viewing an account history
AccountWithHistoryStatusVO	getAccountHistoryStatus(AccountHistoryQuery params)	Returns historic status for the account
AccountLimitsOverviewData	getAccountPaymentAmountLimitsOverviewData()	Account limits (balance and payment amounts) overview data for performing searches.
List<AccountWithStatusVO>	getAccountsSummary(InternalAccountOwner owner, DateTime dateTime)	Lists the visible accounts summary for the given account owner, with balances relative to the given date
AccountStatusVO	getAccountStatus(AccountVO account, DateTime dateTime, RateVisibility rateVisibility)	Gets the status for the given account
AccountWithStatusVO	getAccountWithStatus(AccountVO account, DateTime dateTime)	Returns the information of an account, with its status, by owner and type
AccountPermissionsData	getPermissions(@NotNull AccountVO account)	Returns permissions of what the logged user can do over the given account
UserAccountBalanceLimitData	getUserAccountBalanceLimitData(AccountVO vo)	Get an account limit data
UserAccountPaymentAmountLimitData	getUserAccountPaymentAmountLimitData(AccountVO vo)	Get an account payment amount limit data
List<AccountBalanceLimitVO>	getUserAccountsBalanceLimits(UserLocatorVO userLocator)	Returns the user accounts with their upper and lower balance limits
List<AccountPaymentAmountLimitVO>	getUserAccountsPaymentAmountLimits(UserLocatorVO userLocator)	Returns the user accounts with their upper and lower balance limits
UsersWithBalancesOverview	getUsersWithBalancesOverview(UserWithBalanceQuery params)	Returns the overview of users with balances according to the given query
UserWithBalanceSearchData	getUserWithBalanceSearchData()	Returns data to search for users with balances
boolean	isAccessible(Account account)
boolean	isAccessible(AccountLocator locator)
boolean	isAccessible(AccountVO account)
boolean	isAccessible(InternalAccountOwner owner, AccountType type)
AccountWithCurrencyVO	load(Long id)	Loads an account by id
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none
Page<AccountBalanceLimitVO>	searchAccountBalanceLimitsOverview(AccountBalanceLimitsOverviewQuery params)	Overview search of account balance limits
Page<AccountHistoryOverviewEntryVO>	searchAccountHistoriesOverview(AccountHistoriesOverviewQuery params)	Account histories overview filtered by the specified query parameters.
Page<AccountHistoryEntryVO>	searchAccountHistory(AccountHistoryQuery params)	Searches the history entries of a required visible account according to the given query parameters.
Page<AccountPaymentAmountLimitVO>	searchAccountPaymentAmountLimitsOverview(AccountPaymentAmountLimitsOverviewQuery params)	Overview search of account balance limits
Page<UserWithBalanceVO>	searchUsersWithBalances(UserWithBalanceQuery params)	Searches for users together with their respective account balances
void	setBalanceLimit(AccountBalanceLimitDTO data)	Change limits of an account
void	setPaymentAmountLimit(AccountPaymentAmountLimitDTO data)	Change limits of an account

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

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

Constructor Detail

AccountServiceSecurity

public AccountServiceSecurity()

Method Detail

checkAccessibleAccounts

public void checkAccessibleAccounts(InternalAccountOwner owner)

checkTransQuery

public void checkTransQuery(AbstractTransQuery query)

exportAccountBalanceLimitsOverview

public FileInfo exportAccountBalanceLimitsOverview(@NotNull
                                                   @NotNull ExportFormatVO format,
                                                   @NotNull
                                                   @NotNull AccountBalanceLimitsOverviewQuery params)
                                            throws FrameworkException

Description copied from interface: AccountService

Generates a file with the query result listing the account balance limits

Specified by:

exportAccountBalanceLimitsOverview in interface AccountService

Throws:

FrameworkException

exportAccountHistoriesOverview

public FileInfo exportAccountHistoriesOverview(@NotNull
                                               @NotNull ExportFormatVO format,
                                               @NotNull
                                               @NotNull AccountHistoriesOverviewQuery params)
                                        throws FrameworkException

Description copied from interface: AccountService

Exports the account histories overview result to file

Specified by:

exportAccountHistoriesOverview in interface AccountService

Throws:

FrameworkException

exportAccountHistory

public FileInfo exportAccountHistory(@NotNull
                                     @NotNull ExportFormatVO format,
                                     @NotNull
                                     @NotNull AccountHistoryQuery params)
                              throws FrameworkException

Description copied from interface: AccountService

Exports the account history result to file

Specified by:

exportAccountHistory in interface AccountService

Throws:

FrameworkException

exportAccountPaymentAmountLimitsOverview

public FileInfo exportAccountPaymentAmountLimitsOverview(@NotNull
                                                         @NotNull ExportFormatVO format,
                                                         @NotNull
                                                         @NotNull AccountPaymentAmountLimitsOverviewQuery params)
                                                  throws FrameworkException

Description copied from interface: AccountService

Generates a file with the query result listing the account balance limits

Specified by:

exportAccountPaymentAmountLimitsOverview in interface AccountService

Throws:

FrameworkException

exportUsersWithBalances

public FileInfo exportUsersWithBalances(@NotNull
                                        @NotNull ExportFormatVO format,
                                        @NotNull
                                        @NotNull UserWithBalanceQuery params)
                                 throws FrameworkException

Description copied from interface: AccountService

Generates a file with the query result listing the user balances

Specified by:

exportUsersWithBalances in interface AccountService

Throws:

FrameworkException

getAccountBalanceHistory

public AccountBalanceHistoryVO getAccountBalanceHistory(@NotNull
                                                        @NotNull AccountBalanceHistoryParams params)
                                                 throws FrameworkException

Description copied from interface: AccountService

Returns the balance at each data point for a given account. The account and status are also returned. For example, if the account had 50 transfers over 1 month, but in 20 distinct days of the month, and the request was to return for the month, with a balance per day, there will be 21 entries (the balance on the first day, plus the 20 days that had changed) When no period is given, or if the begin date was before the account creation, it is assumed since the day the account was created. The possible periods for data points are: - Months - Weeks - Days The maximum number of data points cannot exceed 61. So, for example, if the requested period is 1 year, it is possible to request balances per month or week (there's about 52 weeks in a year), but not days.

Specified by:

getAccountBalanceHistory in interface AccountService

Throws:

FrameworkException

getAccountBalanceLimitsOverviewData

public AccountLimitsOverviewData getAccountBalanceLimitsOverviewData()
                                                              throws FrameworkException

Description copied from interface: AccountService

Account limits (balance and payment amounts) overview data for performing searches.

Specified by:

getAccountBalanceLimitsOverviewData in interface AccountService

Throws:

FrameworkException

getAccountHistoriesOverviewData

public AccountHistoriesOverviewData getAccountHistoriesOverviewData()

Description copied from interface: AccountService

Gets the details for viewing an account histories overview

Specified by:

getAccountHistoriesOverviewData in interface AccountService

getAccountHistoriesOverviewStatus

public AccountHistoriesOverviewStatusVO getAccountHistoriesOverviewStatus(AccountHistoriesOverviewQuery params)

Description copied from interface: AccountService

Returns the statuses by currency for the result of searching transactions with the given parameters

Specified by:

getAccountHistoriesOverviewStatus in interface AccountService

getAccountHistoryData

public AccountHistoryData getAccountHistoryData(AccountVO account,
                                                RateVisibility rateVisibility)

Description copied from interface: AccountService

Gets the details for viewing an account history

Specified by:

getAccountHistoryData in interface AccountService

rateVisibility - if null RateVisibility.NOT is used

getAccountHistoryStatus

public AccountWithHistoryStatusVO getAccountHistoryStatus(AccountHistoryQuery params)
                                                   throws FrameworkException

Description copied from interface: AccountService

Returns historic status for the account

Specified by:

getAccountHistoryStatus in interface AccountService

Throws:

FrameworkException

getAccountPaymentAmountLimitsOverviewData

public AccountLimitsOverviewData getAccountPaymentAmountLimitsOverviewData()
                                                                    throws FrameworkException

Description copied from interface: AccountService

Account limits (balance and payment amounts) overview data for performing searches.

Specified by:

getAccountPaymentAmountLimitsOverviewData in interface AccountService

Throws:

FrameworkException

getAccountsSummary

public List<AccountWithStatusVO> getAccountsSummary(InternalAccountOwner owner,
                                                    DateTime dateTime)
                                             throws FrameworkException

Description copied from interface: AccountService

Lists the visible accounts summary for the given account owner, with balances relative to the given date

Specified by:

getAccountsSummary in interface AccountService

Throws:

FrameworkException

getAccountStatus

public AccountStatusVO getAccountStatus(AccountVO account,
                                        DateTime dateTime,
                                        RateVisibility rateVisibility)

Description copied from interface: AccountService

Gets the status for the given account

Specified by:

getAccountStatus in interface AccountService

rateVisibility - if null RateVisibility.NOT is used

getAccountWithStatus

public AccountWithStatusVO getAccountWithStatus(AccountVO account,
                                                DateTime dateTime)
                                         throws FrameworkException

Description copied from interface: AccountService

Returns the information of an account, with its status, by owner and type

Specified by:

getAccountWithStatus in interface AccountService

Throws:

FrameworkException

getPermissions

public AccountPermissionsData getPermissions(@NotNull
                                             @NotNull AccountVO account)
                                      throws FrameworkException

Description copied from interface: AccountService

Returns permissions of what the logged user can do over the given account

Specified by:

getPermissions in interface AccountService

Throws:

PermissionDeniedException - if the given account is not managed by the authenticated user

FrameworkException

getUserAccountBalanceLimitData

public UserAccountBalanceLimitData getUserAccountBalanceLimitData(AccountVO vo)

Description copied from interface: AccountService

Get an account limit data

Specified by:

getUserAccountBalanceLimitData in interface AccountService

getUserAccountPaymentAmountLimitData

public UserAccountPaymentAmountLimitData getUserAccountPaymentAmountLimitData(AccountVO vo)

Description copied from interface: AccountService

Get an account payment amount limit data

Specified by:

getUserAccountPaymentAmountLimitData in interface AccountService

getUserAccountsBalanceLimits

public List<AccountBalanceLimitVO> getUserAccountsBalanceLimits(UserLocatorVO userLocator)
                                                         throws FrameworkException

Description copied from interface: AccountService

Returns the user accounts with their upper and lower balance limits

Specified by:

getUserAccountsBalanceLimits in interface AccountService

Throws:

FrameworkException

getUserAccountsPaymentAmountLimits

public List<AccountPaymentAmountLimitVO> getUserAccountsPaymentAmountLimits(UserLocatorVO userLocator)
                                                                     throws FrameworkException

Description copied from interface: AccountService

Returns the user accounts with their upper and lower balance limits

Specified by:

getUserAccountsPaymentAmountLimits in interface AccountService

Throws:

FrameworkException

getUsersWithBalancesOverview

public UsersWithBalancesOverview getUsersWithBalancesOverview(UserWithBalanceQuery params)
                                                       throws FrameworkException,
                                                              QueryParseException

Description copied from interface: AccountService

Returns the overview of users with balances according to the given query

Specified by:

getUsersWithBalancesOverview in interface AccountService

Throws:

FrameworkException

QueryParseException

getUserWithBalanceSearchData

public UserWithBalanceSearchData getUserWithBalanceSearchData()
                                                       throws FrameworkException

Description copied from interface: AccountService

Returns data to search for users with balances

Specified by:

getUserWithBalanceSearchData in interface AccountService

Throws:

FrameworkException

isAccessible

public boolean isAccessible(Account account)

isAccessible

public boolean isAccessible(AccountLocator locator)

isAccessible

public boolean isAccessible(AccountVO account)

isAccessible

public boolean isAccessible(InternalAccountOwner owner,
                            AccountType type)

load

public AccountWithCurrencyVO load(Long id)
                           throws EntityNotFoundException

Description copied from interface: AccountService

Loads an account by id

Specified by:

load in interface AccountService

Throws:

EntityNotFoundException

searchAccountBalanceLimitsOverview

public Page<AccountBalanceLimitVO> searchAccountBalanceLimitsOverview(AccountBalanceLimitsOverviewQuery params)

Description copied from interface: AccountService

Overview search of account balance limits

Specified by:

searchAccountBalanceLimitsOverview in interface AccountService

searchAccountHistoriesOverview

public Page<AccountHistoryOverviewEntryVO> searchAccountHistoriesOverview(AccountHistoriesOverviewQuery params)

Description copied from interface: AccountService

Account histories overview filtered by the specified query parameters.

Specified by:

searchAccountHistoriesOverview in interface AccountService

searchAccountHistory

public Page<AccountHistoryEntryVO> searchAccountHistory(AccountHistoryQuery params)

Description copied from interface: AccountService

Searches the history entries of a required visible account according to the given query parameters. For searching on multiple accounts see AccountService.searchAccountHistoriesOverview(AccountHistoriesOverviewQuery)

Specified by:

searchAccountHistory in interface AccountService

searchAccountPaymentAmountLimitsOverview

public Page<AccountPaymentAmountLimitVO> searchAccountPaymentAmountLimitsOverview(AccountPaymentAmountLimitsOverviewQuery params)

Description copied from interface: AccountService

Overview search of account balance limits

Specified by:

searchAccountPaymentAmountLimitsOverview in interface AccountService

searchUsersWithBalances

public Page<UserWithBalanceVO> searchUsersWithBalances(UserWithBalanceQuery params)
                                                throws FrameworkException

Description copied from interface: AccountService

Searches for users together with their respective account balances

Specified by:

searchUsersWithBalances in interface AccountService

Throws:

FrameworkException

setBalanceLimit

public void setBalanceLimit(AccountBalanceLimitDTO data)

Description copied from interface: AccountService

Change limits of an account

Specified by:

setBalanceLimit in interface AccountService

setPaymentAmountLimit

public void setPaymentAmountLimit(AccountPaymentAmountLimitDTO data)

Description copied from interface: AccountService

Change limits of an account

Specified by:

setPaymentAmountLimit in interface AccountService

checkAccountHistoriesOverviewQuery

protected void checkAccountHistoriesOverviewQuery(AccountHistoriesOverviewQuery params)

checkAccountHistoryQuery

protected void checkAccountHistoryQuery(AccountHistoryQuery params)

checkAccountLimitsOverviewQuery

protected void checkAccountLimitsOverviewQuery(AccountLimitsOverviewQuery params)

resolveEntityCheck

protected EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity