com.zimbra.doc.soap.Command.java Source code

Introduction

Here is the source code for com.zimbra.doc.soap.Command.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.doc.soap;

import java.util.*;

import com.google.common.base.Strings;

public class Command implements java.io.Serializable {

    private static final long serialVersionUID = 1L;

    /* Used to separate out the first part of the description for use as a short summary */
    private static final String REGEX_DESCRIPTION_SHORT_DELIM = "<br|<BR|<p>|<P>|<table|<TABLE|<ul|<UL|<ol|<OL|<pre>|<PRE>";

    private XmlElementDescription request;
    private XmlElementDescription response;

    private List<XmlElementDescription> allElements = new LinkedList<XmlElementDescription>();

    private Service service = null;
    private String name = null;
    private String namespace = null;

    private String description = null;
    private Boolean networkEdition = false;
    private String deprecation = null;
    private String authRequiredDescription;
    private String adminAuthRequiredDescription;

    Command(Service service, String name, String namespace) {
        this.service = service;
        this.name = name;
        this.namespace = namespace;
    }

    /**
     * Checks if the command is loaded.
     *
     * @return    <code>true</code> if the command is loaded
     */
    public boolean getLoaded() {
        if (this.response == null || this.request == null)
            return false;
        return true;
    }

    public XmlElementDescription getResponse() {
        return this.response;
    }

    public XmlElementDescription getRequest() {
        return this.request;
    }

    public String getDescription() {
        return Strings.nullToEmpty(this.description);
    }

    public Boolean hasDeprecationDescription() {
        return !Strings.isNullOrEmpty(deprecation);
    }

    public String getDeprecation() {
        return Strings.nullToEmpty(this.deprecation);
    }

    /**
     * Gets the short description. This is the first line of the description.
     */
    public String getShortDescription() {
        String desc = getDescription();
        StringBuilder sb = new StringBuilder();

        String[] tokens = desc.split(REGEX_DESCRIPTION_SHORT_DELIM);
        if (tokens != null && tokens.length > 0 && tokens[0].length() > 0) {
            String retDesc = tokens[0].trim();
            sb.append(retDesc);
            if (!retDesc.endsWith(".")) {
                sb.append(".");
            }
        }
        if (networkEdition) {
            sb.append(" <font color=\"#dd0000\">[NetworkEdition only]</font>");
        }
        if (hasDeprecationDescription()) {
            sb.append("\n<br /><font color=\"#dd0000\">").append(getDeprecation()).append("</font>");
        }
        return sb.toString();
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public void setDeprecation(String deprecation) {
        this.deprecation = deprecation;
    }

    public void setRootRequestElement(XmlElementDescription request) {
        if (request != null) {
            this.request = request;
            this.allElements.add(request);
            loadAllElements(request);
        }
    }

    public void setRootResponseElement(XmlElementDescription response) {
        if (response != null) {
            this.response = response;
            this.allElements.add(response);
            loadAllElements(response);
        }
    }

    public void setRootElements(XmlElementDescription request, XmlElementDescription response) {
        setRootRequestElement(request);
        setRootResponseElement(response);
    }

    private void loadAllElements(DescriptionNode root) {
        Iterator<DescriptionNode> it = root.getChildren().iterator();
        while (it.hasNext()) {
            DescriptionNode dn = it.next();
            if (dn instanceof XmlElementDescription) {
                XmlElementDescription e = (XmlElementDescription) dn;
                if (this.allElements.contains(e) == false)
                    this.allElements.add(e);
                loadAllElements(e);
            } else {
                for (DescriptionNode dnc : dn.getChildren()) {
                    if (dnc instanceof XmlElementDescription) {
                        XmlElementDescription e = (XmlElementDescription) dnc;
                        if (this.allElements.contains(e) == false)
                            this.allElements.add(e);
                    }
                    loadAllElements(dnc);
                }
            }
        }
    }

    public String getNamespace() {
        return this.namespace;
    }

    public String getName() {
        return this.name;
    }

    public String getRequestName() {
        return this.request.getName();
    }

    public String getResponseName() {
        return this.response.getName();
    }

    public Service getService() {
        return this.service;
    }

    public List<XmlElementDescription> getAllElements() {
        return this.allElements;
    }

    public void setNetworkEdition(boolean networkEdition) {
        this.networkEdition = networkEdition;
    }

    public Boolean isNetworkEdition() {
        return networkEdition;
    }

    public String getAuthRequiredDescription() {
        return authRequiredDescription == null ? "UNKNOWN" : authRequiredDescription;
    }

    public void setAuthRequiredDescription(String authRequiredDescription) {
        this.authRequiredDescription = authRequiredDescription;
    }

    public String getAdminAuthRequiredDescription() {
        return adminAuthRequiredDescription == null ? "UNKNOWN" : adminAuthRequiredDescription;
    }

    public void setAdminAuthRequiredDescription(String adminAuthRequiredDescription) {
        this.adminAuthRequiredDescription = adminAuthRequiredDescription;
    }

    /**
     * Dumps the contents to <code>System.out.println</code>
     */
    public void dump() {
        System.out.println("Dump command...");
        System.out.println(this);
    }

    @Override
    public String toString() {
        StringBuilder buf = new StringBuilder();

        buf.append("[command");
        buf.append(";hashCode=");
        buf.append(hashCode());
        buf.append(";name=");
        buf.append(this.getName());
        buf.append(";namespace=");
        buf.append(this.getNamespace());
        buf.append(";requestName=");
        buf.append(this.getRequestName());
        buf.append(";responseName=");
        buf.append(this.getResponseName());
        buf.append(";request=");
        buf.append(this.getRequest());
        buf.append(";response=");
        buf.append(this.getResponse());
        buf.append(";allElements=");
        buf.append(this.getAllElements().size());
        buf.append("]");

        return buf.toString();
    }

    public static class CommandComparator implements java.util.Comparator<Command> {

        @Override
        public int compare(Command c1, Command c2) {
            String n1 = c1.getName();
            String n2 = c2.getName();

            return n1.compareTo(n2);
        }
    }
}