{
"basePath": "/",
"paths": {
- "/producer_simulator/job_deleted_error": {"post": {
- "summary": "Callback for EI job creation, returns error",
- "deprecated": false,
- "produces": ["application/json"],
- "operationId": "jobDeletedCallbackReturnErrorUsingPOST",
- "responses": {
- "200": {"description": "OK"},
- "201": {"description": "Created"},
- "401": {"description": "Unauthorized"},
- "403": {"description": "Forbidden"},
- "404": {"description": "Not Found"}
- },
- "parameters": [{
- "schema": {"$ref": "#/definitions/producer_ei_job_request"},
- "in": "body",
- "name": "request",
- "description": "request",
- "required": true
- }],
- "tags": ["Producer Simulator"],
- "consumes": ["application/json"]
- }},
"/producer_simulator/supervision": {"get": {
"summary": "Producer supervision",
"deprecated": false,
"403": {"description": "Forbidden"},
"404": {"description": "Not Found"}
},
- "tags": ["Producer Simulator"]
- }},
- "/A1-EI/v1/eitypes/{eiTypeId}/eijobs": {"get": {
- "summary": "EI job identifiers",
- "deprecated": false,
- "produces": ["application/json"],
- "operationId": "getEiJobIdsUsingGET",
- "responses": {
- "200": {
- "schema": {
- "type": "array",
- "items": {"type": "string"}
- },
- "description": "EI job identifiers"
- },
- "401": {"description": "Unauthorized"},
- "403": {"description": "Forbidden"},
- "404": {
- "schema": {"$ref": "#/definitions/error_information"},
- "description": "Enrichment Information type is not found"
- }
- },
- "parameters": [
- {
- "in": "path",
- "name": "eiTypeId",
- "description": "eiTypeId",
- "type": "string",
- "required": true
- },
- {
- "in": "query",
- "allowEmptyValue": false,
- "name": "owner",
- "description": "identifies the owner of the job",
- "type": "string",
- "required": false
- }
- ],
- "tags": ["A1-E Enrichment Data Consumer API"]
+ "tags": ["Producer Callbacks"]
}},
"/A1-EI/v1/eitypes/{eiTypeId}": {"get": {
"summary": "Individual EI type",
"operationId": "getEiTypeUsingGET",
"responses": {
"200": {
- "schema": {"$ref": "#/definitions/EiType"},
+ "schema": {"$ref": "#/definitions/EiTypeObject"},
"description": "EI type"
},
"401": {"description": "Unauthorized"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
"description": "Enrichment Information type is not found"
}
},
"type": "string",
"required": true
}],
- "tags": ["A1-E Enrichment Data Consumer API"]
+ "tags": ["A1-EI (enrichment information)"]
}},
"/ei-producer/v1/eitypes": {"get": {
"summary": "EI type identifiers",
"403": {"description": "Forbidden"},
"404": {"description": "Not Found"}
},
- "tags": ["A1-E Enrichment Data Consumer API"]
+ "tags": ["A1-EI (enrichment information)"]
}},
"/producer_simulator/job_deleted": {"post": {
"summary": "Callback for EI job deletion",
"description": "request",
"required": true
}],
- "tags": ["Producer Simulator"],
+ "tags": ["Producer Callbacks"],
"consumes": ["application/json"]
}},
- "/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status": {"get": {
- "summary": "EI Job status",
- "deprecated": false,
- "produces": ["application/json"],
- "operationId": "getEiJobStatusUsingGET",
- "responses": {
- "200": {
- "schema": {"$ref": "#/definitions/EiJobStatus"},
- "description": "EI Job status"
- },
- "401": {"description": "Unauthorized"},
- "403": {"description": "Forbidden"},
- "404": {
- "schema": {"$ref": "#/definitions/error_information"},
- "description": "Enrichment Information type or job is not found"
- }
- },
- "parameters": [
- {
- "in": "path",
- "name": "eiJobId",
- "description": "eiJobId",
- "type": "string",
- "required": true
- },
- {
- "in": "path",
- "name": "eiTypeId",
- "description": "eiTypeId",
- "type": "string",
- "required": true
- }
- ],
- "tags": ["A1-E Enrichment Data Consumer API"]
- }},
"/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
"summary": "EI producer status",
"deprecated": false,
"401": {"description": "Unauthorized"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
"description": "Enrichment Information producer is not found"
}
},
}],
"tags": ["Enrichment Data Producer API"]
}},
- "/producer_simulator/supervision_error": {"get": {
- "summary": "Producer supervision error",
- "deprecated": false,
- "produces": ["application/json"],
- "operationId": "producerSupervisionErrorUsingGET",
- "responses": {
- "200": {
- "schema": {"type": "string"},
- "description": "OK"
- },
- "401": {"description": "Unauthorized"},
- "403": {"description": "Forbidden"},
- "404": {"description": "Not Found"}
- },
- "tags": ["Producer Simulator"]
- }},
"/ei-producer/v1/eiproducers": {"get": {
"summary": "EI producer identifiers",
"deprecated": false,
"tags": ["Enrichment Data Producer API"]
}},
"/ei-producer/v1/eitypes/{eiTypeId}": {"get": {
- "summary": "Individual EI Type",
+ "summary": "Individual EI type",
"deprecated": false,
"produces": ["application/json"],
"operationId": "getEiTypeUsingGET_1",
"401": {"description": "Unauthorized"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
"description": "Enrichment Information type is not found"
}
},
},
"tags": ["Service status"]
}},
- "/producer_simulator/job_created_error": {"post": {
- "summary": "Callback for EI job creation, returns error",
- "deprecated": false,
- "produces": ["application/json"],
- "operationId": "jobCreatedCallbackReturnErrorUsingPOST",
- "responses": {
- "200": {"description": "OK"},
- "201": {"description": "Created"},
- "401": {"description": "Unauthorized"},
- "403": {"description": "Forbidden"},
- "404": {"description": "Not Found"}
- },
- "parameters": [{
- "schema": {"$ref": "#/definitions/producer_ei_job_request"},
- "in": "body",
- "name": "request",
- "description": "request",
- "required": true
- }],
- "tags": ["Producer Simulator"],
- "consumes": ["application/json"]
- }},
- "/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}": {
+ "/A1-EI/v1/eijobs/{eiJobId}": {
"get": {
- "summary": "Individual EI Job",
+ "summary": "Individual EI job",
"deprecated": false,
"produces": ["application/json"],
"operationId": "getIndividualEiJobUsingGET",
"responses": {
"200": {
- "schema": {"$ref": "#/definitions/EiJob"},
- "description": "EI Job"
+ "schema": {"$ref": "#/definitions/EiJobObject"},
+ "description": "EI job"
},
"401": {"description": "Unauthorized"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
- "description": "Enrichment Information type or job is not found"
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
+ "description": "Enrichment Information job is not found"
}
},
- "parameters": [
- {
- "in": "path",
- "name": "eiJobId",
- "description": "eiJobId",
- "type": "string",
- "required": true
- },
- {
- "in": "path",
- "name": "eiTypeId",
- "description": "eiTypeId",
- "type": "string",
- "required": true
- }
- ],
- "tags": ["A1-E Enrichment Data Consumer API"]
+ "parameters": [{
+ "in": "path",
+ "name": "eiJobId",
+ "description": "eiJobId",
+ "type": "string",
+ "required": true
+ }],
+ "tags": ["A1-EI (enrichment information)"]
},
"delete": {
- "summary": "Individual EI Job",
+ "summary": "Individual EI job",
"deprecated": false,
"produces": ["application/json"],
"operationId": "deleteIndividualEiJobUsingDELETE",
"204": {"description": "Job deleted"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
- "description": "Enrichment Information type or job is not found"
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
+ "description": "Enrichment Information job is not found"
}
},
- "parameters": [
- {
- "in": "path",
- "name": "eiJobId",
- "description": "eiJobId",
- "type": "string",
- "required": true
- },
- {
- "in": "path",
- "name": "eiTypeId",
- "description": "eiTypeId",
- "type": "string",
- "required": true
- }
- ],
- "tags": ["A1-E Enrichment Data Consumer API"]
+ "parameters": [{
+ "in": "path",
+ "name": "eiJobId",
+ "description": "eiJobId",
+ "type": "string",
+ "required": true
+ }],
+ "tags": ["A1-EI (enrichment information)"]
},
"put": {
- "summary": "Individual EI Job",
+ "summary": "Individual EI job",
"deprecated": false,
"produces": ["application/json"],
"operationId": "putIndividualEiJobUsingPUT",
"401": {"description": "Unauthorized"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
"description": "Enrichment Information type is not found"
}
},
"required": true
},
{
- "schema": {"$ref": "#/definitions/EiJob"},
+ "schema": {"$ref": "#/definitions/EiJobObject"},
"in": "body",
- "name": "eiJobInfo",
- "description": "eiJobInfo",
- "required": true
- },
- {
- "in": "path",
- "name": "eiTypeId",
- "description": "eiTypeId",
- "type": "string",
+ "name": "eiJobObject",
+ "description": "eiJobObject",
"required": true
}
],
- "tags": ["A1-E Enrichment Data Consumer API"],
+ "tags": ["A1-EI (enrichment information)"],
"consumes": ["application/json"]
}
},
"responses": {
"200": {
"schema": {"$ref": "#/definitions/producer_registration_info"},
- "description": "EI Jobs"
+ "description": "EI jobs"
},
"401": {"description": "Unauthorized"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
"description": "Enrichment Information producer is not found"
}
},
"204": {"description": "Producer deleted"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
"description": "Producer is not found"
}
},
"401": {"description": "Unauthorized"},
"403": {"description": "Forbidden"},
"404": {
- "schema": {"$ref": "#/definitions/error_information"},
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
"description": "Enrichment Information producer is not found"
}
},
}],
"tags": ["Enrichment Data Producer API"]
}},
+ "/A1-EI/v1/eijobs": {"get": {
+ "summary": "EI job identifiers",
+ "deprecated": false,
+ "produces": ["application/json"],
+ "description": "query for EI job identifiers",
+ "operationId": "getEiJobIdsUsingGET",
+ "responses": {
+ "200": {
+ "schema": {
+ "type": "array",
+ "items": {"type": "string"}
+ },
+ "description": "EI job identifiers"
+ },
+ "401": {"description": "Unauthorized"},
+ "403": {"description": "Forbidden"},
+ "404": {
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
+ "description": "Enrichment Information type is not found"
+ }
+ },
+ "parameters": [
+ {
+ "in": "query",
+ "allowEmptyValue": false,
+ "name": "eiTypeId",
+ "description": "selects EI jobs of matching EI type",
+ "type": "string",
+ "required": false
+ },
+ {
+ "in": "query",
+ "allowEmptyValue": false,
+ "name": "owner",
+ "description": "selects EI jobs for one EI job owner",
+ "type": "string",
+ "required": false
+ }
+ ],
+ "tags": ["A1-EI (enrichment information)"]
+ }},
+ "/A1-EI/v1/eijobs/{eiJobId}/status": {"get": {
+ "summary": "EI job status",
+ "deprecated": false,
+ "produces": ["application/json"],
+ "operationId": "getEiJobStatusUsingGET",
+ "responses": {
+ "200": {
+ "schema": {"$ref": "#/definitions/EiJobStatusObject"},
+ "description": "EI job status"
+ },
+ "401": {"description": "Unauthorized"},
+ "403": {"description": "Forbidden"},
+ "404": {
+ "schema": {"$ref": "#/definitions/ProblemDetails"},
+ "description": "Enrichment Information job is not found"
+ }
+ },
+ "parameters": [{
+ "in": "path",
+ "name": "eiJobId",
+ "description": "eiJobId",
+ "type": "string",
+ "required": true
+ }],
+ "tags": ["A1-EI (enrichment information)"]
+ }},
"/producer_simulator/job_created": {"post": {
"summary": "Callback for EI job creation",
"deprecated": false,
"description": "request",
"required": true
}],
- "tags": ["Producer Simulator"],
+ "tags": ["Producer Callbacks"],
"consumes": ["application/json"]
}}
},
- "host": "localhost:45709",
+ "host": "localhost:42127",
"definitions": {
- "EiType": {
- "description": "Information for an EI type",
- "type": "object",
- "title": "EiType",
- "properties": {"eiJobParametersSchema": {
- "description": "Json schema for the job data",
- "type": "object"
- }}
- },
"producer_ei_job_request": {
"description": "The body of the EI producer callbacks for EI job creation and deletion",
"type": "object",
}
}
},
- "error_information": {
- "description": "Problem as defined in https://tools.ietf.org/html/rfc7807",
- "type": "object",
- "title": "error_information",
- "properties": {
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.",
- "type": "string",
- "example": "EI job type not found"
- },
- "status": {
- "format": "int32",
- "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
- "type": "integer",
- "example": 404
- }
- }
- },
- "void": {
- "description": "Void/empty",
- "type": "object",
- "title": "void"
- },
- "EiJob": {
- "description": "Information for an Enrichment Information Job",
+ "EiTypeObject": {
+ "description": "Information for an EI type",
"type": "object",
- "title": "EiJob",
- "required": [
- "jobOwner",
- "jobParameters",
- "targetUri"
- ],
- "properties": {
- "targetUri": {
- "description": "The target of the EI data",
- "type": "string"
- },
- "jobOwner": {
- "description": "Identity of the owner of the job",
- "type": "string"
- },
- "jobParameters": {
- "description": "EI Type specific job data",
- "type": "object"
- }
- }
+ "title": "EiTypeObject"
},
"producer_ei_type_registration_info": {
"description": "Information for an EI type",
}
}
},
- "EiJobStatus": {
- "description": "Status for an EI Job",
- "type": "object",
- "title": "EiJobStatus",
- "required": ["operationalState"],
- "properties": {"operationalState": {
- "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
- "type": "string",
- "enum": [
- "ENABLED",
- "DISABLED"
- ]
- }}
- },
"Mono«ResponseEntity«object»»": {
"type": "object",
"title": "Mono«ResponseEntity«object»»"
"DISABLED"
]
}}
+ },
+ "ProblemDetails": {
+ "description": "A problem detail to carry details in a HTTP response according to RFC 7807",
+ "type": "object",
+ "title": "ProblemDetails",
+ "properties": {
+ "detail": {
+ "description": "A human-readable explanation specific to this occurrence of the problem.",
+ "type": "string",
+ "example": "EI job type not found"
+ },
+ "status": {
+ "format": "int32",
+ "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
+ "type": "integer",
+ "example": 404
+ }
+ }
+ },
+ "Void": {
+ "description": "Void/empty",
+ "type": "object",
+ "title": "Void"
+ },
+ "EiJobStatusObject": {
+ "description": "Status for an EI job",
+ "type": "object",
+ "title": "EiJobStatusObject",
+ "required": ["eiJobStatus"],
+ "properties": {"eiJobStatus": {
+ "description": "values:\nENABLED: the A1-EI producer is able to deliver EI result for the EI job\nDISABLED: the A1-EI producer is unable to deliver EI result for the EI job",
+ "type": "string",
+ "enum": [
+ "ENABLED",
+ "DISABLED"
+ ]
+ }}
+ },
+ "EiJobObject": {
+ "description": "Information for an Enrichment Information Job",
+ "type": "object",
+ "title": "EiJobObject",
+ "required": [
+ "eiTypeId",
+ "jobDefinition",
+ "jobOwner",
+ "jobResultUri"
+ ],
+ "properties": {
+ "eiTypeId": {
+ "description": "EI type Idenitifier of the EI job",
+ "type": "string"
+ },
+ "jobResultUri": {
+ "description": "The target URI of the EI data",
+ "type": "string"
+ },
+ "jobOwner": {
+ "description": "Identity of the owner of the job",
+ "type": "string"
+ },
+ "jobStatusNotificationUri": {
+ "description": "The target of EI job status notifications",
+ "type": "string"
+ },
+ "jobDefinition": {
+ "description": "EI type specific job data",
+ "type": "object"
+ }
+ }
}
},
"swagger": "2.0",
},
"tags": [
{
- "name": "A1-E Enrichment Data Consumer API",
+ "name": "A1-EI (enrichment information)",
"description": "Consumer Controller"
},
{
"description": "Producer Controller"
},
{
- "name": "Producer Simulator",
+ "name": "Producer Callbacks",
"description": "Producer Simulator Controller"
},
{
public class ProducerCallbacks {
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- private static Gson gson = new GsonBuilder() //
- .serializeNulls() //
- .create(); //
+ private static Gson gson = new GsonBuilder().create();
private final AsyncRestClient restClient;
import reactor.core.publisher.Mono;
public class ErrorResponse {
- private static Gson gson = new GsonBuilder() //
- .create(); //
+ private static Gson gson = new GsonBuilder().create();
// Returned as body for all failed REST calls
- @ApiModel(value = "error_information", description = "Problem as defined in https://tools.ietf.org/html/rfc7807")
+ @ApiModel(
+ value = "ProblemDetails",
+ description = "A problem detail to carry details in a HTTP response according to RFC 7807")
public static class ErrorInfo {
@SerializedName("type")
private String type = "about:blank";
import org.immutables.gson.Gson;
@Gson.TypeAdapters
-@ApiModel(value = "void", description = "Void/empty")
+@ApiModel(value = "Void", description = "Void/empty")
public class VoidResponse {
private VoidResponse() {
}
public class ConsumerConsts {
public static final String API_ROOT = "/A1-EI/v1";
- public static final String CONSUMER_API_NAME = "A1-E Enrichment Data Consumer API";
+ public static final String CONSUMER_API_NAME = "A1-EI (enrichment information)";
public static final String OWNER_PARAM = "owner";
- public static final String OWNER_PARAM_DESCRIPTION = "identifies the owner of the job";
+ public static final String OWNER_PARAM_DESCRIPTION = "selects EI jobs for one EI job owner";
+
+ public static final String EI_TYPE_ID_PARAM = "eiTypeId";
+ public static final String EI_TYPE_ID_PARAM_DESCRIPTION = "selects EI jobs of matching EI type";
private ConsumerConsts() {
}
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Mono;
@SuppressWarnings("java:S3457") // No need to call "toString()" method as formatting and string ..
@RestController("ConsumerController")
@Api(tags = {ConsumerConsts.CONSUMER_API_NAME})
+@RequestMapping(path = ConsumerConsts.API_ROOT, produces = MediaType.APPLICATION_JSON_VALUE)
public class ConsumerController {
@Autowired
ProducerCallbacks producerCallbacks;
private static Gson gson = new GsonBuilder() //
- .serializeNulls() //
.create(); //
- @GetMapping(path = ConsumerConsts.API_ROOT + "/eitypes", produces = MediaType.APPLICATION_JSON_VALUE)
+ @GetMapping(path = "/eitypes", produces = MediaType.APPLICATION_JSON_VALUE)
@ApiOperation(value = "EI type identifiers", notes = "")
@ApiResponses(
value = { //
return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
}
- @GetMapping(path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE)
+ @GetMapping(path = "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE)
@ApiOperation(value = "Individual EI type", notes = "")
@ApiResponses(
value = { //
public ResponseEntity<Object> getEiType( //
@PathVariable("eiTypeId") String eiTypeId) {
try {
- EiType t = this.eiTypes.getType(eiTypeId);
- ConsumerEiTypeInfo info = toEiTypeInfo(t);
+ this.eiTypes.getType(eiTypeId); // Make sure that the type exists
+ ConsumerEiTypeInfo info = toEiTypeInfo();
return new ResponseEntity<>(gson.toJson(info), HttpStatus.OK);
} catch (Exception e) {
return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
}
}
- @GetMapping(
- path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs",
- produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "EI job identifiers", notes = "")
+ @GetMapping(path = "/eijobs", produces = MediaType.APPLICATION_JSON_VALUE)
+ @ApiOperation(value = "EI job identifiers", notes = "query for EI job identifiers")
@ApiResponses(
value = { //
@ApiResponse(
message = "Enrichment Information type is not found",
response = ErrorResponse.ErrorInfo.class)})
public ResponseEntity<Object> getEiJobIds( //
- @PathVariable("eiTypeId") String eiTypeId, //
+ @ApiParam(
+ name = ConsumerConsts.EI_TYPE_ID_PARAM,
+ required = false, //
+ value = ConsumerConsts.EI_TYPE_ID_PARAM_DESCRIPTION) //
+ @RequestParam(name = ConsumerConsts.EI_TYPE_ID_PARAM, required = false) String eiTypeId,
@ApiParam(
name = ConsumerConsts.OWNER_PARAM,
required = false, //
value = ConsumerConsts.OWNER_PARAM_DESCRIPTION) //
@RequestParam(name = ConsumerConsts.OWNER_PARAM, required = false) String owner) {
try {
- this.eiTypes.getType(eiTypeId); // Just to check that the type exists
List<String> result = new ArrayList<>();
if (owner != null) {
for (EiJob job : this.eiJobs.getJobsForOwner(owner)) {
result.add(job.id());
}
}
+ } else if (eiTypeId != null) {
+ this.eiJobs.getJobsForType(eiTypeId).forEach(job -> result.add(job.id()));
} else {
- for (EiJob job : this.eiJobs.getJobsForType(eiTypeId)) {
- result.add(job.id());
- }
+ this.eiJobs.getJobs().forEach(job -> result.add(job.id()));
}
return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
- } catch (Exception e) {
+ } catch (
+
+ Exception e) {
return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
}
}
- @GetMapping(
- path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}",
- produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI Job", notes = "")
+ @GetMapping(path = "/eijobs/{eiJobId}", produces = MediaType.APPLICATION_JSON_VALUE)
+ @ApiOperation(value = "Individual EI job", notes = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "EI Job", response = ConsumerEiJobInfo.class), //
+ @ApiResponse(code = 200, message = "EI job", response = ConsumerEiJobInfo.class), //
@ApiResponse(
code = 404,
- message = "Enrichment Information type or job is not found",
+ message = "Enrichment Information job is not found",
response = ErrorResponse.ErrorInfo.class)})
public ResponseEntity<Object> getIndividualEiJob( //
- @PathVariable("eiTypeId") String eiTypeId, //
@PathVariable("eiJobId") String eiJobId) {
try {
- this.eiTypes.getType(eiTypeId); // Just to check that the type exists
EiJob job = this.eiJobs.getJob(eiJobId);
return new ResponseEntity<>(gson.toJson(toEiJobInfo(job)), HttpStatus.OK);
} catch (Exception e) {
}
}
- @GetMapping(
- path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}/status",
- produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "EI Job status", notes = "")
+ @GetMapping(path = "/eijobs/{eiJobId}/status", produces = MediaType.APPLICATION_JSON_VALUE)
+ @ApiOperation(value = "EI job status", notes = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "EI Job status", response = ConsumerEiJobStatus.class), //
+ @ApiResponse(code = 200, message = "EI job status", response = ConsumerEiJobStatus.class), //
@ApiResponse(
code = 404,
- message = "Enrichment Information type or job is not found",
+ message = "Enrichment Information job is not found",
response = ErrorResponse.ErrorInfo.class)})
public ResponseEntity<Object> getEiJobStatus( //
- @PathVariable("eiTypeId") String eiTypeId, //
@PathVariable("eiJobId") String eiJobId) {
try {
- this.eiTypes.getType(eiTypeId); // Just to check that the type exists
EiJob job = this.eiJobs.getJob(eiJobId);
return new ResponseEntity<>(gson.toJson(toEiJobStatus(job)), HttpStatus.OK);
} catch (Exception e) {
private ConsumerEiJobStatus toEiJobStatus(EiJob job) {
// TODO
- return new ConsumerEiJobStatus(ConsumerEiJobStatus.OperationalState.ENABLED);
+ return new ConsumerEiJobStatus(ConsumerEiJobStatus.EiJobStatusValues.ENABLED);
}
- @DeleteMapping(
- path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}",
- produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI Job", notes = "")
+ @DeleteMapping(path = "/eijobs/{eiJobId}", produces = MediaType.APPLICATION_JSON_VALUE)
+ @ApiOperation(value = "Individual EI job", notes = "")
@ApiResponses(
value = { //
@ApiResponse(code = 200, message = "Not used", response = VoidResponse.class),
@ApiResponse(code = 204, message = "Job deleted", response = VoidResponse.class),
@ApiResponse(
code = 404,
- message = "Enrichment Information type or job is not found",
+ message = "Enrichment Information job is not found",
response = ErrorResponse.ErrorInfo.class)})
public ResponseEntity<Object> deleteIndividualEiJob( //
- @PathVariable("eiTypeId") String eiTypeId, //
@PathVariable("eiJobId") String eiJobId) {
try {
EiJob job = this.eiJobs.getJob(eiJobId);
}
@PutMapping(
- path = ConsumerConsts.API_ROOT + "/eitypes/{eiTypeId}/eijobs/{eiJobId}", //
+ path = "/eijobs/{eiJobId}", //
produces = MediaType.APPLICATION_JSON_VALUE, //
consumes = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI Job", notes = "")
+ @ApiOperation(value = "Individual EI job", notes = "")
@ApiResponses(
value = { //
@ApiResponse(code = 201, message = "Job created", response = VoidResponse.class), //
message = "Enrichment Information type is not found",
response = ErrorResponse.ErrorInfo.class)})
public Mono<ResponseEntity<Object>> putIndividualEiJob( //
- @PathVariable("eiTypeId") String eiTypeId, //
@PathVariable("eiJobId") String eiJobId, //
- @RequestBody ConsumerEiJobInfo eiJobInfo) {
+ @RequestBody ConsumerEiJobInfo eiJobObject) {
final boolean isNewJob = this.eiJobs.get(eiJobId) == null;
- return validatePutEiJob(eiTypeId, eiJobId, eiJobInfo) //
+ return validatePutEiJob(eiJobId, eiJobObject) //
.flatMap(this::notifyProducersNewJob) //
.doOnNext(newEiJob -> this.eiJobs.put(newEiJob)) //
.flatMap(newEiJob -> Mono.just(new ResponseEntity<>(isNewJob ? HttpStatus.CREATED : HttpStatus.OK)))
});
}
- private Mono<EiJob> validatePutEiJob(String eiTypeId, String eiJobId, ConsumerEiJobInfo eiJobInfo) {
+ private Mono<EiJob> validatePutEiJob(String eiJobId, ConsumerEiJobInfo eiJobInfo) {
try {
- EiType eiType = this.eiTypes.getType(eiTypeId);
+ EiType eiType = this.eiTypes.getType(eiJobInfo.eiTypeId);
validateJsonObjectAgainstSchema(eiType.getJobDataSchema(), eiJobInfo.jobData);
EiJob existingEiJob = this.eiJobs.get(eiJobId);
- if (existingEiJob != null && !existingEiJob.type().getId().equals(eiTypeId)) {
+ if (existingEiJob != null && !existingEiJob.type().getId().equals(eiJobInfo.eiTypeId)) {
throw new ServiceException("Not allowed to change type for existing EI job", HttpStatus.CONFLICT);
}
return Mono.just(toEiJob(eiJobInfo, eiJobId, eiType));
.build();
}
- private ConsumerEiTypeInfo toEiTypeInfo(EiType t) {
- return new ConsumerEiTypeInfo(t.getJobDataSchema());
+ private ConsumerEiTypeInfo toEiTypeInfo() {
+ return new ConsumerEiTypeInfo();
}
private ConsumerEiJobInfo toEiJobInfo(EiJob s) {
- return new ConsumerEiJobInfo(s.jobData(), s.owner(), s.targetUri());
+ return new ConsumerEiJobInfo(s.type().getId(), s.jobData(), s.owner(), s.targetUri());
}
}
import org.immutables.gson.Gson;
@Gson.TypeAdapters
-@ApiModel(value = "EiJob", description = "Information for an Enrichment Information Job")
+@ApiModel(value = "EiJobObject", description = "Information for an Enrichment Information Job")
public class ConsumerEiJobInfo {
+ @ApiModelProperty(value = "EI type Idenitifier of the EI job", required = true)
+ @SerializedName("eiTypeId")
+ @JsonProperty(value = "eiTypeId", required = true)
+ public String eiTypeId;
+
@ApiModelProperty(value = "Identity of the owner of the job", required = true)
@SerializedName("jobOwner")
@JsonProperty(value = "jobOwner", required = true)
public String owner;
- @ApiModelProperty(value = "EI Type specific job data", required = true)
- @SerializedName("jobParameters")
- @JsonProperty(value = "jobParameters", required = true)
+ @ApiModelProperty(value = "EI type specific job data", required = true)
+ @SerializedName("jobDefinition")
+ @JsonProperty(value = "jobDefinition", required = true)
public Object jobData;
- @ApiModelProperty(value = "The target of the EI data", required = true)
- @SerializedName("targetUri")
- @JsonProperty(value = "targetUri", required = true)
+ @ApiModelProperty(value = "The target URI of the EI data", required = true)
+ @SerializedName("jobResultUri")
+ @JsonProperty(value = "jobResultUri", required = true)
public String targetUri;
+ @ApiModelProperty(value = "The target of EI job status notifications", required = false)
+ @SerializedName("jobStatusNotificationUri")
+ @JsonProperty(value = "jobStatusNotificationUri", required = false)
+ public String statusNotificationUri;
+
public ConsumerEiJobInfo() {
}
- public ConsumerEiJobInfo(Object jobData, String owner, String targetUri) {
+ public ConsumerEiJobInfo(String eiTypeId, Object jobData, String owner, String targetUri) {
+ this.eiTypeId = eiTypeId;
this.jobData = jobData;
this.owner = owner;
this.targetUri = targetUri;
import org.immutables.gson.Gson;
@Gson.TypeAdapters
-@ApiModel(value = "EiJobStatus", description = "Status for an EI Job")
+@ApiModel(value = "EiJobStatusObject", description = "Status for an EI job")
public class ConsumerEiJobStatus {
@Gson.TypeAdapters
- @ApiModel(value = "OperationalState", description = "Represents the operational states for a EI Job")
- public enum OperationalState {
+ @ApiModel(value = "EiJobStatusValues", description = "Allowed values for EI job status")
+ public enum EiJobStatusValues {
ENABLED, DISABLED
}
- private static final String OPERATIONAL_STATE_DESCRIPTION = "Operational state, values:\n" //
- + "ENABLED: TBD\n" //
- + "DISABLED: TBD.";
+ private static final String OPERATIONAL_STATE_DESCRIPTION = "values:\n" //
+ + "ENABLED: the A1-EI producer is able to deliver EI result for the EI job\n" //
+ + "DISABLED: the A1-EI producer is unable to deliver EI result for the EI job";
- @ApiModelProperty(value = OPERATIONAL_STATE_DESCRIPTION, name = "operational_state", required = true)
- @SerializedName("operationalState")
- @JsonProperty(value = "operationalState", required = true)
- public final OperationalState state;
+ @ApiModelProperty(value = OPERATIONAL_STATE_DESCRIPTION, name = "eiJobStatus", required = true)
+ @SerializedName("eiJobStatus")
+ @JsonProperty(value = "eiJobStatus", required = true)
+ public final EiJobStatusValues state;
- public ConsumerEiJobStatus(OperationalState state) {
+ public ConsumerEiJobStatus(EiJobStatusValues state) {
this.state = state;
}
package org.oransc.enrichment.controllers.consumer;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import com.google.gson.annotations.SerializedName;
-
import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
import org.immutables.gson.Gson;
@Gson.TypeAdapters
-@ApiModel(value = "EiType", description = "Information for an EI type")
+@ApiModel(value = "EiTypeObject", description = "Information for an EI type")
public class ConsumerEiTypeInfo {
- @ApiModelProperty(value = "Json schema for the job data")
- @SerializedName("eiJobParametersSchema")
- @JsonProperty("eiJobParametersSchema")
- public final Object jobParametersSchema;
-
- ConsumerEiTypeInfo(Object jobParametersSchema) {
- this.jobParametersSchema = jobParametersSchema;
- }
}
private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- private static Gson gson = new GsonBuilder() //
- .serializeNulls() //
- .create(); //
+ private static Gson gson = new GsonBuilder().create();
@Autowired
private EiJobs eiJobs;
}
@GetMapping(path = ProducerConsts.API_ROOT + "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI Type", notes = "")
+ @ApiOperation(value = "Individual EI type", notes = "")
@ApiResponses(
value = { //
@ApiResponse(code = 200, message = "EI type", response = ProducerEiTypeInfo.class), //
@ApiOperation(value = "Individual EI producer", notes = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "EI Jobs", response = ProducerRegistrationInfo.class), //
+ @ApiResponse(code = 200, message = "EI jobs", response = ProducerRegistrationInfo.class), //
@ApiResponse(
code = 404,
message = "Enrichment Information producer is not found",
import org.immutables.value.Value;
/**
- * Represents the dynamic information about a EI Job
+ * Represents the dynamic information about a EI job
*/
@Value.Immutable
@Gson.TypeAdapters
import org.oransc.enrichment.exceptions.ServiceException;
/**
- * Dynamic representation of all EI Jobs in the system.
+ * Dynamic representation of all existing EI jobs.
*/
public class EiJobs {
private Map<String, EiJob> allEiJobs = new HashMap<>();
import org.slf4j.LoggerFactory;
/**
- * Dynamic representation of all EI Types in the system.
+ * Dynamic representation of all EI types in the system.
*/
@SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
public class EiTypes {
@Autowired
ProducerSupervision producerSupervision;
- private static Gson gson = new GsonBuilder() //
- .serializeNulls() //
- .create(); //
+ private static Gson gson = new GsonBuilder().create();
/**
* Overrides the BeanFactory.
String url = ConsumerConsts.API_ROOT + "/eitypes/test";
String rsp = restClient().get(url).block();
ConsumerEiTypeInfo info = gson.fromJson(rsp, ConsumerEiTypeInfo.class);
- assertThat(info.jobParametersSchema).isNotNull();
+ assertThat(info).isNotNull();
}
@Test
void testGetEiJobsIds() throws Exception {
putEiProducerWithOneType(EI_PRODUCER_ID, EI_TYPE_ID);
putEiJob(EI_TYPE_ID, "jobId");
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs";
+ final String JOB_ID_JSON = "[\"jobId\"]";
+ String url = ConsumerConsts.API_ROOT + "/eijobs?eiTypeId=typeId";
String rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo("[\"jobId\"]");
+ assertThat(rsp).isEqualTo(JOB_ID_JSON);
- url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs?owner=owner";
+ url = ConsumerConsts.API_ROOT + "/eijobs?owner=owner";
rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo("[\"jobId\"]");
+ assertThat(rsp).isEqualTo(JOB_ID_JSON);
- url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs?owner=JUNK";
+ url = ConsumerConsts.API_ROOT + "/eijobs?owner=JUNK";
rsp = restClient().get(url).block();
assertThat(rsp).isEqualTo("[]");
- }
- @Test
- void testGetEiJobTypeNotFound() throws Exception {
- String url = ConsumerConsts.API_ROOT + "/eitypes/junk/eijobs";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND, "Could not find EI type: junk");
+ url = ConsumerConsts.API_ROOT + "/eijobs";
+ rsp = restClient().get(url).block();
+ assertThat(rsp).isEqualTo(JOB_ID_JSON);
+
+ url = ConsumerConsts.API_ROOT + "/eijobs?eiTypeId=typeId&&owner=owner";
+ rsp = restClient().get(url).block();
+ assertThat(rsp).isEqualTo(JOB_ID_JSON);
+
+ url = ConsumerConsts.API_ROOT + "/eijobs?eiTypeId=JUNK";
+ rsp = restClient().get(url).block();
+ assertThat(rsp).isEqualTo("[]");
}
@Test
void testGetEiJob() throws Exception {
putEiProducerWithOneType(EI_PRODUCER_ID, EI_TYPE_ID);
putEiJob(EI_TYPE_ID, "jobId");
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/jobId";
+ String url = ConsumerConsts.API_ROOT + "/eijobs/jobId";
String rsp = restClient().get(url).block();
ConsumerEiJobInfo info = gson.fromJson(rsp, ConsumerEiJobInfo.class);
assertThat(info.owner).isEqualTo("owner");
+ assertThat(info.eiTypeId).isEqualTo(EI_TYPE_ID);
}
@Test
void testGetEiJobNotFound() throws Exception {
putEiProducerWithOneType(EI_PRODUCER_ID, EI_TYPE_ID);
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/junk";
+ String url = ConsumerConsts.API_ROOT + "/eijobs/junk";
testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND, "Could not find EI job: junk");
}
void testGetEiJobStatus() throws Exception {
putEiProducerWithOneType(EI_PRODUCER_ID, EI_TYPE_ID);
putEiJob(EI_TYPE_ID, "jobId");
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/jobId/status";
+ String url = ConsumerConsts.API_ROOT + "/eijobs/jobId/status";
String rsp = restClient().get(url).block();
assertThat(rsp).contains("ENABLED");
}
putEiProducerWithOneType(EI_PRODUCER_ID, EI_TYPE_ID);
putEiJob(EI_TYPE_ID, "jobId");
assertThat(this.eiJobs.size()).isEqualTo(1);
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/jobId";
+ String url = ConsumerConsts.API_ROOT + "/eijobs/jobId";
restClient().delete(url).block();
assertThat(this.eiJobs.size()).isZero();
@Test
void testDeleteEiJobNotFound() throws Exception {
putEiProducerWithOneType(EI_PRODUCER_ID, EI_TYPE_ID);
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/junk";
+ String url = ConsumerConsts.API_ROOT + "/eijobs/junk";
testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND, "Could not find EI job: junk");
}
putEiProducerWithOneType(EI_PRODUCER_ID, EI_TYPE_ID);
putEiProducerWithOneTypeRejecting("simulateProducerError", EI_TYPE_ID);
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/jobId";
+ String url = ConsumerConsts.API_ROOT + "/eijobs/jobId";
String body = gson.toJson(eiJobInfo());
ResponseEntity<String> resp = restClient().putForEntity(url, body).block();
assertThat(this.eiJobs.size()).isEqualTo(1);
@Test
void putEiProducerWithOneType_rejecting() throws JsonMappingException, JsonProcessingException, ServiceException {
putEiProducerWithOneTypeRejecting("simulateProducerError", EI_TYPE_ID);
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/jobId";
+ String url = ConsumerConsts.API_ROOT + "/eijobs/jobId";
String body = gson.toJson(eiJobInfo());
testErrorCode(restClient().put(url, body), HttpStatus.CONFLICT, "Job not accepted by any producers");
void testPutEiJob_jsonSchemavalidationError() throws Exception {
putEiProducerWithOneType(EI_PRODUCER_ID, EI_TYPE_ID);
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/jobId";
+ String url = ConsumerConsts.API_ROOT + "/eijobs/jobId";
// The element with name "property1" is mandatory in the schema
ConsumerEiJobInfo jobInfo =
- new ConsumerEiJobInfo(jsonObject("{ \"XXstring\" : \"value\" }"), "owner", "targetUri");
+ new ConsumerEiJobInfo("typeId", jsonObject("{ \"XXstring\" : \"value\" }"), "owner", "targetUri");
String body = gson.toJson(jobInfo);
testErrorCode(restClient().put(url, body), HttpStatus.CONFLICT, "Json validation failure");
putEiProducerWithOneType("producer2", "typeId2");
putEiJob("typeId1", "jobId");
- String url = ConsumerConsts.API_ROOT + "/eitypes/typeId2/eijobs/jobId";
- String body = gson.toJson(eiJobInfo());
+ String url = ConsumerConsts.API_ROOT + "/eijobs/jobId";
+ String body = gson.toJson(eiJobInfo("typeId2"));
testErrorCode(restClient().put(url, body), HttpStatus.CONFLICT,
"Not allowed to change type for existing EI job");
}
assertThat(this.eiTypes.size()).isEqualTo(1);
this.eiTypes.getType(EI_TYPE_ID);
- url = ConsumerConsts.API_ROOT + "/eitypes/typeId/eijobs/jobId";
+ url = ConsumerConsts.API_ROOT + "/eijobs/jobId";
body = gson.toJson(eiJobInfo());
restClient().putForEntity(url, body).block();
}
ConsumerEiJobInfo eiJobInfo() throws JsonMappingException, JsonProcessingException {
- return new ConsumerEiJobInfo(jsonObject(), "owner", "targetUri");
+ return eiJobInfo(EI_TYPE_ID);
+ }
+
+ ConsumerEiJobInfo eiJobInfo(String typeId) throws JsonMappingException, JsonProcessingException {
+ return new ConsumerEiJobInfo(typeId, jsonObject(), "owner", "targetUri");
}
Object jsonObject(String json) {
private EiJob putEiJob(String eiTypeId, String jobId)
throws JsonMappingException, JsonProcessingException, ServiceException {
- String url = ConsumerConsts.API_ROOT + "/eitypes/" + eiTypeId + "/eijobs/" + jobId;
- String body = gson.toJson(eiJobInfo());
+ String url = ConsumerConsts.API_ROOT + "/eijobs/" + jobId;
+ String body = gson.toJson(eiJobInfo(eiTypeId));
restClient().putForEntity(url, body).block();
return this.eiJobs.getJob(jobId);
import org.springframework.web.bind.annotation.RestController;
@RestController("ProducerSimulatorController")
-@Api(tags = {"Producer Simulator"})
+@Api(tags = {"Producer Callbacks"})
public class ProducerSimulatorController {
private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
}
@PostMapping(path = JOB_CREATED_ERROR_URL, produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Callback for EI job creation, returns error", notes = "")
+ @ApiOperation(value = "Callback for EI job creation, returns error", notes = "", hidden = true)
@ApiResponses(
value = { //
@ApiResponse(code = 200, message = "OK", response = VoidResponse.class)}//
}
@PostMapping(path = JOB_DELETED_ERROR_URL, produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Callback for EI job creation, returns error", notes = "")
+ @ApiOperation(value = "Callback for EI job creation, returns error", notes = "", hidden = true)
@ApiResponses(
value = { //
@ApiResponse(code = 200, message = "OK", response = VoidResponse.class)}//
}
@GetMapping(path = SUPERVISION_ERROR_URL, produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Producer supervision error", notes = "")
+ @ApiOperation(value = "Producer supervision error", notes = "", hidden = true)
@ApiResponses(
value = { //
@ApiResponse(code = 200, message = "OK", response = String.class)}//
Code Review / nonrtric.git / commitdiff