Commit 5 for Define Topology API mS 06/83406/1
authorJerry Flood <jflood@att.com>
Tue, 26 Mar 2019 19:02:00 +0000 (15:02 -0400)
committerJerry Flood <jflood@att.com>
Tue, 26 Mar 2019 19:15:34 +0000 (15:15 -0400)
Multiple commits required due to commit size limitation.

Change-Id: Ic46ba852f966366d938725345648e5dc86fc88af
Issue-ID: OPTFRA-430
Signed-off-by: Jerry Flood <jflood@att.com>
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/HealthCheckImpl.java [new file with mode: 0644]
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/TopologyInterface.java [new file with mode: 0644]
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/TopologyInterfaceImpl.java [new file with mode: 0644]
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ConstraintElements.java [new file with mode: 0644]
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementCriteria.java [new file with mode: 0644]
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementInfo.java [new file with mode: 0644]
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementLocation.java [new file with mode: 0644]
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/HealthCheckComponent.java [new file with mode: 0644]
cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/HealthCheckMessage.java [new file with mode: 0644]

diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/HealthCheckImpl.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/HealthCheckImpl.java
new file mode 100644 (file)
index 0000000..c1dfe81
--- /dev/null
@@ -0,0 +1,104 @@
+/*
+ * Copyright © 2017-2019 AT&T Intellectual Property. Modifications Copyright © 2018 IBM.
+ *
+ * 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.
+ *
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs;
+
+import com.att.eelf.configuration.EELFLogger;
+import com.att.eelf.configuration.EELFManager;
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriInfo;
+import org.onap.optf.cmso.topology.service.rs.models.HealthCheckComponent;
+import org.onap.optf.cmso.topology.service.rs.models.HealthCheckMessage;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.env.Environment;
+import org.springframework.stereotype.Controller;
+
+@Controller
+public class HealthCheckImpl implements HealthCheck {
+    private static EELFLogger debug = EELFManager.getInstance().getDebugLogger();
+
+
+    @Autowired
+    Environment env;
+
+
+    @Context
+    UriInfo uri;
+
+    @Context
+    HttpServletRequest request;
+
+    @Override
+    public Response healthCheck(String apiVersion, Boolean checkInterfaces) {
+        debug.debug("Entered healthcheck");
+        Response response = null;
+        HealthCheckMessage hc = new HealthCheckMessage();
+        hc.setHealthy(true);
+
+        addToHealthCheckMessage(hc, this.healthCheckDb());
+
+        if (hc.getHealthy()) {
+            response = Response.ok().entity(hc).build();
+        }
+        else {
+            response = Response.status(Response.Status.BAD_REQUEST).entity(hc).build();
+        }
+        return response;
+    }
+
+    private void addToHealthCheckMessage(HealthCheckMessage hc, HealthCheckComponent hcc) {
+        if (!hcc.getHealthy()) {
+            hc.setHealthy(false);
+        }
+
+        hc.setHostname(System.getenv("HOSTNAME"));
+        hc.addComponent(hcc);
+    }
+
+    /**
+     * Health check.
+     *
+     * @return the health check component
+     */
+    private HealthCheckComponent healthCheckDb() {
+        HealthCheckComponent hcc = new HealthCheckComponent();
+        hcc.setName("Ticket Management Database");
+        String url = env.getProperty("spring.datasource.url");
+        hcc.setUrl(url);
+        try {
+            // List<ApprovalType> approvalTypes = approvalTypeDAO.findByDomain("HealthCheck");
+            hcc.setHealthy(true);
+            hcc.setStatus("OK");
+        } catch (Exception e) {
+            hcc.setStatus(e.getMessage());
+
+        }
+        return hcc;
+    }
+
+}
diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/TopologyInterface.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/TopologyInterface.java
new file mode 100644 (file)
index 0000000..6bdd7fa
--- /dev/null
@@ -0,0 +1,121 @@
+/*
+ * Copyright © 2017-2019 AT&T Intellectual Property. Modifications Copyright © 2018 IBM.
+ *
+ * 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.
+ *
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
+import javax.ws.rs.DELETE;
+import javax.ws.rs.DefaultValue;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import org.onap.optf.cmso.common.CmsoRequestError;
+import org.onap.optf.cmso.topology.service.rs.models.TopologyRequest;
+import org.onap.optf.cmso.topology.service.rs.models.TopologyResponse;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+
+@Api("Topology Interface")
+@Path("/{apiVersion}")
+@Produces({MediaType.APPLICATION_JSON})
+public interface TopologyInterface {
+    // ******************************************************************
+
+    @POST
+    @Path("/current/")
+    @Produces({MediaType.APPLICATION_JSON})
+    @RequestMapping(value = "/{apiVersion}/current", method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON,
+                    produces = MediaType.APPLICATION_JSON)
+    @ApiOperation(value = "Request Topology",
+                    notes = "API to retrieve toplogy for scheduling 'conflict free' mainentance."
+                                    + " Retrieves the element information related to the list of elements"
+                                    + " targeted for mainenance activity."
+                                    + " Scope of related elements to be returned are defined in the passed"
+                                    + " ToplogogyRequest."
+                                    + " Elements returned must include in the elementData, the identifier that"
+                                    + " the element is known as"
+                                    + " in the ticket management system."
+                                    + "\nThe Topology Service may implement asynchronous requests by"
+                                    + " returning IN_PROGRESS status."
+                                    + " If IN_PROGRESS, the optimizer will begin polling until"
+                                    + " COMPLETED is returned with the response. ",
+                    response = TopologyResponse.class)
+    @ApiResponses(value = {@ApiResponse(code = 200, message = "OK"),
+                    @ApiResponse(code = 400, message = "Bad request", response = CmsoRequestError.class),
+                    @ApiResponse(code = 500, message = "Unexpected Runtime error", response = Exception.class)})
+    public Response retrieveCurrentTopology(
+                    @ApiParam(value = "v1") @PathParam("apiVersion") @PathVariable(
+                                    value = "v1") @DefaultValue("v1") String apiVersion,
+                    @ApiParam(value = "Topology criteria.") TopologyRequest topologyRequest);
+
+    @GET
+    @Path("/current/request/{id}")
+    @Produces({MediaType.APPLICATION_JSON})
+    @RequestMapping(value = "/current/request/{id}", method = RequestMethod.GET, consumes = MediaType.APPLICATION_JSON,
+                    produces = MediaType.APPLICATION_JSON)
+    @ApiOperation(value = "Poll Asynchronous Topology Request",
+                    notes = "If a topology request results in asynchronous request (IN_PROGRESS)"
+                                    + " this GET is used to retrieve status until COMPLETED."
+                                    + " At which time, the optimizer will "
+                                    + " issue a DELETE to acknowledge receipt."
+                                    + "\nThe Topology Service implementation may delete the cache when"
+                                    + " returning completed."
+                                    + " The optimizer will treat subsequent not found on delete as normal.",
+                    response = TopologyResponse.class)
+    @ApiResponses(value = {@ApiResponse(code = 200, message = "OK"),
+                    @ApiResponse(code = 404, message = "Not Found", response = CmsoRequestError.class),
+                    @ApiResponse(code = 500, message = "Unexpected Runtime error", response = Exception.class)})
+    public Response getTopologyRequest(
+                    @ApiParam(value = "v1") @PathParam("apiVersion") @PathVariable(
+                                    value = "v1") @DefaultValue("v1") String apiVersion,
+                    @ApiParam(value = "Request Id") @PathParam("id") String id);
+
+    @DELETE
+    @Path("/current/request/{id}")
+    @Produces({MediaType.APPLICATION_JSON})
+    @RequestMapping(value = "/current/request/{id}", method = RequestMethod.DELETE,
+                    consumes = MediaType.APPLICATION_JSON, produces = MediaType.APPLICATION_JSON)
+    @ApiOperation(value = "Acknowledge Topology Response", notes = "API to acknowledge COMPLETED toplogy request.",
+                    response = TopologyResponse.class)
+    @ApiResponses(value = {@ApiResponse(code = 200, message = "OK"),
+                    @ApiResponse(code = 404, message = "Not Found", response = CmsoRequestError.class),
+                    @ApiResponse(code = 500, message = "Unexpected Runtime error", response = Exception.class)})
+    public Response deleteTopologyRequest(
+                    @ApiParam(value = "v1") @PathParam("apiVersion") @PathVariable(
+                                    value = "v1") @DefaultValue("v1") String apiVersion,
+                    @ApiParam(value = "Request Id") @PathParam("id") String id);
+
+
+}
diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/TopologyInterfaceImpl.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/TopologyInterfaceImpl.java
new file mode 100644 (file)
index 0000000..6ed401f
--- /dev/null
@@ -0,0 +1,130 @@
+/*
+ * Copyright © 2017-2019 AT&T Intellectual Property. Modifications Copyright © 2018 IBM.
+ * 
+ * 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.
+ * 
+ * 
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ * 
+ * https://creativecommons.org/licenses/by/4.0/
+ * 
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs;
+
+import com.att.eelf.configuration.EELFLogger;
+import com.att.eelf.configuration.EELFManager;
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriInfo;
+import org.onap.observations.Observation;
+import org.onap.optf.cmso.topology.common.LogMessages;
+import org.onap.optf.cmso.topology.service.rs.models.TopologyRequest;
+import org.onap.optf.cmso.topology.service.rs.models.TopologyResponse;
+import org.onap.optf.cmso.topology.service.rs.models.TopologyResponse.TopologyRequestStatus;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.env.Environment;
+import org.springframework.stereotype.Controller;
+import org.springframework.transaction.interceptor.TransactionAspectSupport;
+
+@Controller
+public class TopologyInterfaceImpl implements TopologyInterface {
+    private static EELFLogger debug = EELFManager.getInstance().getDebugLogger();
+
+    @Autowired
+    Environment env;
+
+    @Context
+    UriInfo uri;
+
+    @Context
+    HttpServletRequest request;
+
+
+    @Override
+    public Response retrieveCurrentTopology(String apiVersion, TopologyRequest topologyRequest) {
+        // TODO Auto-generated method stub
+        String id = topologyRequest.getRequestId();
+        Observation.report(LogMessages.GET_ACTIVE_TICKETS, "Received", request.getRemoteAddr(), id, "");
+        Response response = null;
+        try {
+            TopologyResponse atr = new TopologyResponse();
+            atr.setRequestId(topologyRequest.getRequestId());
+            atr.setStatus(TopologyRequestStatus.COMPLETED);
+            response = Response.ok(atr).build();
+            // } catch (CMSException e) {
+            // TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
+            // Observation.report(LogMessages.EXPECTED_EXCEPTION, e, e.getMessage());
+            // response = Response.status(e.getStatus()).entity(e.getRequestError()).build();
+        } catch (Exception e) {
+            Observation.report(LogMessages.UNEXPECTED_EXCEPTION, e, e.getMessage());
+            TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
+            response = Response.serverError().build();
+        }
+        Observation.report(LogMessages.GET_ACTIVE_TICKETS, "Returned", request.getRemoteAddr(), id,
+                        response.getStatusInfo().toString());
+        return response;
+    }
+
+
+    @Override
+    public Response getTopologyRequest(String apiVersion, String id) {
+        // TODO Auto-generated method stub
+        Observation.report(LogMessages.GET_ACTIVE_TICKETS, "Received", request.getRemoteAddr(), id, "");
+        Response response = null;
+        try {
+            TopologyResponse atr = new TopologyResponse();
+            atr.setRequestId(id);
+            atr.setStatus(TopologyRequestStatus.COMPLETED);
+            response = Response.ok(atr).build();
+            // } catch (CMSException e) {
+            // TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
+            // Observation.report(LogMessages.EXPECTED_EXCEPTION, e, e.getMessage());
+            // response = Response.status(e.getStatus()).entity(e.getRequestError()).build();
+        } catch (Exception e) {
+            Observation.report(LogMessages.UNEXPECTED_EXCEPTION, e, e.getMessage());
+            TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
+            response = Response.serverError().build();
+        }
+        Observation.report(LogMessages.GET_ACTIVE_TICKETS, "Returned", request.getRemoteAddr(), id,
+                        response.getStatusInfo().toString());
+        return response;
+    }
+
+
+    @Override
+    public Response deleteTopologyRequest(String apiVersion, String id) {
+        // TODO Auto-generated method stub
+        Observation.report(LogMessages.GET_ACTIVE_TICKETS, "Received", request.getRemoteAddr(), id, "");
+        Response response = null;
+        try {
+            response = Response.noContent().build();
+            // } catch (CMSException e) {
+            // TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
+            // Observation.report(LogMessages.EXPECTED_EXCEPTION, e, e.getMessage());
+            // response = Response.status(e.getStatus()).entity(e.getRequestError()).build();
+        } catch (Exception e) {
+            Observation.report(LogMessages.UNEXPECTED_EXCEPTION, e, e.getMessage());
+            TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
+            response = Response.serverError().build();
+        }
+        Observation.report(LogMessages.GET_ACTIVE_TICKETS, "Returned", request.getRemoteAddr(), id,
+                        response.getStatusInfo().toString());
+        return response;
+    }
+}
diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ConstraintElements.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ConstraintElements.java
new file mode 100644 (file)
index 0000000..b3ff906
--- /dev/null
@@ -0,0 +1,127 @@
+/*******************************************************************************
+ *
+ * Copyright © 2019 AT&T Intellectual Property.
+ *
+ * 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.
+ *
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs.models;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.Serializable;
+import java.util.List;
+
+@ApiModel(value = "Topology Constraint ELements",
+                description = "Constraining Element Information returned from TopologyRequuest.")
+public class ConstraintElements implements Serializable {
+    private static final long serialVersionUID = 1L;
+
+    public enum AvailabilityMatrixScope {
+        NONE, GLOBAL, ELEMENT,
+    }
+
+    @ApiModelProperty(value = "Element identifier")
+    private String elementId;
+
+    @ApiModelProperty(value = "Type of constraint.")
+    private String constraintType;
+
+    @ApiModelProperty(
+                    value = "If more than one instance of constraintType,"
+                                    + " minimum number of available instances required."
+                                    + " Useful for identifying availableBackup elements, service paths.")
+    private Integer constraintTypeMinimum = 1;
+
+    @ApiModelProperty(value = "Availability matrix name. Availability matrix will not be passed to optimizer engine."
+                    + " Generally useful for global concurrency type constraints.")
+    private String optimizerAvailabilityMatrixName;
+
+    @ApiModelProperty(value = "Availability matrix scope global  or scoped per elementId.")
+    private AvailabilityMatrixScope availabilityMatrixScope = AvailabilityMatrixScope.NONE;
+
+    @ApiModelProperty(value = "Availability matrix is aggregated into element availability marrix.")
+    private boolean elementAvailabilityAggreagation = true;
+
+    @ApiModelProperty(value = "Elements ")
+    private List<String> elements;
+
+    public String getElementId() {
+        return elementId;
+    }
+
+    public void setElementId(String elementId) {
+        this.elementId = elementId;
+    }
+
+    public String getConstraintType() {
+        return constraintType;
+    }
+
+    public void setConstraintType(String constraintType) {
+        this.constraintType = constraintType;
+    }
+
+    public Integer getConstraintTypeMinimum() {
+        return constraintTypeMinimum;
+    }
+
+    public void setConstraintTypeMinimum(Integer constraintTypeMinimum) {
+        this.constraintTypeMinimum = constraintTypeMinimum;
+    }
+
+    public String getOptimizerAvailabilityMatrixName() {
+        return optimizerAvailabilityMatrixName;
+    }
+
+    public void setOptimizerAvailabilityMatrixName(String optimizerAvailabilityMatrixName) {
+        this.optimizerAvailabilityMatrixName = optimizerAvailabilityMatrixName;
+    }
+
+    public List<String> getElements() {
+        return elements;
+    }
+
+    public void setElements(List<String> elements) {
+        this.elements = elements;
+    }
+
+    public AvailabilityMatrixScope getAvailabilityMatrixScope() {
+        return availabilityMatrixScope;
+    }
+
+    public void setAvailabilityMatrixScope(AvailabilityMatrixScope availabilityMatrixScope) {
+        this.availabilityMatrixScope = availabilityMatrixScope;
+    }
+
+    public boolean isElementAvailabilityAggreagation() {
+        return elementAvailabilityAggreagation;
+    }
+
+    public void setElementAvailabilityAggreagation(boolean elementAvailabilityAggreagation) {
+        this.elementAvailabilityAggreagation = elementAvailabilityAggreagation;
+    }
+
+
+
+}
diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementCriteria.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementCriteria.java
new file mode 100644 (file)
index 0000000..6f5e49b
--- /dev/null
@@ -0,0 +1,62 @@
+/*******************************************************************************
+ *
+ * Copyright © 2019 AT&T Intellectual Property.
+ *
+ * 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.
+ *
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs.models;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+
+@ApiModel(value = "Element Critera", description = "Element criteria for retrieving topology.")
+public class ElementCriteria implements Serializable {
+    private static final long serialVersionUID = 1L;
+
+    @ApiModelProperty(value = "Element id unique to the request.")
+    private String elementId;
+
+    @ApiModelProperty(value = "Implementation specific element data.")
+    public List<NameValue> elementData = new ArrayList<>();
+
+    public String getElementId() {
+        return elementId;
+    }
+
+    public void setElementId(String elementId) {
+        this.elementId = elementId;
+    }
+
+    public List<NameValue> getElementData() {
+        return elementData;
+    }
+
+    public void setElementData(List<NameValue> elementData) {
+        this.elementData = elementData;
+    }
+
+}
diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementInfo.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementInfo.java
new file mode 100644 (file)
index 0000000..0a76c18
--- /dev/null
@@ -0,0 +1,112 @@
+/*******************************************************************************
+ *
+ * Copyright © 2019 AT&T Intellectual Property.
+ *
+ * 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.
+ *
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs.models;
+
+import com.att.eelf.configuration.EELFLogger;
+import com.att.eelf.configuration.EELFManager;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+
+@ApiModel(value = "Topology Element", description = "Element Information returned from TopologyRequuest.")
+public class ElementInfo implements Serializable {
+    private static final long serialVersionUID = 1L;
+    private static EELFLogger log = EELFManager.getInstance().getLogger(ElementInfo.class);
+
+    @ApiModelProperty(value = "Element identifier")
+    private String elementId;
+
+    @ApiModelProperty(value = "Location information for the element.")
+    private ElementLocation elementLocation;
+
+    @ApiModelProperty(value = "List of related elements required to be available to execute the chenge.")
+    private List<String> requiredElements;
+
+    @ApiModelProperty(value = "Lists of related elements that must be "
+                    + " available to avoid network outage while executing the change."
+                    + " Each set constraint elements")
+    private List<ConstraintElements> constraintElements = new ArrayList<>();
+
+    @ApiModelProperty(value = "Implementation specific element data.")
+    public List<NameValue> elementData = new ArrayList<>();
+
+    public String getElementId() {
+        return elementId;
+    }
+
+    public void setElementId(String elementId) {
+        this.elementId = elementId;
+    }
+
+    public ElementLocation getElementLocation() {
+        return elementLocation;
+    }
+
+    public void setElementLocation(ElementLocation elementLocation) {
+        this.elementLocation = elementLocation;
+    }
+
+    public List<String> getRequiredElements() {
+        return requiredElements;
+    }
+
+    public void setRequiredElements(List<String> requiredElements) {
+        this.requiredElements = requiredElements;
+    }
+
+    public List<NameValue> getElementData() {
+        return elementData;
+    }
+
+    public void setElementData(List<NameValue> elementData) {
+        this.elementData = elementData;
+    }
+
+    public List<ConstraintElements> getConstraintElements() {
+        return constraintElements;
+    }
+
+    public void setConstraintElements(List<ConstraintElements> constraintElements) {
+        this.constraintElements = constraintElements;
+    }
+
+    @Override
+    public String toString() {
+        ObjectMapper mapper = new ObjectMapper();
+        try {
+            return mapper.writeValueAsString(this);
+        } catch (JsonProcessingException e) {
+            log.debug("Error in toString()", e);
+        }
+        return "";
+    }
+}
diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementLocation.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ElementLocation.java
new file mode 100644 (file)
index 0000000..15f77f8
--- /dev/null
@@ -0,0 +1,92 @@
+/*
+ * Copyright © 2017-2018 AT&T Intellectual Property. Modifications Copyright © 2018 IBM.
+ *
+ * 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.
+ *
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs.models;
+
+import com.att.eelf.configuration.EELFLogger;
+import com.att.eelf.configuration.EELFManager;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.Serializable;
+
+@ApiModel(value = "Element Location", description = "Location information necessary to determine timezone."
+                + " lat/lon and/or timezone must be provided")
+public class ElementLocation implements Serializable {
+    private static final long serialVersionUID = 1L;
+    private static EELFLogger log = EELFManager.getInstance().getLogger(ElementLocation.class);
+
+    @ApiModelProperty(value = "Geographic latitude of element.")
+    private Float lat;
+
+    @ApiModelProperty(value = "Geographic longitude of element.")
+    private Float lon;
+
+    @ApiModelProperty(value = "Timezone.")
+    private String timezone;
+
+    public Float getLat() {
+        return lat;
+    }
+
+    public void setLat(Float lat) {
+        this.lat = lat;
+    }
+
+    public Float getLon() {
+        return lon;
+    }
+
+    public void setLon(Float lon) {
+        this.lon = lon;
+    }
+
+    public String getTimezone() {
+        return timezone;
+    }
+
+    public void setTimezone(String timezone) {
+        this.timezone = timezone;
+    }
+
+    /**
+     * To string.
+     *
+     * @return the string
+     */
+    @Override
+    public String toString() {
+        ObjectMapper mapper = new ObjectMapper();
+        try {
+            return mapper.writeValueAsString(this);
+        } catch (JsonProcessingException e) {
+            log.debug("Error in toString()", e);
+        }
+        return "";
+    }
+
+}
diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/HealthCheckComponent.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/HealthCheckComponent.java
new file mode 100644 (file)
index 0000000..378dcb0
--- /dev/null
@@ -0,0 +1,93 @@
+/*
+ * Copyright © 2017-2018 AT&T Intellectual Property. Modifications Copyright © 2018 IBM.
+ *
+ * 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.
+ *
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs.models;
+
+import com.att.eelf.configuration.EELFLogger;
+import com.att.eelf.configuration.EELFManager;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.swagger.annotations.ApiModel;
+import java.io.Serializable;
+
+@ApiModel
+public class HealthCheckComponent implements Serializable {
+    private static final long serialVersionUID = 1L;
+    private static EELFLogger log = EELFManager.getInstance().getLogger(HealthCheckComponent.class);
+
+    private String name;
+    private String url;
+    private String status;
+    private Boolean healthy = false;
+
+    public Boolean getHealthy() {
+        return healthy;
+    }
+
+    public void setHealthy(Boolean healthy) {
+        this.healthy = healthy;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getUrl() {
+        return url;
+    }
+
+    public void setUrl(String url) {
+        this.url = url;
+    }
+
+    public String getStatus() {
+        return status;
+    }
+
+    public void setStatus(String status) {
+        this.status = status;
+    }
+
+    /**
+     * To string.
+     *
+     * @return the string
+     */
+    @Override
+    public String toString() {
+        ObjectMapper mapper = new ObjectMapper();
+        try {
+            return mapper.writeValueAsString(this);
+        } catch (JsonProcessingException e) {
+            log.debug("Error in toString()", e);
+        }
+        return "";
+    }
+}
diff --git a/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/HealthCheckMessage.java b/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/HealthCheckMessage.java
new file mode 100644 (file)
index 0000000..de96ac5
--- /dev/null
@@ -0,0 +1,109 @@
+/*
+ * Copyright © 2017-2018 AT&T Intellectual Property. Modifications Copyright © 2018 IBM.
+ *
+ * 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.
+ *
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed under the Creative
+ * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation 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.optf.cmso.topology.service.rs.models;
+
+import com.att.eelf.configuration.EELFLogger;
+import com.att.eelf.configuration.EELFManager;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.swagger.annotations.ApiModel;
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+
+@ApiModel
+public class HealthCheckMessage implements Serializable {
+    private static final long serialVersionUID = 1L;
+    private static EELFLogger log = EELFManager.getInstance().getLogger(HealthCheckMessage.class);
+
+    private Boolean healthy = false;
+    private String buildInfo = "";
+    private String currentTime = "";
+    private String hostname = "";
+
+    private List<HealthCheckComponent> components = new ArrayList<HealthCheckComponent>();
+
+    public Boolean getHealthy() {
+        return healthy;
+    }
+
+    public void setHealthy(Boolean healthy) {
+        this.healthy = healthy;
+    }
+
+    public String getBuildInfo() {
+        return buildInfo;
+    }
+
+    public void setBuildInfo(String buildInfo) {
+        this.buildInfo = buildInfo;
+    }
+
+    public String getCurrentTime() {
+        return currentTime;
+    }
+
+    public void setCurrentTime(String currentTime) {
+        this.currentTime = currentTime;
+    }
+
+    public String getHostname() {
+        return hostname;
+    }
+
+    public void setHostname(String hostname) {
+        this.hostname = hostname;
+    }
+
+    public List<HealthCheckComponent> getComponents() {
+        return components;
+    }
+
+    public void setComponents(List<HealthCheckComponent> components) {
+        this.components = components;
+    }
+
+    public void addComponent(HealthCheckComponent components) {
+        this.components.add(components);
+    }
+
+    /**
+     * To string.
+     *
+     * @return the string
+     */
+    @Override
+    public String toString() {
+        ObjectMapper mapper = new ObjectMapper();
+        try {
+            return mapper.writeValueAsString(this);
+        } catch (JsonProcessingException e) {
+            log.debug("Error in toString()", e);
+        }
+        return "";
+    }
+}