org.restcomm.connect.dao.AccountsDao Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restcomm-connect.dao Show documentation
There is a newer version: 8.4.0-227
/*
 * TeleStax, Open Source Cloud Communications
 * Copyright 2011-2014, Telestax Inc and individual contributors
 * by the @authors tag.
 *
 * This program is free software: you can redistribute it and/or modify
 * under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see 
 *
 */
package org.restcomm.connect.dao;

import java.util.List;

import org.restcomm.connect.commons.dao.Sid;
import org.restcomm.connect.dao.entities.Account;

/**
 * @author [email protected] (Thomas Quintana)
 */
public interface AccountsDao {
    void addAccount(Account account);

    Account getAccount(Sid sid);

    Account getAccount(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.
     * @param name
     * @return Account to authenticate
     */
    Account getAccountToAuthenticate(String name);

    List getChildAccounts(Sid parentSid);

    void removeAccount(Sid sid);

    void updateAccount(Account account);

    /**
     * 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.
     *
     * @param parentAccountSid
     * @return list of account sid or null
     */
    List getSubAccountSidsRecursive(Sid parentAccountSid);
}