summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/openecomp/sa/rest/ApiUtils.java
blob: dc7f0cb2577795784be5db614be3792c44130438 (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * Copyright © 2017 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=========================================================
 *
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 */
package org.openecomp.sa.rest;

import org.openecomp.cl.mdc.MdcContext;
import org.openecomp.sa.searchdbabstraction.util.SearchDbConstants;
import org.slf4j.MDC;

import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.Response;


public class ApiUtils {

  public static final String SEARCH_AUTH_POLICY_NAME = "search";
  public static final String URL_PREFIX = "services/search-data-service/v1/search";

  public enum Action {
    POST, GET, PUT, DELETE
  }

  ;


  /**
   * This method uses the contents of the supplied HTTP headers and request
   * structures to populate the MDC Context used for logging purposes.
   *
   * @param httpReq - HTTP request structure.
   * @param headers - HTTP headers
   */
  protected static void initMdcContext(HttpServletRequest httpReq, HttpHeaders headers) {

    // Auto generate a transaction if we were not provided one.
    String transId = null;
    if (headers != null) {
      transId = headers.getRequestHeaders().getFirst("X-TransactionId");

      if ((transId == null) || (transId.equals(""))) {
        transId = UUID.randomUUID().toString();
      }
    }

    String fromIp = (httpReq != null) ? httpReq.getRemoteAddr() : "";
    String fromApp = (headers != null) ? headers.getRequestHeaders().getFirst("X-FromAppId") : "";

    MdcContext.initialize(transId, SearchDbConstants.SDB_SERVICE_NAME, "", fromApp, fromIp);
  }


  protected static void clearMdcContext() {
    MDC.clear();
  }

  public static String buildIndexUri(String index) {

    return (URL_PREFIX + "/indexes/") + index;
  }

  public static String buildDocumentUri(String index, String documentId) {

    return buildIndexUri(index) + "/documents/" + documentId;
  }

  public static boolean validateIndexUri(String uri) {

    // If the URI starts with a leading '/' character, remove it.
    uri = uri.startsWith("/") ? uri.substring(1) : uri;

    // Now, tokenize the URI string.
    String[] tokens = uri.split("/");

    return (tokens.length == 6) && (tokens[4].equals("indexes"));

  }

  public static boolean validateDocumentUri(String uri, boolean requireId) {

    // If the URI starts with a leading '/' character, remove it.
    uri = uri.startsWith("/") ? uri.substring(1) : uri;

    // Now, tokenize the URI string.
    String[] tokens = uri.split("/");

    if (requireId) {
      return (tokens.length == 8) && (tokens[4].equals("indexes")
          && (tokens[6].equals("documents")));
    } else {
      return ((tokens.length == 8) || (tokens.length == 7))
          && (tokens[4].equals("indexes") && (tokens[6].equals("documents")));
    }
  }

  public static String extractIndexFromUri(String uri) {

    // If the URI starts with a leading '/' character, remove it.
    uri = uri.startsWith("/") ? uri.substring(1) : uri;

    // Now, tokenize the URI string.
    String[] tokens = uri.split("/");

    int i = 0;
    for (String token : tokens) {
      if (token.equals("indexes")) {
        if (i + 1 < tokens.length) {
          return tokens[i + 1];
        }
      }
      i++;
    }

    return null;
  }

  public static String extractIdFromUri(String uri) {

    // If the URI starts with a leading '/' character, remove it.
    uri = uri.startsWith("/") ? uri.substring(1) : uri;

    // Now, tokenize the URI string.
    String[] tokens = uri.split("/");

    int i = 0;
    for (String token : tokens) {
      if (token.equals("documents")) {
        if (i + 1 < tokens.length) {
          return tokens[i + 1];
        }
      }
      i++;
    }

    return null;
  }

  public static String getHttpStatusString(int httpStatusCode) {
    // Some of the status codes we use are still in draft state in the standards, and are not
    // recognized in the javax library.  We need to manually translate these to human-readable
    // strings.
    String statusString = "Unknown";
    Response.Status status = Response.Status.fromStatusCode(httpStatusCode);

    if (status == null) {
      switch (httpStatusCode) {
        case 207:
          statusString = "Multi Status";
          break;
        default:
      }
    } else {
      statusString = status.toString();
    }

    return statusString;
  }
}