2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
22 package org.openecomp.appc.provider;
24 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160104.TIMESTAMP;
25 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160104.common.response.header.CommonResponseHeader;
26 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160104.common.response.header.CommonResponseHeaderBuilder;
27 import org.openecomp.appc.util.Time;
29 import java.text.DateFormat;
30 import java.text.SimpleDateFormat;
34 * Builds the responses from the APP-C services according to the YANG domainmodel
39 public class ResponseHeaderBuilder {
42 * The date/time formatter to format timestamps.
44 @SuppressWarnings("nls")
45 public static final DateFormat FORMATTER = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSSSSS");
46 public static final DateFormat ZULU_FORMATTER = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SS'Z'");
49 * Private default constructor prevents instantiation
51 private ResponseHeaderBuilder() {
55 * This method builds the common response header and returns it to the caller for integration into the response
58 * True or false indicating the outcome of the operation. True indicates that the operation was
59 * successful, false indicates it failed.
61 * The original request id for the service
63 * The reason for the failure if the success flag is false. If success is true, the reason is not used.
65 * The duration of the request processing
66 * @return The common response header to be returned to the caller.
68 @SuppressWarnings("nls")
69 public static CommonResponseHeader buildHeader(Boolean success, String requestId, String reason, long duration) {
70 CommonResponseHeaderBuilder builder = new CommonResponseHeaderBuilder();
72 TIMESTAMP timestamp = new TIMESTAMP(FORMATTER.format(Time.utcDate()));
73 builder.setServiceRequestId(requestId);
74 builder.setCompleted(timestamp);
75 builder.setDuration(duration);
76 builder.setSuccess(success);
78 if (success.equals(Boolean.TRUE)) {
79 builder.setReason("Success");
81 builder.setReason(reason);
84 return builder.build();