com.zimbra.soap.admin.message.SyncGalAccountRequest.java Source code

Introduction

Here is the source code for com.zimbra.soap.admin.message.SyncGalAccountRequest.java

Source

/*
 * ***** BEGIN LICENSE BLOCK *****
 * Zimbra Collaboration Suite Server
 * Copyright (C) 2011, 2012, 2013, 2014, 2016 Synacor, Inc.
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software Foundation,
 * version 2 of the License.
 *
 * 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <https://www.gnu.org/licenses/>.
 * ***** END LICENSE BLOCK *****
 */

package com.zimbra.soap.admin.message;

import com.google.common.base.Objects;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;

import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

import com.zimbra.common.soap.AdminConstants;
import com.zimbra.soap.admin.type.SyncGalAccountSpec;

/**
 * @zm-api-command-auth-required true
 * @zm-api-command-admin-auth-required true
 * @zm-api-command-description Sync GalAccount
 * <br />
 * Notes:
 * <ul>
 * <li> If fullSync is set to false (or unset) the default behavior is trickle sync which will pull in any new
 *      contacts or modified contacts since last sync.
 * <li> If fullSync is set to true, then the server will go through all the contacts that appear in GAL, and resolve
 *      deleted contacts in addition to new or modified ones.
 * <li> If reset attribute is set, then all the contacts will be populated again, regardless of the status since last
 *      sync.  Reset needs to be done when there is a significant change in the configuration, such as filter,
 *      attribute map, or search base.
 * </ul>
 */
@XmlAccessorType(XmlAccessType.NONE)
@XmlRootElement(name = AdminConstants.E_SYNC_GAL_ACCOUNT_REQUEST)
public class SyncGalAccountRequest {

    /**
     * @zm-api-field-description Sync GalAccount specification
     */
    @XmlElement(name = AdminConstants.E_ACCOUNT /* account */, required = false)
    private List<SyncGalAccountSpec> accounts = Lists.newArrayList();

    public SyncGalAccountRequest() {
    }

    public void setAccounts(Iterable<SyncGalAccountSpec> accounts) {
        this.accounts.clear();
        if (accounts != null) {
            Iterables.addAll(this.accounts, accounts);
        }
    }

    public void addAccount(SyncGalAccountSpec account) {
        this.accounts.add(account);
    }

    public List<SyncGalAccountSpec> getAccounts() {
        return accounts;
    }

    public Objects.ToStringHelper addToStringInfo(Objects.ToStringHelper helper) {
        return helper.add("accounts", accounts);
    }

    @Override
    public String toString() {
        return addToStringInfo(Objects.toStringHelper(this)).toString();
    }
}