org.lappsgrid.serialization.Data.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of all Show documentation

A pom the depends on all LAPPS Grid modules.

There is a newer version: 2.5.0

/*
 * Copyright 2014 The Language Application Grid
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.lappsgrid.serialization

import com.fasterxml.jackson.annotation.JsonIgnore
import org.lappsgrid.serialization.aas.Token

/**
 * The Data object is the container for all communications between services on
 * the Lappsgrid.
 *
 * The Data object consists of a discrimintator, a payload, and possibly some
 * parameters.
 *
 * @author Keith Suderman
 */
public class Data {
    /**
     * A URI that specifies the content of the payload.  The URI must be one of
     * the URI defined at http://vocab.lappsgrid.org/discriminators.html
     */
    String discriminator

    /**
     * The payload to be transmitted.
     */
    T payload

    /** A map of parameters (if any) to be sent with the requst. */
    Map parameters

    public Data() {

    }

    public Data(String discriminator, T payload)
    {
        this.discriminator = discriminator;
        this.payload = payload;
    }

    public Data(String discriminator) {
        this.discriminator = discriminator
    }

    public Data(Map map) {
        this.discriminator = map.discriminator
        this.payload = map.payload
        this.parameters = map.parameters
    }

    @JsonIgnore
    public void setParameter(String name, Object value) {
        if (!parameters) {
            parameters = [:]
        }
        parameters[name] = value
    }

    @JsonIgnore
    public Object getParameter(String name) {
        return parameters?.get(name)
    }

    /** Returns a JSON representation of the Data object */
    public String asJson()
    {
        return Serializer.toJson(this);
    }

    /** Returns a pretty-printed JSON representation of the Data object. */
    public String asPrettyJson()
    {
        return Serializer.toPrettyJson(this);
    }
}