org.restcomm.connect.dao.mybatis

Class MybatisAccountsDao

java.lang.Object

org.restcomm.connect.dao.mybatis.MybatisAccountsDao

All Implemented Interfaces:

AccountsDao

public final class MybatisAccountsDao
extends Object
implements AccountsDao

Author:

quintana.thomas@gmail.com (Thomas Quintana)

Constructor Summary

Constructors

Constructor and Description
MybatisAccountsDao(org.apache.ibatis.session.SqlSessionFactory sessions)

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	setAccountRecursionDepth(Integer accountRecursionDepth)
void	updateAccount(Account account)

Methods inherited from class java.lang.Object

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

Constructor Detail

MybatisAccountsDao

public MybatisAccountsDao(org.apache.ibatis.session.SqlSessionFactory sessions)

Method Detail

setAccountRecursionDepth

public void setAccountRecursionDepth(Integer accountRecursionDepth)

addAccount

public void addAccount(Account account)

Specified by:

addAccount in interface AccountsDao

getAccount

public Account getAccount(Sid sid)

Specified by:

getAccount in interface AccountsDao

getAccount

public Account getAccount(String name)

Specified by:

getAccount in interface AccountsDao

getAccountToAuthenticate

public Account getAccountToAuthenticate(String name)

Description copied from interface: AccountsDao

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.

Specified by:

getAccountToAuthenticate in interface AccountsDao

Returns:

Account to authenticate

getChildAccounts

public List<Account> getChildAccounts(Sid parentSid)

Specified by:

getChildAccounts in interface AccountsDao

removeAccount

public void removeAccount(Sid sid)

Specified by:

removeAccount in interface AccountsDao

updateAccount

public void updateAccount(Account account)

Specified by:

updateAccount in interface AccountsDao

getSubAccountSidsRecursive

public List<String> getSubAccountSidsRecursive(Sid parentAccountSid)

Description copied from interface: AccountsDao

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.

Specified by:

getSubAccountSidsRecursive in interface AccountsDao

Returns:

list of account sid or null

getAccountLineage

public List<String> getAccountLineage(Sid accountSid)
                               throws AccountHierarchyDepthCrossed

Description copied from interface: AccountsDao

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

Specified by:

getAccountLineage in interface AccountsDao

Returns:

Throws:

AccountHierarchyDepthCrossed

getAccountLineage

public List<String> getAccountLineage(Account account)
                               throws AccountHierarchyDepthCrossed

Description copied from interface: AccountsDao

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.

Specified by:

getAccountLineage in interface AccountsDao

Returns:

Throws:

AccountHierarchyDepthCrossed