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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*********************************************************************
* Copyright (c) 2015 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.orcs.rest.model;
import static org.eclipse.osee.framework.core.data.OseeClient.OSEE_ACCOUNT_ID;
import java.util.List;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
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 org.eclipse.osee.framework.core.data.ArtifactId;
import org.eclipse.osee.framework.core.data.Branch;
import org.eclipse.osee.framework.core.data.BranchId;
import org.eclipse.osee.framework.core.data.IOseeBranch;
import org.eclipse.osee.framework.core.data.JsonArtifact;
import org.eclipse.osee.framework.core.data.JsonRelations;
import org.eclipse.osee.framework.core.data.TransactionId;
import org.eclipse.osee.framework.core.data.TransactionResult;
import org.eclipse.osee.framework.core.data.UserId;
import org.eclipse.osee.framework.core.enums.BranchState;
import org.eclipse.osee.framework.core.enums.BranchType;
import org.eclipse.osee.framework.core.enums.PermissionEnum;
import org.eclipse.osee.framework.core.model.change.ChangeItem;
import org.eclipse.osee.framework.jdk.core.result.XResultData;
/**
* @author Roberto E. Escobar
*/
@Path("branches")
public interface BranchEndpoint {
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
List<Branch> getBranches(BranchQueryData query);
@POST
@Path("query")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
List<Branch> getFromQuery(BranchQueryData query);
/**
* Perform a branch query based on query parameter input
*
* @param branchUuids comma separated list of branch uuids
* @param branchTypes comma separated list of {@link org.eclipse.osee.framework.core.enums.BranchType BranchType}
* @param branchStates comma separated list of {@link org.eclipse.osee.framework.core.enums.BranchState BranchState}
* @param deleted to include deleted branches in the search
* @param archived to include archived branches in the search
* @param childOf branch uuid of the parent to search children of
* @param ancestorOf branch uuid of ancestor to search decendents of
* @param pretty if the returned JSON should be pretty printed
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
List<Branch> getBranches(@DefaultValue("") @QueryParam("branchUuids") String branchUuids, //
@DefaultValue("") @QueryParam("branchTypes") String branchTypes, //
@DefaultValue("") @QueryParam("branchStates") String branchStates, //
@DefaultValue("false") @QueryParam("deleted") boolean deleted, //
@DefaultValue("false") @QueryParam("archived") boolean archived, //
@DefaultValue("") @QueryParam("nameEquals") String nameEquals, //
@DefaultValue("") @QueryParam("namePattern") String namePattern, //
@QueryParam("childOf") Long childOf, //
@QueryParam("ancestorOf") Long ancestorOf);
@GET
@Path("baseline")
@Produces(MediaType.APPLICATION_JSON)
List<Branch> getBaselineBranches();
@GET
@Path("working")
@Produces(MediaType.APPLICATION_JSON)
List<Branch> getWorkingBranches();
@GET
@Path("{branch}")
@Produces({MediaType.APPLICATION_JSON})
Branch getBranchById(@PathParam("branch") BranchId branch);
@GET
@Path("{branch1}/diff/{branch2}")
@Produces({MediaType.APPLICATION_JSON})
List<ChangeItem> compareBranches(@PathParam("branch1") BranchId branch1, @PathParam("branch2") BranchId branch2);
@GET
@Path("{branch}/txs")
@Produces({MediaType.APPLICATION_JSON})
List<Transaction> getAllBranchTxs(@PathParam("branch") BranchId branch);
@GET
@Path("{branch}/txs/{tx-id}")
@Produces({MediaType.APPLICATION_JSON})
Transaction getBranchTx(@PathParam("branch") BranchId branch, @PathParam("tx-id") TransactionId txId);
@GET
@Path("{branch}/view/{viewId}/artifact/type/{artifactTypes}/attributes")
@Produces(MediaType.APPLICATION_JSON)
List<JsonArtifact> getArtifactDetailsByType(@PathParam("branch") BranchId branch, @PathParam("viewId") ArtifactId viewId, @PathParam("artifactTypes") String artifactTypes);
@GET
@Path("{branch}/artifact/type/{artifactTypes}/attributes")
@Produces(MediaType.APPLICATION_JSON)
List<JsonArtifact> getArtifactDetailsByType(@PathParam("branch") BranchId branch, @PathParam("artifactTypes") String artifactTypes);
@GET
@Path("{branch}/relation/type/{relationTypes}")
@Produces(MediaType.APPLICATION_JSON)
JsonRelations getRelationsByType(@PathParam("branch") BranchId branch, @PathParam("relationTypes") String relationTypes);
@POST
@Consumes({MediaType.APPLICATION_JSON})
@Produces({MediaType.APPLICATION_JSON})
BranchId createBranch(NewBranch data);
@POST
@Consumes({MediaType.APPLICATION_JSON})
@Produces({MediaType.APPLICATION_JSON})
XResultData createBranchValidation(NewBranch data);
/**
* If -1 is supplied for the branch path parameter, then a random valid id will be used
*/
@POST
@Path("{branch}/program")
@Consumes({MediaType.TEXT_PLAIN})
@Produces({MediaType.APPLICATION_JSON})
IOseeBranch createProgramBranch(@HeaderParam(OSEE_ACCOUNT_ID) UserId account, @PathParam("branch") BranchId branchId, String branchName);
@POST
@Path("{branch}")
@Consumes({MediaType.APPLICATION_JSON})
@Produces({MediaType.APPLICATION_JSON})
BranchId createBranchWithId(@PathParam("branch") BranchId branch, NewBranch data);
@POST
@Path("{branch}/commit/{destination-branch}")
@Consumes({MediaType.APPLICATION_JSON})
@Produces({MediaType.APPLICATION_JSON})
TransactionResult commitBranch(@PathParam("branch") BranchId branch, @PathParam("destination-branch") BranchId destinationBranch, BranchCommitOptions options);
@POST
@Path("{branch}/archive")
Response archiveBranch(@PathParam("branch") BranchId branch);
@POST
@Path("{branch}/txs")
@Consumes({MediaType.APPLICATION_JSON})
@Produces({MediaType.APPLICATION_JSON})
Response writeTx(@PathParam("branch") BranchId branch, NewTransaction data);
@POST
@Path("exchange/validation")
Response validateExchange(@QueryParam("path") String path);
@POST
@Path("exchange/export")
@Consumes({MediaType.APPLICATION_JSON})
Response exportBranches(BranchExportOptions options);
@POST
@Path("exchange/import")
@Consumes({MediaType.APPLICATION_JSON})
Response importBranches(BranchImportOptions options);
@DELETE
@Path("exchange")
Response deleteBranchExchange(@QueryParam("path") String path);
@PUT
@Path("{branch}/name")
@Consumes({MediaType.TEXT_PLAIN})
Response setBranchName(@PathParam("branch") BranchId branch, String newName);
@PUT
@Path("{branch}/type/{branch-type}")
Response setBranchType(@PathParam("branch") BranchId branch, @PathParam("branch-type") BranchType newType);
@PUT
@Path("{branch}/state/{branch-state}")
Response setBranchState(@PathParam("branch") BranchId branch, @PathParam("branch-state") BranchState newState);
@POST
@Path("{branch}/permission/{permission}/{subject}")
void setBranchPermission(@PathParam("subject") ArtifactId subject, @PathParam("branch") BranchId branch, @PathParam("permission") PermissionEnum permission);
@PUT
@Path("{branch}/associated-artifact/{art-id}")
Response associateBranchToArtifact(@PathParam("branch") BranchId branch, @PathParam("art-id") ArtifactId artifact);
@PUT
@Path("{branch}/txs/{tx-id}/comment")
@Consumes({MediaType.TEXT_PLAIN})
Response setTxComment(@PathParam("branchd") BranchId branch, @PathParam("tx-id") TransactionId txId, String comment);
@DELETE
@Path("{branch}")
Response purgeBranch(@PathParam("branch") BranchId branch, @DefaultValue("false") @QueryParam("recurse") boolean recurse);
@DELETE
@Path("{branch}/associated-artifact")
Response unassociateBranch(@PathParam("branch") BranchId branch);
@DELETE
@Path("{branch}/commit/{destination-branch}")
@Produces({MediaType.APPLICATION_JSON})
Response unCommitBranch(@PathParam("branch") BranchId branch, @PathParam("destination-branch") BranchId destinationBranch);
@DELETE
@Path("{branch}/archive")
@Produces({MediaType.APPLICATION_JSON})
Response unarchiveBranch(@PathParam("branch") BranchId branch);
@DELETE
@Path("{branch}/txs/{tx-ids}")
Response purgeTxs(@PathParam("branch") BranchId branch, @PathParam("tx-ids") String txIds);
@PUT
@Path("log")
@Consumes({MediaType.TEXT_PLAIN})
Response logBranchActivity(String comment);
}
|
