Skip to content

Commit

Permalink
Merge branch 'miredot-jakarta'
Browse files Browse the repository at this point in the history
  • Loading branch information
@RKrahl
RKrahl committed Mar 15, 2024
2 parents a20b1f5 + 355871b commit 57a572a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 20 deletions.
5 changes: 4 additions & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@
<plugin>
<groupId>com.qmino</groupId>
<artifactId>miredot-plugin</artifactId>
<version>2.4.1-Java11</version>
<version>2.4.4-Java11</version>
<executions>
<execution>
<id>miredot</id>
Expand Down Expand Up @@ -194,6 +194,9 @@
</checks>
</analysis>
<restModel>
<restFramework>
<name>jakarta</name>
</restFramework>
<httpStatusCodes>
<httpStatusCode>
<httpCode>400</httpCode>
Expand Down
38 changes: 19 additions & 19 deletions src/main/java/org/icatproject/ids/IdsService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ public class IdsService {
* datafileIds specified along with a sessionId. If two level storage is not
* in use this has no effect.
*
* @title archive
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds If present, a comma separated list of investigation id values
* @param datasetIds If present, a comma separated list of data set id values or
Expand All @@ -66,7 +67,6 @@ public class IdsService {
* @throws InsufficientPrivilegesException
* @throws InternalException
* @throws NotFoundException
* @summary archive
* @statuscode 200 To indicate success
*/
@POST
Expand All @@ -84,6 +84,7 @@ public void archive(@Context HttpServletRequest request, @FormParam("sessionId")
* Delete data specified by the investigationIds, datasetIds and datafileIds
* specified along with a sessionId.
*
* @title delete
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds If present, a comma separated list of investigation id values
* @param datasetIds If present, a comma separated list of data set id values or
Expand All @@ -95,7 +96,6 @@ public void archive(@Context HttpServletRequest request, @FormParam("sessionId")
* @throws NotFoundException
* @throws InternalException
* @throws DataNotOnlineException
* @summary delete
* @statuscode 200 To indicate success
*/
@DELETE
Expand All @@ -115,8 +115,8 @@ private void exit() {
/**
* Return the version of the server
*
* @title Version
* @return json string of the form: <samp>{"version":"4.4.0"}</samp>
* @summary Version
*/
@GET
@Path("version")
Expand All @@ -135,6 +135,7 @@ public String getVersion() {
* of which may be omitted, along with a sessionId if the preparedId is not
* set. If preparedId is set the compress and zip arguments are not used.
*
* @title getData
* @param preparedId A valid preparedId returned by a call to prepareData
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds A comma separated list of investigation id values.
Expand All @@ -158,7 +159,6 @@ public String getVersion() {
* @throws InternalException
* @throws InsufficientPrivilegesException
* @throws DataNotOnlineException
* @summary getData
* @statuscode 200 To indicate success
*/
@GET
Expand Down Expand Up @@ -198,6 +198,7 @@ public Response getData(@Context HttpServletRequest request, @QueryParam("prepar
* and datafileIds specified along with a sessionId if the preparedId is not
* set.
*
* @title getDatafileIds
* @param preparedId A valid preparedId returned by a call to prepareData
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds A comma separated list of investigation id values.
Expand All @@ -208,7 +209,6 @@ public Response getData(@Context HttpServletRequest request, @QueryParam("prepar
* @throws InternalException
* @throws NotFoundException
* @throws InsufficientPrivilegesException
* @summary getDatafileIds
* @statuscode 200 To indicate success
*/
@GET
Expand Down Expand Up @@ -248,6 +248,7 @@ public String getIcatUrl(@Context HttpServletRequest request) {
* the file system where the IDS is storing data. Only read access to the
* file is granted.
*
* @title getLink
* @param sessionId A valid ICAT session ID
* @param datafileId the id of a data file
* @param username the name of the user who will will be granted access to the
Expand All @@ -259,7 +260,6 @@ public String getIcatUrl(@Context HttpServletRequest request) {
* @throws InternalException
* @throws NotFoundException
* @throws DataNotOnlineException
* @summary getLink
* @statuscode 200 To indicate success
*/
@POST
Expand All @@ -278,12 +278,12 @@ public String getLink(@Context HttpServletRequest request, @FormParam("sessionId
* Obtain detailed information about what the ids is doing. You need to be
* privileged to use this call.
*
* @title getServiceStatus
* @param sessionId A valid ICAT session ID of a user in the IDS rootUserNames
* set.
* @return a json string.
* @throws InternalException
* @throws InsufficientPrivilegesException
* @summary getServiceStatus
* @statuscode 200 To indicate success
*/
@GET
Expand All @@ -298,6 +298,7 @@ public String getServiceStatus(@Context HttpServletRequest request, @QueryParam(
* Return the total size of all the data files specified by the
* investigationIds, datasetIds and datafileIds along with a sessionId.
*
* @title getSize
* @param preparedId A valid preparedId returned by a call to prepareData
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds If present, a comma separated list of investigation id values
Expand All @@ -309,7 +310,6 @@ public String getServiceStatus(@Context HttpServletRequest request, @QueryParam(
* @throws NotFoundException
* @throws InsufficientPrivilegesException
* @throws InternalException
* @summary getSize
* @statuscode 200 To indicate success
*/
@GET
Expand All @@ -330,6 +330,7 @@ public long getSize(@Context HttpServletRequest request, @QueryParam("preparedId
* Return the archive status of the data files specified by the
* investigationIds, datasetIds and datafileIds along with a sessionId.
*
* @title getStatus
* @param preparedId A valid preparedId returned by a call to prepareData
* @param sessionId A sessionId returned by a call to the icat server. If the
* sessionId is omitted or null the ids reader account will be
Expand All @@ -347,7 +348,6 @@ public long getSize(@Context HttpServletRequest request, @QueryParam("preparedId
* @throws NotFoundException
* @throws InsufficientPrivilegesException
* @throws InternalException
* @summary getStatus
* @statuscode 200 To indicate success
*/
@GET
Expand Down Expand Up @@ -382,12 +382,12 @@ private void init() {
* the end successfully will then go through all those it did not look at
* because it did not start at the beginning.
*
* @title isPrepared
* @param preparedId A valid preparedId returned by a call to prepareData
* @return true if all the data files are ready to be downloaded else false.
* @throws BadRequestException
* @throws NotFoundException
* @throws InternalException
* @summary isPrepared
* @statuscode 200 To indicate success
*/
@GET
Expand All @@ -402,8 +402,8 @@ public boolean isPrepared(@Context HttpServletRequest request, @QueryParam("prep
* An ids server can be configured to be read only. This returns the
* readOnly status of the server.
*
* @title isReadOnly
* @return true if readonly, else false
* @summary isReadOnly
* @statuscode 200 To indicate success
*/
@GET
Expand All @@ -417,8 +417,8 @@ public boolean isReadOnly(@Context HttpServletRequest request) {
* An ids server can be configured to support one or two levels of data
* storage. This returns the twoLevel status of the server.
*
* @title isTwoLevel
* @return true if twoLevel, else false
* @summary isTwoLevel
* @statuscode 200 To indicate success
*/
@GET
Expand All @@ -431,8 +431,8 @@ public boolean isTwoLevel(@Context HttpServletRequest request) {
/**
* Should return "IdsOK"
*
* @title ping
* @return "IdsOK"
* @summary ping
* @statuscode 200 To indicate success
*/
@GET
Expand All @@ -450,6 +450,7 @@ public String ping() {
* by the investigationIds, datasetIds and datafileIds, any of which may be
* omitted, along with a sessionId.
*
* @title prepareData
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds A comma separated list of investigation id values.
* @param datasetIds A comma separated list of data set id values.
Expand All @@ -466,7 +467,6 @@ public String ping() {
* @throws InsufficientPrivilegesException
* @throws NotFoundException
* @throws InternalException
* @summary prepareData
* @statuscode 200 To indicate success
*/
@POST
Expand All @@ -485,6 +485,7 @@ public String prepareData(@Context HttpServletRequest request, @FormParam("sessi
/**
* Stores a data file
*
* @title put
* @param body The contents of the file to be stored
* @param sessionId A sessionId returned by a call to the icat server.
* @param name A name to assign to the data file
Expand All @@ -503,7 +504,6 @@ public String prepareData(@Context HttpServletRequest request, @FormParam("sessi
* @throws InsufficientPrivilegesException
* @throws NotImplementedException
* @throws DataNotOnlineException
* @summary put
* @statuscode 201 When object successfully created
*/
@PUT
Expand All @@ -528,6 +528,7 @@ public Response put(@Context HttpServletRequest request, InputStream body,
* two fields will be removed shortly as they are only required by the old
* (GWT based) topcat.
*
* @title putAsPost
* @param request
* @return a json object with attributes of "id", "checksum", "location" and
* "size";
Expand All @@ -537,7 +538,6 @@ public Response put(@Context HttpServletRequest request, InputStream body,
* @throws InsufficientPrivilegesException
* @throws NotImplementedException
* @throws DataNotOnlineException
* @summary putAsPost
* @statuscode 201 When object successfully created
*/
@POST
Expand Down Expand Up @@ -615,6 +615,7 @@ public Response putAsPost(@Context HttpServletRequest request) throws BadRequest
* You must either specify a preparedId or a sessionId. If preparedId is
* specified then investigationIds, datasetIds and datafileIds are not used.
*
* @title reset
* @param preparedId A valid preparedId returned by a call to prepareData
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds A comma separated list of investigation id values.
Expand All @@ -625,7 +626,6 @@ public Response putAsPost(@Context HttpServletRequest request) throws BadRequest
* @throws NotFoundException
* @throws InternalException
* @throws InsufficientPrivilegesException
* @summary reset
* @statuscode 200 To indicate success
*/
@POST
Expand All @@ -647,6 +647,7 @@ public void reset(@Context HttpServletRequest request, @FormParam("preparedId")
* datafileIds specified along with a sessionId. If two level storage is not
* in use this has no effect.
*
* @title restore
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds If present, a comma separated list of investigation id values
* @param datasetIds If present, a comma separated list of data set id values or
Expand All @@ -657,7 +658,6 @@ public void reset(@Context HttpServletRequest request, @FormParam("preparedId")
* @throws InsufficientPrivilegesException
* @throws InternalException
* @throws NotFoundException
* @summary restore
* @statuscode 200 To indicate success
*/
@POST
Expand All @@ -678,6 +678,7 @@ public void restore(@Context HttpServletRequest request, @FormParam("sessionId")
* storage. If two level storage is not in use this has no
* effect.
*
* @title write
* @param sessionId A sessionId returned by a call to the icat server.
* @param investigationIds If present, a comma separated list of investigation id values
* @param datasetIds If present, a comma separated list of data set id values or
Expand All @@ -688,7 +689,6 @@ public void restore(@Context HttpServletRequest request, @FormParam("sessionId")
* @throws InsufficientPrivilegesException
* @throws InternalException
* @throws NotFoundException
* @summary write
* @statuscode 200 To indicate success
*/
@POST
Expand Down

0 comments on commit 57a572a

Please sign in to comment.