atom.ws.model.AbstractMessage Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.ws.model;

import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlType;
import java.io.Serializable;
import java.util.Arrays;

/**
 * Abstract message for client-server communication.
 *
 * @author Serge Voloshyn
 * @version 1.1 3/1/15
 */
@XmlType(namespace = AbstractMessage.MESSAGING_NAMESPACE)
@XmlSeeAlso(value = {
        ChangeSetMessage.class,
        StartActivityMessage.class,
        HandleEventMessage.class,
        TimezoneOffsetMessage.class
})
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME,
        include = JsonTypeInfo.As.PROPERTY, property = "jso")
@JsonSubTypes({
        @JsonSubTypes.Type(value = StartActivityMessage.class,
                name = "StartActivityMessage"),
        @JsonSubTypes.Type(value = HandleEventMessage.class,
                name = "HandleEventMessage"),
        @JsonSubTypes.Type(value = TimezoneOffsetMessage.class,
                name = "TimezoneOffsetMessage"),
        @JsonSubTypes.Type(value = ChangeSetMessage.class,
                name = "ChangeSetMessage")
})
public abstract class AbstractMessage implements Serializable {
    /**
     * Use serialVersionUID from JDK 1.0.2 for interoperability.
     */
    private static final long serialVersionUID = -4528649345392508924L;
    /**
     * JAXB manifest namespace.
     */
    public static final String MESSAGING_NAMESPACE =
            "http://atom.geeoz.com/messaging/1.0";
    /**
     * Client identifier.
     */
    private String clientId;

    /**
     * Client cookies.
     */
    private Cookie[] cookies;

    /**
     * Get client identifier.
     *
     * @return client identifier
     */
    public final String getClientId() {
        return clientId;
    }

    /**
     * Sets client identifier.
     *
     * @param aClientId client identifier
     */
    public final void setClientId(final String aClientId) {
        clientId = aClientId;
    }

    /**
     * Get client cookies.
     *
     * @return client cookies
     */
    public final Cookie[] getCookies() {
        if (cookies == null) {
            return new Cookie[0];
        }
        return Arrays.copyOf(cookies, cookies.length);
    }

    /**
     * Set cookies.
     *
     * @param theCookies new cookies
     */
    public final void setCookies(final Cookie[] theCookies) {
        if (theCookies == null) {
            cookies = null;
        } else {
            cookies = Arrays.copyOf(theCookies, theCookies.length);
        }
    }
}