org.restcomm.connect.dao

Interface AccountsDao

All Known Implementing Classes:

MybatisAccountsDao

public interface AccountsDao

Author:

quintana.thomas@gmail.com (Thomas Quintana)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAccount(Account account)
Account	getAccount(Sid sid)
Account	getAccount(String name)
List<String>	getAccountLineage(Account account) Overloaded version of getAccontLineage(Sid) that won't retrieve current account since it's already there.
List<String>	getAccountLineage(Sid accountSid) Returns a list of all the ancestor account SIDs of an Account all the way up to the top-level account.
Account	getAccountToAuthenticate(String name) Created to separate the method used to authenticate from the method used to obtain an account from the database, using a ordinary String parameter.
List<Account>	getChildAccounts(Sid parentSid)
List<String>	getSubAccountSidsRecursive(Sid parentAccountSid) Returns a list of all sub-accounts under a parent account.
void	removeAccount(Sid sid)
void	updateAccount(Account account)

Method Detail

addAccount

void addAccount(Account account)

getAccount

Account getAccount(Sid sid)

getAccount

Account getAccount(String name)

getAccountToAuthenticate

Account getAccountToAuthenticate(String name)

Created to separate the method used to authenticate from the method used to obtain an account from the database, using a ordinary String parameter. Once authentication cannot allow friendly name as username, this method can be similar to getAccount(String name), but without 'getAccountByFriendlyName' selector.

Parameters:

name -

Returns:

Account to authenticate

getChildAccounts

List<Account> getChildAccounts(Sid parentSid)

removeAccount

void removeAccount(Sid sid)

updateAccount

void updateAccount(Account account)

getSubAccountSidsRecursive

List<String> getSubAccountSidsRecursive(Sid parentAccountSid)

Returns a list of all sub-accounts under a parent account. All nested sub-accounts in any level will be returned. Note: a) The parent account is not included in the results. b) The sub-account order in the returned list follows a top-down logic. So, higher hierarchy account list elements always go before lower hierarchy accounts. It will return an empty array in case the parent has no children or the parent does not exist.

Parameters:

parentAccountSid -

Returns:

list of account sid or null

getAccountLineage

List<String> getAccountLineage(Sid accountSid)
                               throws AccountHierarchyDepthCrossed

Returns a list of all the ancestor account SIDs of an Account all the way up to the top-level account. It currently works in an iterative way digging through the parentSid property until it reaches the top. The order of the returned list is significant starting with child accounts first and ending with the top-level account. Note, the list does NOT contain the account passed as a parameter. Examples: getAccountLineage(toplevelAccount) -> [] parentAccoun is the direct child of toplevelAccount: getAccontLineage(parentAccount) -> [toplevelAccount] child@company.com is the child of parent@company.com: getAccountLineage(childAccount) -> [parent@company.comSID, admininstrator@compahy.comSID] grantchild@company.com is the child of child@company.com: getAccountLineage(grandchildAccount) -> AccountHierarchyDepthCrossed exctption thrown

Parameters:

accountSid -

Returns:

Throws:

AccountHierarchyDepthCrossed

getAccountLineage

List<String> getAccountLineage(Account account)
                               throws AccountHierarchyDepthCrossed

Overloaded version of getAccontLineage(Sid) that won't retrieve current account since it's already there. Helps having cleaner concepts in the case when the starting child account is already loaded.

Parameters:

account -

Returns:

Throws:

AccountHierarchyDepthCrossed