WebApplicationResource (Vitam API Reference (1.0.0))

java.lang.Object
- fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
- - fr.gouv.vitam.ihmdemo.appserver.WebApplicationResource

All Implemented Interfaces:: VitamResource

@Path(value="/v1/api")
 @ApplicationPath(value="webresources")
public class WebApplicationResource
extends ApplicationStatusResource

Web Application Resource class

Field Summary

Fields
Modifier and Type Field and Description

static String X_CHUNK_OFFSET

static String X_SIZE_TOTAL
- Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
  STATUS_URL, TENANTS_URL

Fields
Modifier and Type	Field and Description
`static String`	`X_CHUNK_OFFSET`
`static String`	`X_SIZE_TOTAL`

Constructor Summary

Constructors
Constructor and Description

WebApplicationResource(WebApplicationConfig webApplicationConfig, Set<String> permissions)
Constructor

Constructors
Constructor and Description
`WebApplicationResource(WebApplicationConfig webApplicationConfig, Set<String> permissions)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`cancelProcess(javax.servlet.http.HttpServletRequest request, String id)`
`javax.ws.rs.core.Response`	`checkOperationTraceability(javax.servlet.http.HttpServletRequest request, String operationCriteria)` Starts a TRACEABILITY check process
`javax.ws.rs.core.Response`	`checkRefFormat(javax.servlet.http.HttpServletRequest request, InputStream input)` check the referential format
`void`	`checkRefRule(javax.servlet.http.HttpServletRequest request, InputStream input, javax.ws.rs.container.AsyncResponse asyncResponse)` check the referential rules
`javax.ws.rs.core.Response`	`checkUploadOperation(String operationId, javax.servlet.http.HttpServletRequest request, String action)` Check if the upload operation is done
`javax.ws.rs.core.Response`	`clearUploadOperationHistory(String operationId)` Once done, clear the Upload operation history
`javax.ws.rs.core.Response`	`createDIPForExport(javax.servlet.http.HttpServletRequest request, String criteria)` Send a queryDSL request in order to select some units and create a matching DIP
`javax.ws.rs.core.Response`	`createProfilesMetadata(javax.servlet.http.HttpServletRequest request, InputStream input)` Create profiles metadata
`void`	`downloadProfileFile(javax.servlet.http.HttpServletRequest request, String profileMetadataId, javax.ws.rs.container.AsyncResponse asyncResponse)`
`javax.ws.rs.core.Response`	`downloadRulesReport(javax.servlet.http.HttpServletRequest request, String id)`
`void`	`downloadTraceabilityFile(javax.servlet.http.HttpServletRequest request, String operationId, String contractId, String tenantIdParam, javax.ws.rs.container.AsyncResponse asyncResponse)` Download the Traceability Operation file
`javax.ws.rs.core.Response`	`extractTimeStampInformation(String timestamp)` Extract information from timestamp
`javax.ws.rs.core.Response`	`findAccessContract(javax.servlet.http.HttpServletRequest request, String id)` Query to Access contracts by id
`javax.ws.rs.core.Response`	`findAccessContracts(javax.servlet.http.HttpServletRequest request, String select)` Query to get Access contracts
`javax.ws.rs.core.Response`	`findContext(javax.servlet.http.HttpServletRequest request, String select)` Get contexts
`javax.ws.rs.core.Response`	`findContextByID(javax.servlet.http.HttpServletRequest request, String id)` Get context by id
`javax.ws.rs.core.Response`	`findContractsById(javax.servlet.http.HttpServletRequest request, String id)` Gets contracts by name
`javax.ws.rs.core.Response`	`findIngestContracts(javax.servlet.http.HttpServletRequest request, String select)` Gets contracts
`javax.ws.rs.core.Response`	`findProfileByID(javax.servlet.http.HttpServletRequest request, String id)` Query to Access contracts by id
`javax.ws.rs.core.Response`	`findProfiles(javax.servlet.http.HttpServletRequest request, String select)` Query to get profiles
`javax.ws.rs.core.Response`	`findServiceAgencies(javax.servlet.http.HttpServletRequest request, String select)` Find Service Agencies by DSL
`javax.ws.rs.core.Response`	`findServiceAgencyById(javax.servlet.http.HttpServletRequest request, String id)` Query to Service Agency by identifier
`javax.ws.rs.core.Response`	`getAccessionRegister(javax.servlet.http.HttpServletRequest request, String sessionId, String options)` Get the action registers filtered with option query
`javax.ws.rs.core.Response`	`getAccessionRegisterDetail(javax.servlet.http.HttpServletRequest request, String id, String options)` Get the detail of an accessionregister matching options query
`javax.ws.rs.core.Response`	`getAdminTenant()` Return admin tenant
`javax.ws.rs.core.Response`	`getArchiveObjectGroup(javax.servlet.http.HttpServletRequest request, String objectGroupId)` Retrieve an ObjectGroup as Json data based on the provided ObjectGroup id
`javax.ws.rs.core.Response`	`getArchiveSearchResult(javax.servlet.http.HttpServletRequest request, String sessionId, String criteria)`
`javax.ws.rs.core.Response`	`getArchiveUnitDetails(javax.servlet.http.HttpServletRequest request, String unitId)`
`void`	`getDIPAsInputStreamAsync(javax.servlet.http.HttpServletRequest request, String id, javax.ws.rs.container.AsyncResponse asyncResponse)` Send a DIP id request in order to download the matching DIP
`javax.ws.rs.core.Response`	`getFileFormats(javax.servlet.http.HttpServletRequest request, String sessionId, String options)`
`javax.ws.rs.core.Response`	`getFileRules(javax.servlet.http.HttpServletRequest request, String sessionId, String options)`
`javax.ws.rs.core.Response`	`getFormatById(javax.servlet.http.HttpServletRequest request, String formatId, String options)`
`javax.ws.rs.core.Response`	`getLogbookMessages()` Retrieve all the messages for logbook
`javax.ws.rs.core.Response`	`getLogbookResult(javax.servlet.http.HttpServletRequest request, String sessionId, String options)`
`javax.ws.rs.core.Response`	`getLogbookResultById(javax.servlet.http.HttpServletRequest request, String operationId, String options)`
`void`	`getObjectAsInputStreamAsync(String unitId, String usage, String filename, Integer tenantId, String contractId, javax.ws.rs.container.AsyncResponse asyncResponse)` Retrieve an Object data as an input stream.
`void`	`getObjectFromStorageAsInputStreamAsync(javax.servlet.http.HttpServletRequest request, String objectId, String type, javax.ws.rs.container.AsyncResponse asyncResponse)` Retrieve an Object data stored by ingest operation as an input stream.
`javax.ws.rs.core.Response`	`getObjectGroupLifeCycleById(javax.servlet.http.HttpServletRequest request, String objectGroupLifeCycleId)` returns the object group life cycle based on its id
`javax.ws.rs.core.Response`	`getPermissions(javax.servlet.http.HttpServletRequest httpRequest)`
`javax.ws.rs.core.Response`	`getRuleById(javax.servlet.http.HttpServletRequest request, String ruleId, String options)`
`javax.ws.rs.core.Response`	`getSecureMode()` Return authentication mode
`javax.ws.rs.core.Response`	`getUnitLifeCycleById(javax.servlet.http.HttpServletRequest request, String unitLifeCycleId)` returns the unit life cycle based on its id
`javax.ws.rs.core.Response`	`getUnitTree(javax.servlet.http.HttpServletRequest request, com.fasterxml.jackson.databind.JsonNode dslQuery)` This resource returns all paths relative to a unit
`javax.ws.rs.core.Response`	`getWorkflowDefinitions(javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`importProfileFile(javax.servlet.http.HttpServletRequest request, InputStream input, String id)` Upload profile xsd or rng
`javax.ws.rs.core.Response`	`ingest(javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request, byte[] stream)` upload : API Endpoint that can Handle chunk mode.
`javax.ws.rs.core.Response`	`launchAudit(javax.servlet.http.HttpServletRequest request, com.fasterxml.jackson.databind.JsonNode auditOption)`
`javax.ws.rs.core.Response`	`listOperationsDetails(javax.servlet.http.HttpServletRequest request, ProcessQuery query)` Get the workflow operations list for step by step ingest
`javax.ws.rs.core.Response`	`login(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletRequest httpRequest, com.fasterxml.jackson.databind.JsonNode object)`
`javax.ws.rs.core.Response`	`updateAccessContracts(javax.servlet.http.HttpServletRequest request, String contractId, com.fasterxml.jackson.databind.JsonNode updateOptions)` Update Access contracts
`javax.ws.rs.core.Response`	`updateArchiveUnitDetails(javax.servlet.http.HttpServletRequest request, String unitId, String updateSet)` Update Archive Units
`javax.ws.rs.core.Response`	`updateContexts(javax.servlet.http.HttpServletRequest request, String contextId, com.fasterxml.jackson.databind.JsonNode updateOptions)` Update context
`javax.ws.rs.core.Response`	`updateIngestContracts(javax.servlet.http.HttpServletRequest request, String contractId, com.fasterxml.jackson.databind.JsonNode updateOptions)` Upload Access contracts
`javax.ws.rs.core.Response`	`updateProfile(javax.servlet.http.HttpServletRequest request, String profileMetadataId, com.fasterxml.jackson.databind.JsonNode updateOptions)` Update the detail of the profile
`javax.ws.rs.core.Response`	`updateWorkFlowStatus(javax.servlet.http.HttpServletRequest request, String id)` Update the status of an operation.
`javax.ws.rs.core.Response`	`uploadAccessContracts(javax.servlet.http.HttpServletRequest request, InputStream input)` Upload Access contracts
`javax.ws.rs.core.Response`	`uploadContext(javax.servlet.http.HttpServletRequest request, InputStream input)` upload context
`javax.ws.rs.core.Response`	`uploadRefContracts(javax.servlet.http.HttpServletRequest request, InputStream input)` Upload contracts
`javax.ws.rs.core.Response`	`uploadRefFormat(javax.servlet.http.HttpServletRequest request, InputStream input)` Upload the referential format in the base
`javax.ws.rs.core.Response`	`uploadRefRule(javax.servlet.http.HttpServletRequest request, InputStream input)` Upload the referential rules in the base
`javax.ws.rs.core.Response`	`uploadServiceAgencies(javax.servlet.http.HttpServletRequest request, InputStream input)` Upload Service Agencies

Methods inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
getServerTenants, status

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- X_SIZE_TOTAL
```
public static final String X_SIZE_TOTAL
```
  See Also:
  
  Constant Field Values
- X_CHUNK_OFFSET
```
public static final String X_CHUNK_OFFSET
```
  See Also:
  
  Constant Field Values

Constructor Detail

WebApplicationResource

public WebApplicationResource(WebApplicationConfig webApplicationConfig,
                              Set<String> permissions)

Constructor

Parameters:: webApplicationConfig - the web server ihm-demo configuration; permissions - list of permissions

Method Detail

getLogbookMessages

@GET
 @Path(value="/messages/logbook")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getLogbookMessages()

Retrieve all the messages for logbook

Returns:: Response

getArchiveSearchResult

@POST
 @Path(value="/archivesearch/units")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getArchiveSearchResult(@Context
                                                                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                                                                        @CookieParam(value="JSESSIONID")
                                                                                                                                        String sessionId,
                                                                                                                                        String criteria)

Parameters:: request - needed for the request: X-TENANT-ID (mandatory), X-LIMIT/X-OFFSET (not mandatory); sessionId - json session id from shiro; criteria - criteria search for units
Returns:: Reponse

getArchiveUnitDetails

@GET
 @Path(value="/archivesearch/unit/{id}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getArchiveUnitDetails(@Context
                                                                                                                                          javax.servlet.http.HttpServletRequest request,
                                                                                                                                          @PathParam(value="id")
                                                                                                                                          String unitId)

Parameters:: request - needed for the request: X-TENANT-ID (mandatory), X-LIMIT/X-OFFSET (not mandatory); unitId - archive unit id
Returns:: archive unit details

getLogbookResult

@POST
 @Path(value="/logbook/operations")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getLogbookResult(@Context
                                                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                                                 @CookieParam(value="JSESSIONID")
                                                                                                                                 String sessionId,
                                                                                                                                 String options)

Parameters:: request - the http request; sessionId - json session id from shiro; options - the queries for searching
Returns:: Response

getLogbookResultById

@POST
 @Path(value="/logbook/operations/{idOperation}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getLogbookResultById(@Context
                                                                                                                                                   javax.servlet.http.HttpServletRequest request,
                                                                                                                                                   @PathParam(value="idOperation")
                                                                                                                                                   String operationId,
                                                                                                                                                   String options)

Parameters:: request - needed for the request: X-TENANT-ID (mandatory), X-LIMIT/X-OFFSET (not mandatory); operationId - id of operation; options - the queries for searching
Returns:: Response

ingest

@Path(value="ingest/upload")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response ingest(@Context
                                                                                                                                                              javax.servlet.http.HttpServletResponse response,
                                                                                                                                                              @Context
                                                                                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                                                                                              byte[] stream)

upload : API Endpoint that can Handle chunk mode. Chunks information are given in header (Fast catch of these header are present in the code)
The front should give some information

Flow-Chunk-Number => The index of the current chunk
Flow-Chunk-Size => The configured maximal size of a chunk
Flow-Current-Chunk-Size => The size of the current chunk
Flow-Total-Size => The total size of the file (All chunks)
Flow-Identifier => The identifier of the flow
Flow-Filename => The file name
Flow-Relative-Path => (?)The relative path (or the file name only)
Flow-Total-Chunks => The number of chunks

Parameters:: request - the http servlet request; response - the http servlet response; stream - data input stream for the current chunk; request - HTTP request
Returns:: Response

checkUploadOperation

@Path(value="check/{id_op}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response checkUploadOperation(@PathParam(value="id_op")
                                                                                                                                      String operationId,
                                                                                                                                      @Context
                                                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                                                      @QueryParam(value="action")
                                                                                                                                      String action)
                                                                                                                               throws VitamClientException,
                                                                                                                                      IngestExternalException

Check if the upload operation is done

Parameters:: operationId -
Returns:: the Response
Throws:: VitamClientException; IngestExternalException

clearUploadOperationHistory

@Path(value="clear/{id_op}")
 @GET
public javax.ws.rs.core.Response clearUploadOperationHistory(@PathParam(value="id_op")
                                                                                                String operationId)

Once done, clear the Upload operation history

Parameters:: operationId - the operation id
Returns:: the Response

updateArchiveUnitDetails

@POST
 @Path(value="/archiveupdate/units/{id}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response updateArchiveUnitDetails(@Context
                                                                                                                                                                                    javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                    @PathParam(value="id")
                                                                                                                                                                                    String unitId,
                                                                                                                                                                                    String updateSet)

Update Archive Units

Parameters:: request - HTTP request; updateSet - contains updated field; unitId - archive unit id
Returns:: archive unit details

getFileFormats

@POST
 @Path(value="/admin/formats")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getFileFormats(@Context
                                                                                                                          javax.servlet.http.HttpServletRequest request,
                                                                                                                          @CookieParam(value="JSESSIONID")
                                                                                                                          String sessionId,
                                                                                                                          String options)

Parameters:: request - HTTP request; sessionId - json session id from shiro; options - the queries for searching
Returns:: Response

getFormatById

@POST
 @Path(value="/admin/formats/{idFormat:.+}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getFormatById(@Context
                                                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                                                       @PathParam(value="idFormat")
                                                                                                                                       String formatId,
                                                                                                                                       String options)

Parameters:: request - HTTP request; formatId - id of format; options - the queries for searching
Returns:: Response

checkRefFormat

@POST
 @Path(value="/format/check")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response checkRefFormat(@Context
                                                                                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                      InputStream input)

check the referential format

Parameters:: request - HTTP request; input - the format file xml
Returns:: If the formet is valid, return ok. If not, return the list of errors

uploadRefFormat

@POST
 @Path(value="/format/upload")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response uploadRefFormat(@Context
                                                                                                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                        InputStream input)

Upload the referential format in the base

Parameters:: request - HTTP request; input - the format file xml
Returns:: Response

getArchiveObjectGroup

@GET
 @Path(value="/archiveunit/objects/{idOG}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getArchiveObjectGroup(@Context
                                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                                             @PathParam(value="idOG")
                                                                                                                                             String objectGroupId)

Retrieve an ObjectGroup as Json data based on the provided ObjectGroup id

Parameters:: request - HTTP request; objectGroupId - the object group Id
Returns:: a response containing a json with informations about usages and versions for an object group

getObjectAsInputStreamAsync

@GET
 @Path(value="/archiveunit/objects/download/{unitId}")
 @Produces(value="application/octet-stream")
public void getObjectAsInputStreamAsync(@PathParam(value="unitId")
                                                                                                                                                 String unitId,
                                                                                                                                                 @QueryParam(value="usage")
                                                                                                                                                 String usage,
                                                                                                                                                 @QueryParam(value="filename")
                                                                                                                                                 String filename,
                                                                                                                                                 @QueryParam(value="tenantId")
                                                                                                                                                 Integer tenantId,
                                                                                                                                                 @QueryParam(value="contractId")
                                                                                                                                                 String contractId,
                                                                                                                                                 @Suspended
                                                                                                                                                 javax.ws.rs.container.AsyncResponse asyncResponse)

Retrieve an Object data as an input stream. Download by access.

Parameters:: unitId - the unit Id; usage - additional mandatory parameters usage; filename - additional mandatory parameters filename; tenantId - the tenant id; contractId - the contract id; asyncResponse - will return the inputstream

getObjectFromStorageAsInputStreamAsync

@GET
 @Path(value="/ingests/{idObject}/{type}")
 @Produces(value="application/octet-stream")
public void getObjectFromStorageAsInputStreamAsync(@Context
                                                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                                                @PathParam(value="idObject")
                                                                                                                                                String objectId,
                                                                                                                                                @PathParam(value="type")
                                                                                                                                                String type,
                                                                                                                                                @Suspended
                                                                                                                                                javax.ws.rs.container.AsyncResponse asyncResponse)

Retrieve an Object data stored by ingest operation as an input stream. Download by ingests.

Parameters:: request - HTTP request; objectId - the object id to get; type - of collection; asyncResponse - request asynchronized response

getFileRules

@POST
 @Path(value="/admin/rules")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getFileRules(@Context
                                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                                      @CookieParam(value="JSESSIONID")
                                                                                                                      String sessionId,
                                                                                                                      String options)

Parameters:: request - HTTP request; sessionId - json session id from shiro; options - the queries for searching
Returns:: Response

getRuleById

@POST
 @Path(value="/admin/rules/{id_rule}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getRuleById(@Context
                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                               @PathParam(value="id_rule")
                                                                                                                               String ruleId,
                                                                                                                               String options)

Parameters:: request - HTTP request; ruleId - id of rule; options - the queries for searching
Returns:: Response

downloadRulesReport

@GET
 @Path(value="/rules/report/download/{id}")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response downloadRulesReport(@Context
                                                                                                                                                   javax.servlet.http.HttpServletRequest request,
                                                                                                                                                   @PathParam(value="id")
                                                                                                                                                   String id)

checkRefRule

@POST
 @Path(value="/rules/check")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/octet-stream")
public void checkRefRule(@Context
                                                                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                                                                      InputStream input,
                                                                                                                                                      @Suspended
                                                                                                                                                      javax.ws.rs.container.AsyncResponse asyncResponse)

check the referential rules

Parameters:: request - HTTP request; input - the rules file csv

uploadRefRule

@POST
 @Path(value="/rules/upload")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response uploadRefRule(@Context
                                                                                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                     InputStream input)

Upload the referential rules in the base

Parameters:: request - HTTP request; input - the format file CSV
Returns:: Response

getAccessionRegister

@POST
 @Path(value="/admin/accession-register")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAccessionRegister(@Context
                                                                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                                                                           @CookieParam(value="JSESSIONID")
                                                                                                                                           String sessionId,
                                                                                                                                           String options)

Get the action registers filtered with option query

Parameters:: request - HTTP request; sessionId - json session id from shiro; options - the queries for searching
Returns:: Response

getAccessionRegisterDetail

@POST
 @Path(value="/admin/accession-register/{id}/accession-register-detail")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAccessionRegisterDetail(@Context
                                                                                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                @PathParam(value="id")
                                                                                                                                                                                String id,
                                                                                                                                                                                String options)

Get the detail of an accessionregister matching options query

Parameters:: request - HTTP request; id - of accession response to get; options - query criteria
Returns:: accession register details

getUnitTree

@POST
 @Path(value="/archiveunit/tree")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getUnitTree(@Context
                                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                                               com.fasterxml.jackson.databind.JsonNode dslQuery)

This resource returns all paths relative to a unit

Parameters:: request - HTTP request; dslQuery - the dsl query
Returns:: all paths relative to a unit

login

@POST
 @Path(value="login")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response login(@Context
                                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                                             @Context
                                                                                                                                             javax.servlet.http.HttpServletRequest httpRequest,
                                                                                                                                             com.fasterxml.jackson.databind.JsonNode object)

Parameters:: request - HTTP request; object - user credentials
Returns:: Response OK if login success

getPermissions

@GET
 @Path(value="permissions")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getPermissions(@Context
                                                                                                                      javax.servlet.http.HttpServletRequest httpRequest)

Returns:: List of permissions

getUnitLifeCycleById

@GET
 @Path(value="/logbookunitlifecycles/{id_lc}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getUnitLifeCycleById(@Context
                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                               @PathParam(value="id_lc")
                                                                                                                                               String unitLifeCycleId)

returns the unit life cycle based on its id

Parameters:: request - HTTP request; unitLifeCycleId - the unit id (== unit life cycle id)
Returns:: the unit life cycle

getObjectGroupLifeCycleById

@GET
 @Path(value="/logbookobjectslifecycles/{id_lc}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectGroupLifeCycleById(@Context
                                                                                                                                                         javax.servlet.http.HttpServletRequest request,
                                                                                                                                                         @PathParam(value="id_lc")
                                                                                                                                                         String objectGroupLifeCycleId)

returns the object group life cycle based on its id

Parameters:: request - HTTP request; objectGroupLifeCycleId - the object group id (== object group life cycle id)
Returns:: the object group life cycle

listOperationsDetails

@POST
 @Path(value="/operations")
 @Produces(value="application/json")
public javax.ws.rs.core.Response listOperationsDetails(@Context
                                                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                                                              ProcessQuery query)

Get the workflow operations list for step by step ingest

Parameters:: request - HTTP request; query - the query
Returns:: the operations list

updateWorkFlowStatus

@Path(value="operations/{id}")
 @PUT
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response updateWorkFlowStatus(@Context
                                                                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                                                                        @PathParam(value="id")
                                                                                                                                        String id)

Update the status of an operation.

Parameters:: request - HTTP request; id - operation identifier
Returns:: http response

cancelProcess

@DELETE
 @Path(value="/operations/{id}")
public javax.ws.rs.core.Response cancelProcess(@Context
                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                        @PathParam(value="id")
                                                                                        String id)

uploadRefContracts

@POST
 @Path(value="/contracts")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response uploadRefContracts(@Context
                                                                                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                       InputStream input)

Upload contracts

Parameters:: request - HTTP request; input - the format file CSV
Returns:: Response

findIngestContracts

@POST
 @Path(value="/contracts")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findIngestContracts(@Context
                                                                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                String select)

Gets contracts

Parameters:: request - HTTP request; select - the query
Returns:: Response

findContractsById

@GET
 @Path(value="/contracts/{id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findContractsById(@Context
                                                                                                                                                                  javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                  @PathParam(value="id")
                                                                                                                                                                  String id)

Gets contracts by name

Parameters:: request - HTTP request; id - if of the contract
Returns:: Response

updateIngestContracts

@POST
 @Path(value="/contracts/{id}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response updateIngestContracts(@Context
                                                                                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                       @PathParam(value="id")
                                                                                                                                                                       String contractId,
                                                                                                                                                                       com.fasterxml.jackson.databind.JsonNode updateOptions)

Upload Access contracts

Parameters:: request - HTTP request; contractId - the id of ingest contract
Returns:: Response

uploadAccessContracts

@POST
 @Path(value="/accesscontracts")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response uploadAccessContracts(@Context
                                                                                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                InputStream input)

Upload Access contracts

Parameters:: request - HTTP request; input - the format file CSV
Returns:: Response

findAccessContracts

@POST
 @Path(value="/accesscontracts")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findAccessContracts(@Context
                                                                                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                      String select)

Query to get Access contracts

Parameters:: request - HTTP request; select - the query to find access contracts
Returns:: Response

findAccessContract

@GET
 @Path(value="/accesscontracts/{id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findAccessContract(@Context
                                                                                                                                                                         javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                         @PathParam(value="id")
                                                                                                                                                                         String id)

Query to Access contracts by id

Parameters:: request - HTTP request; id - of the requested access contract
Returns:: Response

updateAccessContracts

@POST
 @Path(value="/accesscontracts/{id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateAccessContracts(@Context
                                                                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                             @PathParam(value="id")
                                                                                                                                                                             String contractId,
                                                                                                                                                                             com.fasterxml.jackson.databind.JsonNode updateOptions)

Update Access contracts

Parameters:: request - HTTP request; contractId - the id of access contract
Returns:: Response

updateContexts

@POST
 @Path(value="/contexts/{id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateContexts(@Context
                                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                                               @PathParam(value="id")
                                                                                                                                                               String contextId,
                                                                                                                                                               com.fasterxml.jackson.databind.JsonNode updateOptions)

Update context

Parameters:: request - HTTP request; contextId - the id of context
Returns:: Response

uploadContext

@POST
 @Path(value="/contexts")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response uploadContext(@Context
                                                                                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                 InputStream input)

upload context

Parameters:: request - HTTP request; input - the file json
Returns:: Response

findContext

@POST
 @Path(value="/contexts")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findContext(@Context
                                                                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                                                                       String select)

Get contexts

Parameters:: request - HTTP request; select -
Returns:: Response

findContextByID

@GET
 @Path(value="/contexts/{id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findContextByID(@Context
                                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                                               @PathParam(value="id")
                                                                                                                                                               String id)

Get context by id

Parameters:: request - HTTP request; id -
Returns:: Response

createProfilesMetadata

@POST
 @Path(value="/profiles")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createProfilesMetadata(@Context
                                                                                                                                                                          javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                          InputStream input)
                                                                                                                                                                   throws IOException

Create profiles metadata

Parameters:: request - HTTP request; input - the format file CSV
Returns:: Response
Throws:: IOException

importProfileFile

@PUT
 @Path(value="/profiles/{id}")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response importProfileFile(@Context
                                                                                                                                                                         javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                         InputStream input,
                                                                                                                                                                         @PathParam(value="id")
                                                                                                                                                                         String id)

Upload profile xsd or rng

Parameters:: request - HTTP request; input - the format file CSV
Returns:: Response

updateProfile

@PUT
 @Path(value="/profiles/{id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateProfile(@Context
                                                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                                                             @PathParam(value="id")
                                                                                                                                                             String profileMetadataId,
                                                                                                                                                             com.fasterxml.jackson.databind.JsonNode updateOptions)

Update the detail of the profile

Parameters:: request - HTTP request; profileMetadataId -; updateOptions -
Returns:: Response

downloadProfileFile

@GET
 @Path(value="/profiles/{id}")
 @Produces(value="application/octet-stream")
public void downloadProfileFile(@Context
                                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                                 @PathParam(value="id")
                                                                                                                 String profileMetadataId,
                                                                                                                 @Suspended
                                                                                                                 javax.ws.rs.container.AsyncResponse asyncResponse)

findProfiles

@POST
 @Path(value="/profiles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findProfiles(@Context
                                                                                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                                                                                        String select)

Query to get profiles

Parameters:: request - HTTP request; select - the query to find access contracts
Returns:: Response

findProfileByID

@GET
 @Path(value="/profiles/{id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findProfileByID(@Context
                                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                                               @PathParam(value="id")
                                                                                                                                                               String id)

Query to Access contracts by id

Parameters:: request - HTTP request; id - of the requested access contract
Returns:: Response

checkOperationTraceability

@POST
 @Path(value="/traceability/check")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response checkOperationTraceability(@Context
                                                                                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                String operationCriteria)

Starts a TRACEABILITY check process

Parameters:: request - HTTP request; operationCriteria - a DSLQuery to find the TRACEABILITY operation to verify
Returns:: TRACEABILITY check process : the logbookOperation created during this process

downloadTraceabilityFile

@GET
 @Path(value="/traceability/{idOperation}/content")
 @Produces(value="application/octet-stream")
public void downloadTraceabilityFile(@Context
                                                                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                                                                           @PathParam(value="idOperation")
                                                                                                                                           String operationId,
                                                                                                                                           @QueryParam(value="contractId")
                                                                                                                                           String contractId,
                                                                                                                                           @QueryParam(value="tenantId")
                                                                                                                                           String tenantIdParam,
                                                                                                                                           @Suspended
                                                                                                                                           javax.ws.rs.container.AsyncResponse asyncResponse)

Download the Traceability Operation file

Parameters:: request - HTTP request; operationId - the TRACEABILITY operation identifier; contractId - the contractId; tenantIdParam - theTenantId; asyncResponse - the async response

extractTimeStampInformation

@POST
 @Path(value="/traceability/extractTimestamp")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response extractTimeStampInformation(String timestamp)

Extract information from timestamp

Parameters:: timestamp - the timestamp to be transformed
Returns:: Response

getWorkflowDefinitions

@GET
 @Path(value="/workflows")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getWorkflowDefinitions(@Context
                                                                                                                             javax.servlet.http.HttpServletRequest request)

launchAudit

@POST
 @Path(value="/audits")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response launchAudit(@Context
                                                                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                                                                     com.fasterxml.jackson.databind.JsonNode auditOption)

uploadServiceAgencies

@POST
 @Path(value="/agencies")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response uploadServiceAgencies(@Context
                                                                                                                                                                         javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                         InputStream input)

Upload Service Agencies

Parameters:: request - HTTP request; input - the Service Agency file CSV
Returns:: Response

findServiceAgencies

@POST
 @Path(value="/agencies")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findServiceAgencies(@Context
                                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                                               String select)

Find Service Agencies by DSL

Parameters:: request - HTTP request; select - the query to find Service Agency
Returns:: Response

findServiceAgencyById

@GET
 @Path(value="/agencies/{id:.+}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findServiceAgencyById(@Context
                                                                                                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                        @PathParam(value="id")
                                                                                                                                                                        String id)

Query to Service Agency by identifier

Parameters:: request - HTTP request; id - of the requested Service Agency
Returns:: Response

createDIPForExport

@POST
 @Path(value="/archiveunit/dipexport")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createDIPForExport(@Context
                                                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                                                      String criteria)

Send a queryDSL request in order to select some units and create a matching DIP

Parameters:: request - HTTP request; criteria - queryDSL for criteria

getDIPAsInputStreamAsync

@GET
 @Path(value="/archiveunit/dipexport/{id}")
 @Produces(value="application/octet-stream")
public void getDIPAsInputStreamAsync(@Context
                                                                                                                                   javax.servlet.http.HttpServletRequest request,
                                                                                                                                   @PathParam(value="id")
                                                                                                                                   String id,
                                                                                                                                   @Suspended
                                                                                                                                   javax.ws.rs.container.AsyncResponse asyncResponse)

Send a DIP id request in order to download the matching DIP

Parameters:: request - HTTP request; asyncResponse - request asynchronized response

getSecureMode

@GET
 @Path(value="/securemode")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getSecureMode()

Return authentication mode

Returns:: liste of authentication mode

getAdminTenant

@GET
 @Path(value="/admintenant")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAdminTenant()

Return admin tenant

Returns:: admin tenant number

Class WebApplicationResource

Field Summary

Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

Constructor Summary