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

Introduction

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

/**
 * @zm-api-command-network-edition
 * @zm-api-command-auth-required true
 * @zm-api-command-admin-auth-required false
 * @zm-api-command-description Get SMIME Public Certificates
 * Stores specified in <b>&lt;store></b> will be attempted in the order they appear in the comma separated list.
 * <br />
 * e.g.
 * <ul>
 * <li>   <b>&lt;store>CONTACT&lt;/store></b>     - lookup certs in user's address books
 * <li>   <b>&lt;store>CONTACT,GAL&lt;/store></b> - lookup in user's address books, then lookup in GAL
 * <li>   <b>&lt;store>LDAP&lt;/store></b>        - lookup certs in external LDAP
 * </ul>
 */
@XmlAccessorType(XmlAccessType.NONE)
@XmlRootElement(name = AccountConstants.E_GET_SMIME_PUBLIC_CERTS_REQUEST)
public class GetSMIMEPublicCertsRequest {

    /**
     * @zm-api-field-description Information on public certificate stores
     */
    @XmlElement(name = AccountConstants.E_STORE /* store */, required = true)
    private final SMIMEPublicCertsStoreSpec store;

    /**
     * @zm-api-field-tag email-address
     * @zm-api-field-description List of email addresses
     */
    @XmlElement(name = AccountConstants.E_EMAIL /* email */, required = false)
    private List<String> emails = Lists.newArrayList();

    /**
     * no-argument constructor wanted by JAXB
     */
    @SuppressWarnings("unused")
    private GetSMIMEPublicCertsRequest() {
        this((SMIMEPublicCertsStoreSpec) null);
    }

    public GetSMIMEPublicCertsRequest(SMIMEPublicCertsStoreSpec store) {
        this.store = store;
    }

    public void setEmails(Iterable<String> emails) {
        this.emails.clear();
        if (emails != null) {
            Iterables.addAll(this.emails, emails);
        }
    }

    public void addEmail(String email) {
        this.emails.add(email);
    }

    public SMIMEPublicCertsStoreSpec getStore() {
        return store;
    }

    public List<String> getEmails() {
        return Collections.unmodifiableList(emails);
    }

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

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