Add complex API definition.
[aai/esr-server.git] / esr-mgr / src / main / java / org / onap / aai / esr / externalservice / aai / ICloudRegion.java
1 /**
2  * Copyright 2017-2018 ZTE Corporation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.onap.aai.esr.externalservice.aai;
17
18 import javax.ws.rs.Consumes;
19 import javax.ws.rs.DELETE;
20 import javax.ws.rs.GET;
21 import javax.ws.rs.HeaderParam;
22 import javax.ws.rs.PUT;
23 import javax.ws.rs.Path;
24 import javax.ws.rs.PathParam;
25 import javax.ws.rs.Produces;
26 import javax.ws.rs.QueryParam;
27 import javax.ws.rs.core.MediaType;
28 import org.onap.aai.esr.entity.aai.CloudRegionDetail;
29 import org.onap.aai.esr.entity.aai.Relationship;
30 import org.onap.aai.esr.exception.ExtsysException;
31
32 @Path("/")
33 public interface ICloudRegion {
34
35     @PUT
36     @Path("/cloud-regions/cloud-region/{cloud_owner}/{cloud_region_id}")
37     @Consumes(MediaType.APPLICATION_JSON)
38     @Produces(MediaType.APPLICATION_JSON)
39     public void registerVIMService(@HeaderParam("X-TransactionId") String transactionId,
40             @HeaderParam("X-FromAppId") String fromApp, @HeaderParam("Authorization") String authorization,
41             @PathParam("cloud_owner") String cloud_owner, @PathParam("cloud_region_id") String cloud_region_id,
42             CloudRegionDetail cloudRegion) throws ExtsysException;
43
44     @GET
45     @Path("/cloud-regions/cloud-region/{cloud_owner}/{cloud_region_id}?depth=all")
46     @Consumes(MediaType.APPLICATION_JSON)
47     @Produces(MediaType.APPLICATION_JSON)
48     public String queryVIMDetail(@HeaderParam("X-TransactionId") String transactionId,
49             @HeaderParam("X-FromAppId") String fromApp, @HeaderParam("Authorization") String authorization,
50             @PathParam("cloud_owner") String cloud_owner, @PathParam("cloud_region_id") String cloud_region_id)
51             throws ExtsysException;
52
53     @GET
54     @Path("/cloud-regions")
55     @Consumes(MediaType.APPLICATION_JSON)
56     @Produces(MediaType.APPLICATION_JSON)
57     public String queryVIMList(@HeaderParam("X-TransactionId") String transactionId,
58             @HeaderParam("X-FromAppId") String fromApp, @HeaderParam("Authorization") String authorization)
59             throws ExtsysException;
60
61     @DELETE
62     @Path("/cloud-regions/cloud-region/{cloud_owner}/{cloud_region_id}")
63     @Consumes(MediaType.APPLICATION_JSON)
64     @Produces(MediaType.APPLICATION_JSON)
65     public void deleteVim(@HeaderParam("X-TransactionId") String transactionId,
66             @HeaderParam("X-FromAppId") String fromApp, @HeaderParam("Authorization") String authorization,
67             @PathParam("cloud_owner") String cloud_owner, @PathParam("cloud_region_id") String cloud_region_id,
68             @QueryParam("resource-version") String resourceVersion) throws ExtsysException;
69     
70     @PUT
71     @Path("/cloud-regions/cloud-region/{cloud_owner}/{cloud_region_id}/relationship-list/relationship")
72     @Consumes(MediaType.APPLICATION_JSON)
73     @Produces(MediaType.APPLICATION_JSON)
74     public void putRelationship(@HeaderParam("X-TransactionId") String transactionId,
75             @HeaderParam("X-FromAppId") String fromApp, @HeaderParam("Authorization") String authorization,
76             @PathParam("cloud_owner") String cloud_owner, @PathParam("cloud_region_id") String cloud_region_id,
77             Relationship relationship) throws ExtsysException;
78     
79     @GET
80     @Path("/complexes")
81     @Consumes(MediaType.APPLICATION_JSON)
82     @Produces(MediaType.APPLICATION_JSON)
83     public String queryComplexList(@HeaderParam("X-TransactionId") String transactionId,
84             @HeaderParam("X-FromAppId") String fromApp, @HeaderParam("Authorization") String authorization)
85             throws ExtsysException;
86 }