aboutsummaryrefslogtreecommitdiffstats
path: root/adapters/mso-adapters-rest-interface/src/main/java/org/openecomp/mso/adapters/sdncrest/SDNCResponseCommon.java
blob: 7265d67923847754cbb335adecd509b2f0189b50 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP - SO
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * Copyright (C) 2017 Huawei Technologies Co., Ltd. All rights reserved.
 * ================================================================================
 * 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.openecomp.mso.adapters.sdncrest;

import java.io.IOException;
import java.io.Serializable;

import javax.xml.bind.annotation.XmlElement;

import org.openecomp.mso.logger.MsoLogger;

import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

/**
 * Base class for all SDNC adapter responses, including errors.
 */
public abstract class SDNCResponseCommon implements Serializable {
	private static final long serialVersionUID = 1L;
	
	private static final MsoLogger LOGGER = MsoLogger.getMsoLogger (MsoLogger.Catalog.RA);

	// Identifies the MSO transaction with SDNC.
	private String sdncRequestId;

	// Response code, either from SDNC, or generated by the SDNC adapter.
	// 2XX responses are considered success responses.
	private String responseCode;

	// Response message, either from SDNC, or generated by the SDNC adapter.
	private String responseMessage;

	// Indicates if the response is final (Y or N).
	private String ackFinalIndicator;

	public SDNCResponseCommon(String sdncRequestId, String responseCode,
			String responseMessage, String ackFinalIndicator) {
		this.sdncRequestId = sdncRequestId;
		this.responseCode = responseCode;
		this.responseMessage = responseMessage;
		this.ackFinalIndicator = ackFinalIndicator;
	}

	public SDNCResponseCommon() {
	}

	@JsonProperty("sdncRequestId")
	@XmlElement(name = "sdncRequestId")
	public String getSDNCRequestId() {
		return sdncRequestId;
	}

	@JsonProperty("sdncRequestId")
	public void setSDNCRequestId(String sdncRequestId) {
		this.sdncRequestId = sdncRequestId;
	}

	@JsonProperty("responseCode")
	@XmlElement(name = "responseCode")
	public String getResponseCode() {
		return responseCode;
	}

	@JsonProperty("responseCode")
	public void setResponseCode(String responseCode) {
		this.responseCode = responseCode;
	}

	@JsonProperty("responseMessage")
	@XmlElement(name = "responseMessage")
	public String getResponseMessage() {
		return responseMessage;
	}

	@JsonProperty("responseMessage")
	public void setResponseMessage(String responseMessage) {
		this.responseMessage = responseMessage;
	}

	@JsonProperty("ackFinalIndicator")
	@XmlElement(name = "ackFinalIndicator")
	public String getAckFinalIndicator() {
		return ackFinalIndicator;
	}

	@JsonProperty("ackFinalIndicator")
	public void setAckFinalIndicator(String ackFinalIndicator) {
		this.ackFinalIndicator = ackFinalIndicator;
	}

	public String toJson() {
		try {
			ObjectMapper mapper = new ObjectMapper();
			mapper.enable(SerializationFeature.WRAP_ROOT_VALUE);
			mapper.setSerializationInclusion(Include.NON_NULL);
			return mapper.writeValueAsString(this);
		} catch (IOException e) {
		    LOGGER.debug("Exception:", e);
			throw new UnsupportedOperationException("Cannot convert "
				+ getClass().getSimpleName() + " to JSON", e);
		}
	}
}