Package com.sodius.oslc.server.trs.services

Class TrsAdminService

java.lang.Object
com.sodius.oslc.server.trs.services.TrsAdminService
@Path("/trs") public class TrsAdminService extends Object
Provides an API for server administrators to manage their application TRS feeds. Typically, used through the TRS web component.
Since:
3.3.0

  • Constructor Details

    • TrsAdminService

      public TrsAdminService()

  • Method Details

    • getFeeds

      @GET @Path("/feed") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response getFeeds()

    • getFeedProjectAreas

      @GET @Path("/feed/{id}/project-areas") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response getFeedProjectAreas(@PathParam("id") String feed)
      Returns the list of project areas that are currently exposed in the TRS Process feed, with for each project the number of resources on the given feed.
      Parameters:
      feed - the identifier of TRS feed of interest
      Returns:
      a response with a collection of ProjectArea resources as entity

    • validateFeed

      @POST @Path("/feed/{id}/validate") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response validateFeed(@PathParam("id") String feed)

    • validateProjectAreas

      @POST @Path("/feed/{id}/validate/project-areas") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response validateProjectAreas(@PathParam("id") String feed, @QueryParam("p") Set<String> projectAreas)

    • forceUpdateFeedProject

      @POST @Path("/feed/{id}/forceUpdate") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response forceUpdateFeedProject(@PathParam("id") String feed, @QueryParam("p") Set<String> projectAreas)

    • rebuildFeed

      @POST @Path("/feed/{id}/rebuild") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response rebuildFeed(@PathParam("id") String feed)

    • getProcess

      @GET @Path("/feed/{id}/process/{process}") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response getProcess(@PathParam("id") String feed, @PathParam("process") String process)

    • getProcessStatus

      @GET @Path("/feed/{id}/process/{process}/status") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response getProcessStatus(@PathParam("id") String feed, @PathParam("process") String process)

    • concludeProcess

      @POST @Path("/feed/{id}/process/{process}") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response concludeProcess(@PathParam("id") String feed, @PathParam("process") String process)

    • abortProcess

      @DELETE @Path("/feed/{id}/process/{process}") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response abortProcess(@PathParam("id") String feed, @PathParam("process") String process)

    • getFeedStatus

      @GET @Path("/feed/{id}/status") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response getFeedStatus(@PathParam("id") String id)

    • getFunctionalUser

      @GET @Path("/user") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response getFunctionalUser()

    • setFunctionalUser

      @PUT @Path("/user") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response setFunctionalUser(@QueryParam("identifier") String identifier)

    • deleteFunctionalUser

      @DELETE @Path("/user") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response deleteFunctionalUser()

    • getTrsProjectAreas

      @GET @Path("/project-areas") @Produces({"application/rdf+xml","application/xml","text/xml","application/json","application/ld+json","text/turtle"}) public Response getTrsProjectAreas(@QueryParam("forbidden") boolean forbidden)
      Returns the list of project areas that are OSLC enabled and that match the requested access for the TRS user. If forbidden query parameter is true, the method returns the project areas for which the TRS user has no access to. The content of the list does not depend on whether those project areas are currently exposed in the TRS Process feed.
      Parameters:
      forbidden - a boolean to determine the project access type
      Returns:
      a response with a collection of ProjectArea resources as entity