aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/crud/service/AaiResourceService.java
blob: f7bda6a0499877f599327d02d5900da24c90f11e (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
/**
 * ============LICENSE_START=======================================================
 * Gizmo
 * ================================================================================
 * Copyright © 2017 AT&T Intellectual Property.
 * Copyright © 2017 Amdocs
 * 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=========================================================
 *
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 */
package org.onap.crud.service;

import java.security.cert.X509Certificate;
import java.util.AbstractMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import javax.security.auth.x500.X500Principal;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.Encoded;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.core.Response.Status;

import org.onap.aai.exceptions.AAIException;
import org.onap.aai.serialization.db.EdgeProperty;
import org.onap.aai.serialization.db.EdgeRule;
import org.onap.aai.serialization.db.EdgeRules;
import org.onap.aai.serialization.db.EdgeType;
import org.onap.aaiauth.auth.Auth;
import org.onap.aai.cl.api.Logger;
import org.onap.aai.cl.eelf.LoggerFactory;
import org.onap.crud.exception.CrudException;
import org.onap.crud.logging.CrudServiceMsgs;
import org.onap.crud.logging.LoggingUtil;
import org.onap.crud.service.CrudRestService.Action;
import org.onap.crud.util.CrudServiceConstants;
import org.onap.schema.RelationshipSchemaLoader;
import org.onap.schema.RelationshipSchemaValidator;
import org.slf4j.MDC;

import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonPrimitive;


/**
 * This defines a set of REST endpoints which allow clients to create or update graph edges
 * where the edge rules defined by the A&AI will be invoked to automatically populate the
 * defined edge properties.
 */
public class AaiResourceService {

  private String mediaType = MediaType.APPLICATION_JSON;
  public static final String HTTP_PATCH_METHOD_OVERRIDE = "X-HTTP-Method-Override";
  
  private Auth auth;
  AbstractGraphDataService graphDataService;
  Gson gson = new Gson();
  
  private Logger logger      = LoggerFactory.getInstance().getLogger(AaiResourceService.class.getName());
  private Logger auditLogger = LoggerFactory.getInstance().getAuditLogger(AaiResourceService.class.getName());
 
  public AaiResourceService() {}
  
  /**
   * Creates a new instance of the AaiResourceService.
   * 
   * @param crudGraphDataService - Service used for interacting with the graph.
   * 
   * @throws Exception
   */
  public AaiResourceService(AbstractGraphDataService graphDataService) throws Exception {
    this.graphDataService = graphDataService;
    this.auth = new Auth(CrudServiceConstants.CRD_AUTH_FILE);
  }
  
  /**
   * Perform any one-time initialization required when starting the service.
   */
  public void startup() {
    
    if(logger.isDebugEnabled()) {
      logger.debug("AaiResourceService started!");
    }
  }
  
  
  /**
   * Creates a new relationship in the graph, automatically populating the edge
   * properties based on the A&AI edge rules.
   * 
   * @param content - Json structure describing the relationship to create.
   * @param type    - Relationship type supplied as a URI parameter.
   * @param uri     - Http request uri
   * @param headers - Http request headers
   * @param uriInfo - Http URI info field
   * @param req     - Http request structure.
   * 
   * @return - Standard HTTP response.
   */
  @POST
  @Path("/relationships/{type}/")
  @Consumes({MediaType.APPLICATION_JSON})
  @Produces({MediaType.APPLICATION_JSON})
  public Response createRelationship(String content, 
                                     @PathParam("type") String type, 
                                     @PathParam("uri") @Encoded String uri,
                                     @Context HttpHeaders headers, 
                                     @Context UriInfo uriInfo,
                                     @Context HttpServletRequest req) {
    
    LoggingUtil.initMdcContext(req, headers);

    if(logger.isDebugEnabled()) {
      logger.debug("Incoming request..." + content);
    }
    
    Response response = null;

    if (validateRequest(req, uri, content, Action.POST, CrudServiceConstants.CRD_AUTH_POLICY_NAME)) {
      
      try {
        
        // Extract the edge payload from the request.
        EdgePayload payload = EdgePayload.fromJson(content);   
        
        // Do some basic validation on the payload.
        if (payload.getProperties() == null || payload.getProperties().isJsonNull()) {
          throw new CrudException("Invalid request Payload", Status.BAD_REQUEST);
        }
        if (payload.getId() != null) {
          throw new CrudException("ID specified , use Http PUT to update Edge", Status.BAD_REQUEST);
        }
        if (payload.getType() != null && !payload.getType().equals(type)) {
          throw new CrudException("Edge Type mismatch", Status.BAD_REQUEST);
        }
        
        // Apply the edge rules to our edge.
        payload = applyEdgeRulesToPayload(payload);
        
        if(logger.isDebugEnabled()) {
          logger.debug("Creating AAI edge using version " + RelationshipSchemaLoader.getLatestSchemaVersion() );
        }
        
        // Now, create our edge in the graph store.
        String result = graphDataService.addEdge(RelationshipSchemaLoader.getLatestSchemaVersion(), type, payload);
        response = Response.status(Status.CREATED).entity(result).type(mediaType).build();
        
      } catch (CrudException e) {

        response = Response.status(Status.INTERNAL_SERVER_ERROR).entity(e.getMessage()).build();
      }   
    }
    
    LoggingUtil.logRestRequest(logger, auditLogger, req, response);
    return response;
  }
  
  
  /**
   * Creates a new relationship in the graph, automatically populating the edge
   * properties based on the A&AI edge rules.
   * 
   * @param content - Json structure describing the relationship to create.
   * @param uri     - Http request uri
   * @param headers - Http request headers
   * @param uriInfo - Http URI info field
   * @param req     - Http request structure.
   * 
   * @return - Standard HTTP response.
   *    
   */
  @POST
  @Path("/relationships/")
  @Consumes({MediaType.APPLICATION_JSON})
  @Produces({MediaType.APPLICATION_JSON})
  public Response createRelationship(String content, 
                                     @PathParam("uri") @Encoded String uri, 
                                     @Context HttpHeaders headers,
                                     @Context UriInfo uriInfo, 
                                     @Context HttpServletRequest req) {

    LoggingUtil.initMdcContext(req, headers);

    logger.debug("Incoming request..." + content);
    Response response = null;

    if (validateRequest(req, uri, content, Action.POST, CrudServiceConstants.CRD_AUTH_POLICY_NAME)) {

      try {
        
        // Extract the edge payload from the request.
        EdgePayload payload = EdgePayload.fromJson(content);
        
        // Do some basic validation on the payload.
        if (payload.getProperties() == null || payload.getProperties().isJsonNull()) {
          throw new CrudException("Invalid request Payload", Status.BAD_REQUEST);
        }
        if (payload.getId() != null) {
          throw new CrudException("ID specified , use Http PUT to update Edge", Status.BAD_REQUEST);
        }
        if (payload.getType() == null || payload.getType().isEmpty()) {
          throw new CrudException("Missing Edge Type ", Status.BAD_REQUEST);
        }
        
        // Apply the edge rules to our edge.
        payload = applyEdgeRulesToPayload(payload);
        
        // Now, create our edge in the graph store.
        String result = graphDataService.addEdge(RelationshipSchemaLoader.getLatestSchemaVersion(), payload.getType(), payload);
        response = Response.status(Status.CREATED).entity(result).type(mediaType).build();
      
      } catch (CrudException ce) {
        response = Response.status(ce.getHttpStatus()).entity(ce.getMessage()).build();
      } catch (Exception e) {
        response = Response.status(Status.INTERNAL_SERVER_ERROR).entity(e.getMessage()).build();
      }
    } else {
      response = Response.status(Status.FORBIDDEN).entity(content)
          .type(MediaType.APPLICATION_JSON).build();
    }

    LoggingUtil.logRestRequest(logger, auditLogger, req, response);
    return response;
  }

  
  
  /**
   * Upserts a relationship into the graph, automatically populating the edge properties
   * based on the A&AI edge rules.  The behaviour is as follows:
   * <p>
   * <li>If no relationship with the supplied identifier already exists, then a new relationship 
   * is created with that id.<br>
   * <li>If a relationship with the supplied id DOES exist, then it is replaced with the supplied 
   * content.
   * 
   * @param content - Json structure describing the relationship to create.
   * @param type    - Relationship type supplied as a URI parameter.
   * @param id      - Edge identifier.
   * @param uri     - Http request uri
   * @param headers - Http request headers
   * @param uriInfo - Http URI info field
   * @param req     - Http request structure.
   * 
   * @return - Standard HTTP response.
   */
  @PUT
  @Path("/relationships/{type}/{id}")
  @Consumes({MediaType.APPLICATION_JSON})
  @Produces({MediaType.APPLICATION_JSON})
  public Response upsertEdge(String content, 
                             @PathParam("type") String type, 
                             @PathParam("id") String id,
                             @PathParam("uri") @Encoded String uri, 
                             @Context HttpHeaders headers,
                             @Context UriInfo uriInfo, 
                             @Context HttpServletRequest req) {
    LoggingUtil.initMdcContext(req, headers);

    logger.debug("Incoming request..." + content);
    Response response = null;

    if (validateRequest(req, uri, content, Action.PUT, CrudServiceConstants.CRD_AUTH_POLICY_NAME)) {
      
      try {
        
        // Extract the edge payload from the request.
        EdgePayload payload = EdgePayload.fromJson(content);
        
        // Do some basic validation on the payload.
        if (payload.getProperties() == null || payload.getProperties().isJsonNull()) {
          throw new CrudException("Invalid request Payload", Status.BAD_REQUEST);
        }
        if (payload.getId() != null && !payload.getId().equals(id)) {
          throw new CrudException("ID Mismatch", Status.BAD_REQUEST);
        }
        
        // Apply the edge rules to our edge.
        payload = applyEdgeRulesToPayload(payload);
        
        String result;
        if (headers.getRequestHeaders().getFirst(HTTP_PATCH_METHOD_OVERRIDE) != null &&
            headers.getRequestHeaders().getFirst(HTTP_PATCH_METHOD_OVERRIDE).equalsIgnoreCase("PATCH")) {
          result = graphDataService.patchEdge(RelationshipSchemaLoader.getLatestSchemaVersion(), id, type, payload);
        } else {

          result = graphDataService.updateEdge(RelationshipSchemaLoader.getLatestSchemaVersion(), id, type, payload);
        }

        response = Response.status(Status.OK).entity(result).type(mediaType).build();
        
      } catch (CrudException ce) {
        response = Response.status(ce.getHttpStatus()).entity(ce.getMessage()).build();
      } catch (Exception e) {
        response = Response.status(Status.INTERNAL_SERVER_ERROR).entity(e.getMessage()).build();
      }
      
    } else {
      
      response = Response.status(Status.FORBIDDEN).entity(content)
          .type(MediaType.APPLICATION_JSON).build();
    }
    
    LoggingUtil.logRestRequest(logger, auditLogger, req, response);
    return response;
  }
  
  
  /**
   * Retrieves the properties defined in the edge rules for a relationship between the 
   * supplied vertex types.
   * 
   * @param sourceVertexType - Type of source vertex for the relationship.
   * @param targetVertexType - Type of target vertex for the relationship.
   * 
   * @return - The defined properties for the relationship type.
   *  
   * @throws CrudException
   */
  private Map<EdgeProperty, String> getEdgeRuleProperties(String sourceVertexType, String targetVertexType) throws CrudException {

    if(logger.isDebugEnabled()) {
      logger.debug("Lookup db edge rules for " + sourceVertexType + " -> " + targetVertexType);
    }
    
    EdgeRules rules = EdgeRules.getInstance();
    EdgeRule rule;
    try {
      
      if(logger.isDebugEnabled()) {
        logger.debug("Lookup by edge type TREE");
      }
      
      // We have no way of knowing in advance whether our relationship is considered to
      // be a tree or cousing relationship, so try looking it up as a tree type first.
      rule = rules.getEdgeRule(EdgeType.TREE, sourceVertexType, targetVertexType);
      
    } catch (AAIException e) {
      try {
        
        if(logger.isDebugEnabled()) {
          logger.debug("Lookup by edge type COUSIN");
        }
        
        // If we are here, then our lookup by 'tree' type failed, so try looking it up
        // as a 'cousin' relationship.
        rule = rules.getEdgeRule(EdgeType.COUSIN, sourceVertexType, targetVertexType);
        
      } catch (AAIException e1) {
        
        // If we're here then we failed to find edge rules for this relationship.  Time to
        // give up...
        throw new CrudException("No edge rules for " + sourceVertexType + " -> " + targetVertexType, Status.NOT_FOUND);
      }
    } catch (Exception e) {
      
      throw new CrudException("General failure getting edge rule properties - " + 
                              e.getMessage(), Status.INTERNAL_SERVER_ERROR);
    }
    
    return rule.getEdgeProperties();
  }
  
  
  /**
   * This method takes an inbound edge request payload, looks up the edge rules for the
   * sort of relationship defined in the payload, and automatically applies the defined
   * edge properties to it.
   * 
   * @param payload - The original edge request payload
   * 
   * @return - An updated edge request payload, with the properties defined in the edge
   *           rules automatically populated.
   *           
   * @throws CrudException
   */
  public EdgePayload applyEdgeRulesToPayload(EdgePayload payload) throws CrudException {
    
    // Extract the types for both the source and target vertices.
    String srcType = RelationshipSchemaValidator.vertexTypeFromUri(payload.getSource());
    String tgtType = RelationshipSchemaValidator.vertexTypeFromUri(payload.getTarget());

      // Now, get the default properties for this edge based on the edge rules definition...
      Map<EdgeProperty, String> props = getEdgeRuleProperties(srcType, tgtType);
      
      // ...and merge them with any custom properties provided in the request.
      JsonElement mergedProperties = mergeProperties(payload.getProperties(), props);
      payload.setProperties(mergedProperties);
    
    
    if(logger.isDebugEnabled()) {
      logger.debug("Edge properties after applying rules for '" + srcType + " -> " + tgtType + "': " + mergedProperties);
    }
    
    return payload;
  }
  
  
  /**
   * Given a set of edge properties extracted from an edge request payload and a set of properties
   * taken from the db edge rules, this method merges them into one set of properties.
   * <p>
   * If the client has attempted to override the defined value for a property in the db edge rules
   * then the request will be rejected as invalid.
   * 
   * @param propertiesFromRequest - Set of properties from the edge request.
   * @param propertyDefaults      - Set of properties from the db edge rules.
   * 
   * @return - A merged set of properties.
   * 
   * @throws CrudException
   */
  public JsonElement mergeProperties(JsonElement propertiesFromRequest, Map<EdgeProperty, String> propertyDefaults) throws CrudException {
        
    // Convert the properties from the edge payload into something we can
    // manipulate.
    Set<Map.Entry<String, JsonElement>> properties = new HashSet<Map.Entry<String, JsonElement>>();
    properties.addAll(propertiesFromRequest.getAsJsonObject().entrySet());
    
    Set<String> propertyKeys = new HashSet<String>();
    for(Map.Entry<String, JsonElement> property : properties) {
      propertyKeys.add(property.getKey());
    }
    
    // Now, merge in the properties specified in the Db Edge Rules.
    for(EdgeProperty defProperty : propertyDefaults.keySet()) {
      
      // If the edge rules property was explicitly specified by the
      // client then we will reject the request...
      if(!propertyKeys.contains(defProperty.toString())) {
        properties.add(new AbstractMap.SimpleEntry<String, JsonElement>(defProperty.toString(),
            (JsonElement)(new JsonPrimitive(propertyDefaults.get(defProperty)))));
        
      } else {
        throw new CrudException("Property " + defProperty + " defined in db edge rules can not be overriden by the client.", 
                                Status.BAD_REQUEST);
      }    
    }

    Object[] propArray = properties.toArray();
    StringBuilder sb = new StringBuilder();
    sb.append("{");
    boolean first=true;
    for(int i=0; i<propArray.length; i++) {
      
      Map.Entry<String, JsonElement> entry = (Entry<String, JsonElement>) propArray[i];
      if(!first) {
        sb.append(",");
      }
      sb.append("\"").append(entry.getKey()).append("\"").append(":").append(entry.getValue());
      first=false;
    }
    sb.append("}");
    
    // We're done.  Return the result as a JsonElement.
    return gson.fromJson(sb.toString(), JsonElement.class);
  }


  /**
   * Invokes authentication validation on an incoming HTTP request.
   * 
   * @param req                    - The HTTP request.
   * @param uri                    - HTTP URI
   * @param content                - Payload of the HTTP request.
   * @param action                 - What HTTP action is being performed (GET/PUT/POST/PATCH/DELETE)
   * @param authPolicyFunctionName - Policy function being invoked.
   * 
   * @return true  - if the request passes validation,
   *         false - otherwise.
   */
  protected boolean validateRequest(HttpServletRequest req, 
                                    String uri, 
                                    String content,
                                    Action action, 
                                    String authPolicyFunctionName) {
    try {
      String cipherSuite = (String) req.getAttribute("javax.servlet.request.cipher_suite");
      String authUser = null;
      if (cipherSuite != null) {
                
        X509Certificate[] certChain = (X509Certificate[]) req.getAttribute("javax.servlet.request.X509Certificate");
        X509Certificate clientCert = certChain[0];
        X500Principal subjectDn = clientCert.getSubjectX500Principal();
        authUser = subjectDn.toString();
      }
      
      return this.auth.validateRequest(authUser.toLowerCase(), action.toString() + ":" + authPolicyFunctionName);
      
    } catch (Exception e) {
      logResult(action, uri, e);
      return false;
    }
  }
  
  protected void logResult(Action op, String uri, Exception e) {

    logger.error(CrudServiceMsgs.EXCEPTION_DURING_METHOD_CALL, 
                 op.toString(), 
                 uri, 
                 e.getStackTrace().toString());

    // Clear the MDC context so that no other transaction inadvertently
    // uses our transaction id.
    MDC.clear();
  }
}