Skip to content

Commit 57a572a

Browse files
RKrahlRKrahl
committed
Merge branch 'miredot-jakarta'
2 parents a20b1f5 + 355871b commit 57a572a

File tree

2 files changed

+23
-20
lines changed

2 files changed

+23
-20
lines changed

‎pom.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@
159159
<plugin>
160160
<groupId>com.qmino</groupId>
161161
<artifactId>miredot-plugin</artifactId>
162-
<version>2.4.1-Java11</version>
162+
<version>2.4.4-Java11</version>
163163
<executions>
164164
<execution>
165165
<id>miredot</id>
@@ -194,6 +194,9 @@
194194
</checks>
195195
</analysis>
196196
<restModel>
197+
<restFramework>
198+
<name>jakarta</name>
199+
</restFramework>
197200
<httpStatusCodes>
198201
<httpStatusCode>
199202
<httpCode>400</httpCode>

‎src/main/java/org/icatproject/ids/IdsService.java

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ public class IdsService {
5656
* datafileIds specified along with a sessionId. If two level storage is not
5757
* in use this has no effect.
5858
*
59+
* @title archive
5960
* @param sessionId A sessionId returned by a call to the icat server.
6061
* @param investigationIds If present, a comma separated list of investigation id values
6162
* @param datasetIds If present, a comma separated list of data set id values or
@@ -66,7 +67,6 @@ public class IdsService {
6667
* @throws InsufficientPrivilegesException
6768
* @throws InternalException
6869
* @throws NotFoundException
69-
* @summary archive
7070
* @statuscode 200 To indicate success
7171
*/
7272
@POST
@@ -84,6 +84,7 @@ public void archive(@Context HttpServletRequest request, @FormParam("sessionId")
8484
* Delete data specified by the investigationIds, datasetIds and datafileIds
8585
* specified along with a sessionId.
8686
*
87+
* @title delete
8788
* @param sessionId A sessionId returned by a call to the icat server.
8889
* @param investigationIds If present, a comma separated list of investigation id values
8990
* @param datasetIds If present, a comma separated list of data set id values or
@@ -95,7 +96,6 @@ public void archive(@Context HttpServletRequest request, @FormParam("sessionId")
9596
* @throws NotFoundException
9697
* @throws InternalException
9798
* @throws DataNotOnlineException
98-
* @summary delete
9999
* @statuscode 200 To indicate success
100100
*/
101101
@DELETE
@@ -115,8 +115,8 @@ private void exit() {
115115
/**
116116
* Return the version of the server
117117
*
118+
* @title Version
118119
* @return json string of the form: <samp>{"version":"4.4.0"}</samp>
119-
* @summary Version
120120
*/
121121
@GET
122122
@Path("version")
@@ -135,6 +135,7 @@ public String getVersion() {
135135
* of which may be omitted, along with a sessionId if the preparedId is not
136136
* set. If preparedId is set the compress and zip arguments are not used.
137137
*
138+
* @title getData
138139
* @param preparedId A valid preparedId returned by a call to prepareData
139140
* @param sessionId A sessionId returned by a call to the icat server.
140141
* @param investigationIds A comma separated list of investigation id values.
@@ -158,7 +159,6 @@ public String getVersion() {
158159
* @throws InternalException
159160
* @throws InsufficientPrivilegesException
160161
* @throws DataNotOnlineException
161-
* @summary getData
162162
* @statuscode 200 To indicate success
163163
*/
164164
@GET
@@ -198,6 +198,7 @@ public Response getData(@Context HttpServletRequest request, @QueryParam("prepar
198198
* and datafileIds specified along with a sessionId if the preparedId is not
199199
* set.
200200
*
201+
* @title getDatafileIds
201202
* @param preparedId A valid preparedId returned by a call to prepareData
202203
* @param sessionId A sessionId returned by a call to the icat server.
203204
* @param investigationIds A comma separated list of investigation id values.
@@ -208,7 +209,6 @@ public Response getData(@Context HttpServletRequest request, @QueryParam("prepar
208209
* @throws InternalException
209210
* @throws NotFoundException
210211
* @throws InsufficientPrivilegesException
211-
* @summary getDatafileIds
212212
* @statuscode 200 To indicate success
213213
*/
214214
@GET
@@ -248,6 +248,7 @@ public String getIcatUrl(@Context HttpServletRequest request) {
248248
* the file system where the IDS is storing data. Only read access to the
249249
* file is granted.
250250
*
251+
* @title getLink
251252
* @param sessionId A valid ICAT session ID
252253
* @param datafileId the id of a data file
253254
* @param username the name of the user who will will be granted access to the
@@ -259,7 +260,6 @@ public String getIcatUrl(@Context HttpServletRequest request) {
259260
* @throws InternalException
260261
* @throws NotFoundException
261262
* @throws DataNotOnlineException
262-
* @summary getLink
263263
* @statuscode 200 To indicate success
264264
*/
265265
@POST
@@ -278,12 +278,12 @@ public String getLink(@Context HttpServletRequest request, @FormParam("sessionId
278278
* Obtain detailed information about what the ids is doing. You need to be
279279
* privileged to use this call.
280280
*
281+
* @title getServiceStatus
281282
* @param sessionId A valid ICAT session ID of a user in the IDS rootUserNames
282283
* set.
283284
* @return a json string.
284285
* @throws InternalException
285286
* @throws InsufficientPrivilegesException
286-
* @summary getServiceStatus
287287
* @statuscode 200 To indicate success
288288
*/
289289
@GET
@@ -298,6 +298,7 @@ public String getServiceStatus(@Context HttpServletRequest request, @QueryParam(
298298
* Return the total size of all the data files specified by the
299299
* investigationIds, datasetIds and datafileIds along with a sessionId.
300300
*
301+
* @title getSize
301302
* @param preparedId A valid preparedId returned by a call to prepareData
302303
* @param sessionId A sessionId returned by a call to the icat server.
303304
* @param investigationIds If present, a comma separated list of investigation id values
@@ -309,7 +310,6 @@ public String getServiceStatus(@Context HttpServletRequest request, @QueryParam(
309310
* @throws NotFoundException
310311
* @throws InsufficientPrivilegesException
311312
* @throws InternalException
312-
* @summary getSize
313313
* @statuscode 200 To indicate success
314314
*/
315315
@GET
@@ -330,6 +330,7 @@ public long getSize(@Context HttpServletRequest request, @QueryParam("preparedId
330330
* Return the archive status of the data files specified by the
331331
* investigationIds, datasetIds and datafileIds along with a sessionId.
332332
*
333+
* @title getStatus
333334
* @param preparedId A valid preparedId returned by a call to prepareData
334335
* @param sessionId A sessionId returned by a call to the icat server. If the
335336
* sessionId is omitted or null the ids reader account will be
@@ -347,7 +348,6 @@ public long getSize(@Context HttpServletRequest request, @QueryParam("preparedId
347348
* @throws NotFoundException
348349
* @throws InsufficientPrivilegesException
349350
* @throws InternalException
350-
* @summary getStatus
351351
* @statuscode 200 To indicate success
352352
*/
353353
@GET
@@ -382,12 +382,12 @@ private void init() {
382382
* the end successfully will then go through all those it did not look at
383383
* because it did not start at the beginning.
384384
*
385+
* @title isPrepared
385386
* @param preparedId A valid preparedId returned by a call to prepareData
386387
* @return true if all the data files are ready to be downloaded else false.
387388
* @throws BadRequestException
388389
* @throws NotFoundException
389390
* @throws InternalException
390-
* @summary isPrepared
391391
* @statuscode 200 To indicate success
392392
*/
393393
@GET
@@ -402,8 +402,8 @@ public boolean isPrepared(@Context HttpServletRequest request, @QueryParam("prep
402402
* An ids server can be configured to be read only. This returns the
403403
* readOnly status of the server.
404404
*
405+
* @title isReadOnly
405406
* @return true if readonly, else false
406-
* @summary isReadOnly
407407
* @statuscode 200 To indicate success
408408
*/
409409
@GET
@@ -417,8 +417,8 @@ public boolean isReadOnly(@Context HttpServletRequest request) {
417417
* An ids server can be configured to support one or two levels of data
418418
* storage. This returns the twoLevel status of the server.
419419
*
420+
* @title isTwoLevel
420421
* @return true if twoLevel, else false
421-
* @summary isTwoLevel
422422
* @statuscode 200 To indicate success
423423
*/
424424
@GET
@@ -431,8 +431,8 @@ public boolean isTwoLevel(@Context HttpServletRequest request) {
431431
/**
432432
* Should return "IdsOK"
433433
*
434+
* @title ping
434435
* @return "IdsOK"
435-
* @summary ping
436436
* @statuscode 200 To indicate success
437437
*/
438438
@GET
@@ -450,6 +450,7 @@ public String ping() {
450450
* by the investigationIds, datasetIds and datafileIds, any of which may be
451451
* omitted, along with a sessionId.
452452
*
453+
* @title prepareData
453454
* @param sessionId A sessionId returned by a call to the icat server.
454455
* @param investigationIds A comma separated list of investigation id values.
455456
* @param datasetIds A comma separated list of data set id values.
@@ -466,7 +467,6 @@ public String ping() {
466467
* @throws InsufficientPrivilegesException
467468
* @throws NotFoundException
468469
* @throws InternalException
469-
* @summary prepareData
470470
* @statuscode 200 To indicate success
471471
*/
472472
@POST
@@ -485,6 +485,7 @@ public String prepareData(@Context HttpServletRequest request, @FormParam("sessi
485485
/**
486486
* Stores a data file
487487
*
488+
* @title put
488489
* @param body The contents of the file to be stored
489490
* @param sessionId A sessionId returned by a call to the icat server.
490491
* @param name A name to assign to the data file
@@ -503,7 +504,6 @@ public String prepareData(@Context HttpServletRequest request, @FormParam("sessi
503504
* @throws InsufficientPrivilegesException
504505
* @throws NotImplementedException
505506
* @throws DataNotOnlineException
506-
* @summary put
507507
* @statuscode 201 When object successfully created
508508
*/
509509
@PUT
@@ -528,6 +528,7 @@ public Response put(@Context HttpServletRequest request, InputStream body,
528528
* two fields will be removed shortly as they are only required by the old
529529
* (GWT based) topcat.
530530
*
531+
* @title putAsPost
531532
* @param request
532533
* @return a json object with attributes of "id", "checksum", "location" and
533534
* "size";
@@ -537,7 +538,6 @@ public Response put(@Context HttpServletRequest request, InputStream body,
537538
* @throws InsufficientPrivilegesException
538539
* @throws NotImplementedException
539540
* @throws DataNotOnlineException
540-
* @summary putAsPost
541541
* @statuscode 201 When object successfully created
542542
*/
543543
@POST
@@ -615,6 +615,7 @@ public Response putAsPost(@Context HttpServletRequest request) throws BadRequest
615615
* You must either specify a preparedId or a sessionId. If preparedId is
616616
* specified then investigationIds, datasetIds and datafileIds are not used.
617617
*
618+
* @title reset
618619
* @param preparedId A valid preparedId returned by a call to prepareData
619620
* @param sessionId A sessionId returned by a call to the icat server.
620621
* @param investigationIds A comma separated list of investigation id values.
@@ -625,7 +626,6 @@ public Response putAsPost(@Context HttpServletRequest request) throws BadRequest
625626
* @throws NotFoundException
626627
* @throws InternalException
627628
* @throws InsufficientPrivilegesException
628-
* @summary reset
629629
* @statuscode 200 To indicate success
630630
*/
631631
@POST
@@ -647,6 +647,7 @@ public void reset(@Context HttpServletRequest request, @FormParam("preparedId")
647647
* datafileIds specified along with a sessionId. If two level storage is not
648648
* in use this has no effect.
649649
*
650+
* @title restore
650651
* @param sessionId A sessionId returned by a call to the icat server.
651652
* @param investigationIds If present, a comma separated list of investigation id values
652653
* @param datasetIds If present, a comma separated list of data set id values or
@@ -657,7 +658,6 @@ public void reset(@Context HttpServletRequest request, @FormParam("preparedId")
657658
* @throws InsufficientPrivilegesException
658659
* @throws InternalException
659660
* @throws NotFoundException
660-
* @summary restore
661661
* @statuscode 200 To indicate success
662662
*/
663663
@POST
@@ -678,6 +678,7 @@ public void restore(@Context HttpServletRequest request, @FormParam("sessionId")
678678
* storage. If two level storage is not in use this has no
679679
* effect.
680680
*
681+
* @title write
681682
* @param sessionId A sessionId returned by a call to the icat server.
682683
* @param investigationIds If present, a comma separated list of investigation id values
683684
* @param datasetIds If present, a comma separated list of data set id values or
@@ -688,7 +689,6 @@ public void restore(@Context HttpServletRequest request, @FormParam("sessionId")
688689
* @throws InsufficientPrivilegesException
689690
* @throws InternalException
690691
* @throws NotFoundException
691-
* @summary write
692692
* @statuscode 200 To indicate success
693693
*/
694694
@POST

0 commit comments

Comments
 (0)