summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/crud/event/envelope/GraphEventEnvelope.java
blob: d7939306cd8c964f7d9313115e9d8ede9f7f7110 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
 * Copyright © 2017-2018 Amdocs
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */
package org.onap.crud.event.envelope;

import javax.ws.rs.core.Response;
import org.onap.crud.event.GraphEvent;
import org.onap.crud.event.GraphEventEdge;
import org.onap.crud.event.GraphEventVertex;
import org.onap.crud.exception.CrudException;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;

/**
 * Defines the top-level structure of the Gizmo events. Primarily serves as a wrapper for the graph details and includes
 * an event header to describe and identify the event.
 */
public class GraphEventEnvelope {

    private GraphEventHeader header;
    private GraphEvent body;
    private JsonElement policyViolations;

    private static final Gson gson = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting().create();

    /**
     * Construct the event.
     *
     * @param header the event header to describe the event
     * @param body the body of the event with graph details
     */
    public GraphEventEnvelope(GraphEventHeader header, GraphEvent body) {
        this.header = header;
        this.body = body;
    }

    /**
     * Construct the envelope header from the provided GraphEvent.
     *
     * @param event the graph event for a vertex or edge operation
     */
    public GraphEventEnvelope(GraphEvent event) {
        this.header = new GraphEventHeader.Builder().requestId(event.getTransactionId())
                .validationEntityType(getType(event)).build();
        this.body = event;
    }

    public GraphEvent getBody() {
        return body;
    }

    public GraphEventHeader getHeader() {
        return header;
    }

    public JsonElement getPolicyViolations() {
        return policyViolations != null ? policyViolations : new JsonArray();
    }

    /**
     * Serializes this object into a JSON string representation.
     *
     * @return a JSON format string representation of this object.
     */
    public String toJson() {
        return gson.toJson(this);
    }

    /**
     * Deserializes a JSON string into a GraphEventEnvelope object.
     *
     * @param json the JSON string
     * @return a GraphEventEnvelope object
     * @throws CrudException
     */
    public static GraphEventEnvelope fromJson(String json) throws CrudException {
        try {
            if (json == null || json.isEmpty()) {
                throw new CrudException("Empty or null JSON string.", Response.Status.BAD_REQUEST);
            }
            return gson.fromJson(json, GraphEventEnvelope.class);
        } catch (Exception ex) {
            throw new CrudException("Unable to parse JSON string: " + json, Response.Status.BAD_REQUEST);
        }
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return this.toJson();
    }

    private String getType(GraphEvent event) {
        GraphEventVertex vertex = event.getVertex();
        GraphEventEdge edge = event.getEdge();
        if (vertex != null) {
            return vertex.getType();
        } else if (edge != null) {
            return edge.getType();
        }
        return null;
    }

}