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
|
/*******************************************************************************
* Copyright (c) 2013 Boeing.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Boeing - initial API and implementation
*******************************************************************************/
package org.eclipse.osee.disposition.rest.resources;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
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.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.DispoSet;
import org.eclipse.osee.disposition.model.DispoSetData;
import org.eclipse.osee.disposition.model.DispoSetDescriptorData;
import org.eclipse.osee.disposition.rest.DispoApi;
import org.eclipse.osee.disposition.rest.util.HtmlWriter;
import org.eclipse.osee.framework.jdk.core.type.ResultSet;
/**
* @author Angel Avila
*/
public class DispoSetResource {
private final DispoApi dispoApi;
private final HtmlWriter writer;
private final String programId;
public DispoSetResource(DispoApi dispoApi, HtmlWriter writer, String programId) {
this.dispoApi = dispoApi;
this.writer = writer;
this.programId = programId;
}
/**
* Create a new Disposition Set given a DispoSetDescriptor
*
* @param descriptor Descriptor Data which includes name and import path
* @return The created Disposition Set if successful. Error Code otherwise
* @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
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public Response postDispoSet(DispoSetDescriptorData descriptor) {
Response.Status status;
Response response;
String name = descriptor.getName();
String importPath = descriptor.getImportPath();
if (!name.isEmpty() && !importPath.isEmpty()) {
boolean isUniqueSetName = dispoApi.isUniqueSetName(programId, name);
if (isUniqueSetName) {
String createdSetId = dispoApi.createDispoSet(programId, descriptor).getGuid();
DispoSetData createdSet = dispoApi.getDispoSetById(programId, createdSetId);
status = Status.CREATED;
response = Response.status(status).entity(createdSet).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;
}
/**
* Get all Disposition Sets on the given program branch
*
* @return The Disposition Sets found on the program branch
* @response.representation.200.doc OK, Found Disposition Sets
* @response.representation.404.doc Not Found, Could not find any Disposition Sets
*/
@GET
@Produces(MediaType.TEXT_HTML)
public Response getAllDispoSets() {
ResultSet<DispoSetData> allDispoSets = dispoApi.getDispoSets(programId);
Response.Status status;
String html;
if (allDispoSets.isEmpty()) {
status = Status.NOT_FOUND;
html = DispoMessages.Set_NoneFound;
} else {
status = Status.OK;
html = writer.createDispositionPage("Disposition Sets", allDispoSets);
}
return Response.status(status).entity(html).build();
}
/**
* Get a specific Disposition Set given a setId
*
* @param setId The Id of the Disposition Set to search for
* @return The found Disposition Set if successful. Error Code otherwise
* @response.representation.200.doc OK, Found Disposition Set
* @response.representation.404.doc Not Found, Could not find any Disposition Sets
*/
@Path("{setId}")
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response getDispoSetByIdJson(@PathParam("setId") String setId) {
Response response;
DispoSet result = dispoApi.getDispoSetById(programId, setId);
if (result == null) {
response = Response.status(Response.Status.NOT_FOUND).entity(DispoMessages.Set_NotFound).build();
} else {
response = Response.status(Response.Status.OK).entity(result).build();
}
return response;
}
/**
* Get a specific Disposition Set given a setId
*
* @param setId The Id of the Disposition Set to search for
* @return The found Disposition Set if successful. Error Code otherwise
* @response.representation.200.doc OK, Found Disposition Set
* @response.representation.404.doc Not Found, Could not find any Disposition Sets
*/
@Path("{setId}")
@GET
@Produces(MediaType.TEXT_HTML)
public Response getDispoSetByIdHtml(@PathParam("setId") String setId) {
Response.Status status;
String html;
DispoSet dispoSetArt = dispoApi.getDispoSetById(programId, setId);
if (dispoSetArt == null) {
status = Status.NOT_FOUND;
html = DispoMessages.Set_NotFound;
} else {
String notesJsonString = dispoSetArt.getNotesList().toString();
status = Status.OK;
String title = "Dispositionable Items";
String prefixPath = setId + "/dispositionableItem/";
html = writer.createDispoPage(dispoSetArt.getName(), prefixPath, title, notesJsonString);
}
return Response.status(status).entity(html).build();
}
/**
* Edit a specific Disposition Set given a setId and new Disposition Set Data
*
* @param setId The Id of the Disposition Set to search for
* @param newDispositionSet The data for the new Disposition Set
* @return The updated Disposition Set if successful. Error Code otherwise
* @response.representation.200.doc OK, Found Disposition Set
* @response.representation.404.doc Not Found, Could not find any Disposition Sets
*/
@Path("{setId}")
@PUT
@Consumes(MediaType.APPLICATION_JSON)
public Response putDispoSet(@PathParam("setId") String setId, DispoSetData newDispositionSet) {
Response.Status status;
boolean wasEdited = dispoApi.editDispoSet(programId, setId, newDispositionSet);
if (wasEdited) {
status = Status.OK;
} else {
status = Status.NOT_FOUND;
}
return Response.status(status).build();
}
/**
* Delete a specific Disposition Set given a setId
*
* @param setId The Id of the Disposition Set to search for
* @return Response Code
* @response.representation.200.doc OK, Found Disposition Set
* @response.representation.404.doc Not Found, Could not find any Disposition Sets
*/
@Path("{setId}")
@DELETE
public Response deleteDispoSet(@PathParam("setId") String setId) {
Response.Status status = Status.NOT_FOUND;
boolean wasDeleted = dispoApi.deleteDispoSet(programId, setId);
if (wasDeleted) {
status = Status.OK;
} else {
status = Status.NOT_FOUND;
}
return Response.status(status).build();
}
@Path("{setId}/item")
public DispoItemResource getDispositionableItems(@PathParam("setId") String setId) {
return new DispoItemResource(dispoApi, writer, programId, setId);
}
}
|
