com.sonymobile.tools.gerrit.gerritevents.dto.attr.Provider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-events Show documentation
Java client library for receiving stream-events from Gerrit code review. As well as performing queries and sending reviews.
The newest version!
/*
 *  The MIT License
 *
 *  Copyright 2013 rinrinne. All rights reserved.
 *  Copyright 2013 Sony Mobile Communications AB. All rights reserved.
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 */
package com.sonymobile.tools.gerrit.gerritevents.dto.attr;

import static com.sonymobile.tools.gerrit.gerritevents.GerritJsonEventFactory.getString;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.NAME;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.HOST;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.PORT;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.PROTOCOL;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.SCHEME;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.URL;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.VERSION;

import com.sonymobile.tools.gerrit.gerritevents.GerritConnection;
import net.sf.json.JSONObject;

import com.sonymobile.tools.gerrit.gerritevents.dto.GerritJsonDTO;

/**
 * Represents a Gerrit JSON Provider DTO.
 * A Provider that is related to an event or attribute.
 *
 * @author rinrinne <[email protected]>
 */
public class Provider implements GerritJsonDTO {

    /**
     * The name of the Gerrit instance.
     */
    private String name;
    /**
     * The host name of the Gerrit instance that provided this event.
     */
    private String host;
    /**
     * The port where the Gerrit instance listens for connections.
     */
    private String port;
    /**
     * The protocol scheme through which this event was provided.
     */
    private String scheme;
    /**
     * The url of the Gerrit instance's Web UI.
     */
    private String url;
    /**
     * The version of the Gerrit instance.
     */
    private String version;
    /**
     * Default constructor.
     */
    public Provider() {
    }

    /**
     * Constructor that fills with data directly.
     *
     * @param json the JSON Object with data.
     * @see #fromJson(net.sf.json.JSONObject)
     */
    public Provider(JSONObject json) {
        fromJson(json);
    }

    /**
     * For easier testing.
     * @param name the name.
     * @param host the host.
     * @param port the port.
     * @param scheme the scheme.
     * @param url the frontend URL for Gerrit WebUI.
     * @param version the Gerrit version.
     */
    public Provider(String name, String host, String port, String scheme, String url, String version) {
        this.name = name;
        this.host = host;
        this.port = port;
        this.scheme = scheme;
        this.url = url;
        this.version = version;
    }

    @Override
    public void fromJson(JSONObject json) {
        name = getString(json, NAME);
        host = getString(json, HOST);
        port = getString(json, PORT);
        // For backwards compatibility we check for `proto` first
        // and if it's not set, then try `scheme`.
        scheme = getString(json, PROTOCOL);
        if (scheme == null) {
            scheme = getString(json, SCHEME);
        }
        url = getString(json, URL);
        version = getString(json, VERSION);
    }

    /**
     * Get name.
     *
     * @return the name.
     */
    public String getName() {
        return name;
    }

    /**
     * Set name.
     *
     * @param name the name.
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Get host.
     *
     * @return the host.
     */
    public String getHost() {
        return host;
    }

    /**
     * Set host.
     *
     * @param host the host.
     */
    public void setHost(String host) {
        this.host = host;
    }

    /**
     * Get port.
     *
     * @return the port.
     */
    public String getPort() {
        return port;
    }

    /**
     * Set port.
     *
     * @param port the port.
     */
    public void setPort(String port) {
        this.port = port;
    }

    /**
     * Get protocol scheme.
     *
     * @return the scheme.
     * @deprecated use getSecheme instead.
     */
    public String getProto() {
        return getScheme();
    }

    /**
     * Set protocol scheme.
     *
     * @param proto the scheme.
     * @deprecated use setScheme instead.
     */
    public void setProto(String proto) {
        setScheme(proto);
    }

    /**
     * Get protocol scheme.
     *
     * @return the scheme.
     */
    public String getScheme() {
        return scheme;
    }

    /**
     * Set protocol scheme.
     *
     * @param scheme the scheme.
     */
    public void setScheme(String scheme) {
        this.scheme = scheme;
    }

    /**
     * Get url.
     *
     * @return the url
     */
    public String getUrl() {
        String frontUrl = this.url;
        if (frontUrl != null && !frontUrl.isEmpty() && !frontUrl.endsWith("/")) {
            frontUrl += '/';
        }
        return frontUrl;
    }

    /**
     * Set url.
     *
     * @param url the url.
     */
    public void setUrl(String url) {
        this.url = url;
    }

    /**
     * Get version.
     *
     * @return the version.
     */
    public String getVersion() {
        return version;
    }

    /**
     * Set version.
     *
     * @param version the version.
     */
    public void setVersion(String version) {
        this.version = version;
    }

    @Override
    public String toString() {
        return "Provider: " + getName() + " " + getHost() + " " + getPort() + " " + getScheme()
                + " " + getUrl() + " " + getVersion();
    }

    @Override
    public int hashCode() {
        //CS IGNORE MagicNumber FOR NEXT 9 LINES. REASON: Autogenerated Code.
        //CS IGNORE AvoidInlineConditionals FOR NEXT 9 LINES. REASON: Autogenerated Code.
        final int prime = 31;
        int result = 1;
        result = prime * result + ((name == null) ? 0 : name.hashCode());
        result = prime * result + ((host == null) ? 0 : host.hashCode());
        result = prime * result + ((port == null) ? 0 : port.hashCode());
        result = prime * result + ((scheme == null) ? 0 : scheme.hashCode());
        result = prime * result + ((url == null) ? 0 : url.hashCode());
        result = prime * result + ((version == null) ? 0 : version.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        //CS IGNORE NeedBraces FOR NEXT 38 LINES. REASON: Autogenerated Code.
        //CS IGNORE NoWhitespaceAfter FOR NEXT 38 LINES. REASON: Autogenerated Code.
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        Provider other = (Provider) obj;
        if (name == null) {
            if (other.name != null)
                return false;
        } else if (!name.equals(other.name))
            return false;
        if (host == null) {
            if (other.host != null)
                return false;
        } else if (!host.equals(other.host))
            return false;
        if (port == null) {
            if (other.port != null)
                return false;
        } else if (!port.equals(other.port))
            return false;
        if (scheme == null) {
            if (other.scheme != null)
                return false;
        } else if (!scheme.equals(other.scheme))
            return false;
        if (url == null) {
            if (other.url != null)
                return false;
        } else if (!url.equals(other.url))
            return false;
        if (version == null) {
            if (other.version != null)
                return false;
        } else if (!version.equals(other.version))
            return false;
        return true;
    }

    /**
     * Deserialization handling.
     *
     * @return itself
     */
    protected Object readResolve() {
        if (proto != null && scheme == null) {
            scheme = proto;
            proto = null;
        } else if (scheme == null && proto == null) {
            scheme = GerritConnection.GERRIT_PROTOCOL_SCHEME_NAME; //The default for old stuff
        }
        return this;
    }

    //------ Old fields ------

    /**
     * Old name of {@link #scheme}, never to be used again.
     */
    @Deprecated
    private transient String proto;
}