com.zimbra.soap.account.message.GetRightsRequest.java Source code

Introduction

Here is the source code for com.zimbra.soap.account.message.GetRightsRequest.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.account.message;

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

import java.util.Collections;
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.AccountConstants;
import com.zimbra.soap.account.type.Right;

/**
 * @zm-api-command-auth-required true
 * @zm-api-command-admin-auth-required false
 * @zm-api-command-description Get account level rights.
 * <br />
 * If no <b>&lt;ace></b> elements are provided, all ACEs are returned in the response.
 * <br />
 * If <b>&lt;ace></b> elements are provided, only those ACEs with specified rights are returned in the response.
 */
@XmlAccessorType(XmlAccessType.NONE)
@XmlRootElement(name = AccountConstants.E_GET_RIGHTS_REQUEST)
public class GetRightsRequest {

    /**
     * @zm-api-field-description Specify Access Control Entries to return
     */
    @XmlElement(name = AccountConstants.E_ACE /* ace */, required = false)
    private List<Right> aces = Lists.newArrayList();

    public GetRightsRequest() {
    }

    public void setAces(Iterable<Right> aces) {
        this.aces.clear();
        if (aces != null) {
            Iterables.addAll(this.aces, aces);
        }
    }

    public GetRightsRequest addAce(Right ace) {
        this.aces.add(ace);
        return this;
    }

    public List<Right> getAces() {
        return Collections.unmodifiableList(aces);
    }

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

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