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
|
/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
*/
package org.onap.sdc.dcae.catalog.engine;
import org.onap.sdc.common.onaplog.Enums.LogLevel;
import org.onap.sdc.common.onaplog.OnapLoggerDebug;
import org.onap.sdc.dcae.catalog.asdc.ASDCCatalog;
import org.onap.sdc.dcae.catalog.commons.Future;
import org.onap.sdc.dcae.catalog.commons.FutureHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.async.DeferredResult;
/**
* All requests body:
* {
* "id": optional request uuid,
* "timestamp": optional request timestamp,
* "catalog": optional catalog uri,
* "timeout": optional timeout - default 0 no time limit
* }
*
* All responses body:
* { "data": {},
* "error": {}
* }
*
* If a non-2xx reponse is provided and error occured at catalog engine processing level.
* If error has occured in data retrieval then the response error object is not empty.
*
* Available uris
* /catalog
* /elements : roots of the catalog; request body is optional but can specify a label under 'startingLabel'
* response contains items under 'data/elements'
* /{itemId}/elements : catalog descendants of the given item, possibly a mix of folders and items
* response contains items under 'data/elements'
* /lookup.by.name : lookup catalog entries by name.
The request body must contain a 'selector' entry with a 'name' criteria
* response contains items under 'data/elements'
* Example: '{"id":"5d0c1cf4-11aa-11e6-a148-3e1d05defe78","selector":{"name":"Firewall"}}'
* /lookup.by.annotation
The request body must contain a 'annotation' entry and it can have a 'selector' entry
* with a multiple annotation property criteria
* response contains items under 'data/elements'
* /lookup.by.model.property.value :
* The request must contain a "selector" entry as a JSONObject containing the selection criteria
* (property name with values) and desired output properties (null values). Example:
* "selector":{"att-part-number":"L-CSR-50M-APP-3Y",
* "management-option":"ATT",
* "vnf-type":null,
* "vendor-model":null}
* response contains items under 'data/elements'
* /referents : provides generic recommendations
* response contains items under 'data/elements'
* /{itemId}/referents : provides recommendations for the given item
* response contains items under 'data/elements'
* /{itemId}/model : retrieves the TOSCA model for the item with the given id
* response under 'data/model'
*
*/
@RestController
@CrossOrigin(origins="*")
public class CatalogController {
private static OnapLoggerDebug debugLogger = OnapLoggerDebug.getInstance();
@Autowired
private ASDCCatalog catalog;
public ASDCCatalog getCatalog() {
return catalog;
}
public abstract class CatalogHandler<T> implements FutureHandler<T> {
protected DeferredResult result;
protected CatalogRequest request;
public CatalogHandler(CatalogRequest theRequest, DeferredResult theResult) {
this.request = theRequest;
this.result = theResult;
}
public abstract CatalogResponse handleData(T theData);
//@Override
public void handle(Future<T> theEvent) {
debugLogger.log(LogLevel.DEBUG, this.getClass().getName(), "handle");
if (this.result.isSetOrExpired()) {
debugLogger.log(LogLevel.WARN, this.getClass().getName(), "handle, Data is late");
return;
}
if (theEvent.failed()) {
this.result.setErrorResult(new CatalogError(this.request, "Catalog API failed", theEvent.cause()));
}
else {
debugLogger.log(LogLevel.DEBUG, this.getClass().getName(), "handle, got: {}", theEvent.result());
CatalogResponse response = handleData(theEvent.result());
//a null result allows the accumulatorHandler to pass the processing onto some other async processing stage
if (response != null) {
if (!this.result.setResult(response)) {
this.result.setErrorResult(new CatalogError(this.request, "Catalog API call successful but late"));
}
}
}
}
}
}
|
