1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*********************************************************************
* Copyright (c) 2013 Boeing
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Boeing - initial API and implementation
**********************************************************************/
package org.eclipse.osee.disposition.rest.resources;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import javax.annotation.security.RolesAllowed;
import javax.ws.rs.Consumes;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import org.eclipse.osee.disposition.model.DispoMessages;
import org.eclipse.osee.disposition.model.DispoProgamDescriptorData;
import org.eclipse.osee.disposition.rest.DispoApi;
import org.eclipse.osee.disposition.rest.DispoRoles;
import org.eclipse.osee.framework.core.data.BranchId;
import org.eclipse.osee.framework.core.data.IOseeBranch;
import org.eclipse.osee.framework.core.util.JsonUtil;
/**
* @author Angel Avila
*/
@Path("program")
public class DispoProgramResource {
private final DispoApi dispoApi;
public DispoProgramResource(DispoApi dispoApi) {
this.dispoApi = dispoApi;
}
/**
* Create a new Disposition Set given a DispoSetDescriptor
*
* @param descriptor Descriptor Data which includes name and import path
* @return Response type for success of call
* @response.representation.201.doc Created the Disposition Set
* @response.representation.409.doc Conflict, tried to create a Disposition Set with same name
* @response.representation.400.doc Bad Request, did not provide both a Name and a valid Import Path
*/
@POST
@RolesAllowed(DispoRoles.ROLES_ADMINISTRATOR)
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.TEXT_PLAIN)
public Response createProgram(DispoProgamDescriptorData programDescriptor, @QueryParam("userName") String userName) {
String name = "(DISPO)" + programDescriptor.getName();
Response.Status status;
Response response;
if (!name.isEmpty()) {
boolean isUniqueName = dispoApi.isUniqueProgramName(name);
if (isUniqueName) {
long createdProgramId = dispoApi.createDispoProgram(name, userName);
status = Status.CREATED;
response = Response.status(status).entity(createdProgramId).build();
} else {
status = Status.CONFLICT;
response = Response.status(status).entity(DispoMessages.Set_ConflictingNames).build();
}
} else {
status = Status.BAD_REQUEST;
response = Response.status(status).entity(DispoMessages.Set_EmptyNameOrPath).build();
}
return response;
}
/**
* Create a new Disposition Set given a name
*
* @param name String used to name the branch
* @return Response type for success of call
* @response.representation.201.doc Created the Disposition Set
* @response.representation.409.doc Conflict, tried to create a Disposition Set with same name
* @response.representation.400.doc Bad Request, did not provide both a Name and a valid Import Path
*/
@Path("{name}")
@POST
@RolesAllowed(DispoRoles.ROLES_ADMINISTRATOR)
@Produces(MediaType.TEXT_PLAIN)
public Response createDispoProgramByName(@PathParam("name") String name, @QueryParam("userName") String userName) {
DispoProgamDescriptorData programDescriptor = new DispoProgamDescriptorData();
programDescriptor.setName(name);
return createProgram(programDescriptor, userName);
}
/**
* Get all Disposition Programs as JSON
*
* @return The Disposition Programs found
* @response.representation.200.doc OK, Found Disposition Program
* @response.representation.404.doc Not Found, Could not find any Disposition Programs
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response getAllPrograms() {
List<IOseeBranch> allPrograms = dispoApi.getDispoPrograms();
Collections.sort(allPrograms, new Comparator<IOseeBranch>() {
@Override
public int compare(IOseeBranch o1, IOseeBranch o2) {
return o1.getName().compareTo(o2.getName());
}
});
List<Map<String, String>> branchList = new LinkedList<>();
for (IOseeBranch branch : allPrograms) {
Map<String, String> mapObject = new HashMap<>();
String uuid = branch.getIdString();
mapObject.put("value", uuid);
mapObject.put("text", branch.getName());
branchList.add(mapObject);
}
Status status;
if (allPrograms.isEmpty()) {
status = Status.NOT_FOUND;
} else {
status = Status.OK;
}
String branchListJson = JsonUtil.toJson(branchList);
return Response.status(status).entity(branchListJson).build();
}
/**
* @return The found branchId if successful. Error Code otherwise
* @response.representation.200.doc OK, Found branchId
* @response.representation.404.doc Not Found, Could not find any branchId
*/
@Path("getDispoBranchId")
@GET
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@Produces(MediaType.APPLICATION_JSON)
public String getDispoBranchId(@FormParam("name") String branchName) {
return dispoApi.getDispoProgramIdByName(branchName).getIdString();
}
/**
* Import All Disposition Sets that are in a given State. Default state is "NONE".
*
* @param filterState Data used to specify what the user wants to import by its state
* @return Error code if failing.
* @response.representation.200.doc OK, looking through all Disposition Sets.
* @response.representation.404.doc Not Found, can't connect to server.
* @response.representation.405.doc Method Not Allowed, invalid permission.
* @response.representation.415.doc Unsupported Media Type.
*/
@Path("importAll")
@PUT
@RolesAllowed(DispoRoles.ROLES_ADMINISTRATOR)
@Consumes(MediaType.APPLICATION_JSON)
public Response importAllDispoSets(String filterState) {
Response.Status status;
dispoApi.importAllDispoPrograms(filterState, "OSEE System Auto-Import (All)");
status = Status.OK;
return Response.status(status).build();
}
/**
* Import All Disposition Sets that are in a given Branch and State. Default state is "NONE".
*
* @param filterState Data used to specify what the user wants to import by its state
* @return Error code if failing.
* @response.representation.200.doc OK, looking through Disposition Sets.
* @response.representation.404.doc Not Found, can't connect to server.
* @response.representation.415.doc Unsupported Media Type.
*/
@Path("importDispoBranch")
@PUT
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
public Response importDispoBranchByName(@FormParam("filterState") String filterState, @FormParam("name") String branchName) {
IOseeBranch branch = dispoApi.getDispoProgramIdByName(branchName);
Response.Status status;
dispoApi.importAllDispoSets(branch, filterState, "OSEE System Auto-Import (Branch)");
status = Status.OK;
return Response.status(status).build();
}
@Path("{branchId}/set")
public DispoSetResource getAnnotation(@PathParam("branchId") BranchId branch) {
return new DispoSetResource(dispoApi, branch);
}
@Path("{branchId}/admin")
public DispoAdminResource getDispoSetReport(@PathParam("branchId") BranchId branch) {
return new DispoAdminResource(dispoApi, branch);
}
@Path("{branchId}/config")
public DispoConfigResource getDispoDataStore(@PathParam("branchId") BranchId branch) {
return new DispoConfigResource(dispoApi, branch);
}
}
|
