fr.gouv.vitam.ihmrecette.appserver

Class WebApplicationResource

java.lang.Object

fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

fr.gouv.vitam.ihmrecette.appserver.WebApplicationResource

All Implemented Interfaces:

VitamResource

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

Web Application Resource class

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTRACT_NAME
static String	IHM_RECETTE field of VitamResponseError

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
WebApplicationResource(WebApplicationConfig webApplicationConfigonfig) Constructor

Method Summary

Modifier and Type	Method and Description
void	downloadObjectAsStream(String operationId, javax.ws.rs.container.AsyncResponse asyncResponse, String xTenantId)
void	downloadObjectAsStreamForBrowser(String operationId, javax.ws.rs.container.AsyncResponse asyncResponse, Integer tenantId) This method exist only to download a file with a browser
javax.ws.rs.core.Response	findAccessContract(javax.servlet.http.HttpServletRequest request, String select) Query to get Access contracts
javax.ws.rs.core.Response	getAndExecuteTestRequest(javax.servlet.http.HttpServletRequest request, String sessionId, com.fasterxml.jackson.databind.JsonNode criteria)
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) this method is used to request logbook with the Vitam DSL
javax.ws.rs.core.Response	getLogbookResultByBrowser(javax.servlet.http.HttpServletRequest request, String xhttpOverride, String sessionId, String options) Post used because Angular not support Get with body
javax.ws.rs.core.Response	getLogbookResultById(String operationId, String xTenantId)
javax.ws.rs.core.Response	getLogbookStatistics(String operationId) Generates the logbook operation statistics file (cvs format) relative to the operation parameter
javax.ws.rs.core.Response	getSecureMode() Return authentication mode
javax.ws.rs.core.Response	login(javax.servlet.http.HttpServletRequest httpRequest, com.fasterxml.jackson.databind.JsonNode object)
javax.ws.rs.core.Response	traceability(String xTenantId)
javax.ws.rs.core.Response	traceabilityLFC(String xTenantId) launch the traceabiity for lifecycles
javax.ws.rs.core.Response	traceabilityStorage(String xTenantId) launch the traceabiity for storage

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

IHM_RECETTE

public static final String IHM_RECETTE

field of VitamResponseError

See Also:

Constant Field Values

DEFAULT_CONTRACT_NAME

public static final String DEFAULT_CONTRACT_NAME

See Also:

Constant Field Values

Constructor Detail

WebApplicationResource

public WebApplicationResource(WebApplicationConfig webApplicationConfigonfig)

Constructor

Parameters:

webApplicationConfigonfig - configuration

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

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 httpRequest,
                                                                                                                                             com.fasterxml.jackson.databind.JsonNode object)

Parameters:

object - user credentials

Returns:

Response OK if login success

getLogbookStatistics

@GET
 @Path(value="/stat/{id_op}")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response getLogbookStatistics(@PathParam(value="id_op")
                                                                                                                        String operationId)

Generates the logbook operation statistics file (cvs format) relative to the operation parameter

Parameters:

operationId - logbook oeration id

Returns:

the statistics file (csv format)

getSecureMode

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

Return authentication mode

Returns:

liste of authentication mode

traceability

@POST
 @Path(value="/operations/traceability")
 @Produces(value="application/json")
public javax.ws.rs.core.Response traceability(@HeaderParam(value="X-Tenant-Id")
                                                                                                                                  String xTenantId)
                                                                                                                           throws LogbookClientServerException

Parameters:

xTenantId - the tenant id

Returns:

the response of the request

Throws:

LogbookClientServerException - if logbook internal resources exception occurred

traceabilityLFC

@POST
 @Path(value="/lifecycles/traceability")
 @Produces(value="application/json")
public javax.ws.rs.core.Response traceabilityLFC(@HeaderParam(value="X-Tenant-Id")
                                                                                                                                     String xTenantId)
                                                                                                                              throws LogbookClientServerException

launch the traceabiity for lifecycles

Parameters:

xTenantId - the tenant id

Returns:

the response of the request

Throws:

LogbookClientServerException - if logbook internal resources exception occurred

traceabilityStorage

@POST
 @Path(value="/storages/traceability")
 @Produces(value="application/json")
public javax.ws.rs.core.Response traceabilityStorage(@HeaderParam(value="X-Tenant-Id")
                                                                                                                                       String xTenantId)

launch the traceabiity for storage

Parameters:

xTenantId - the tenant id

Returns:

the response of the request

Throws:

LogbookClientServerException - if logbook internal resources exception occurred

getLogbookResultByBrowser

@POST
 @Path(value="/logbooks")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getLogbookResultByBrowser(@Context
                                                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                                                @HeaderParam(value="X-Http-Method-Override")
                                                                                                                                String xhttpOverride,
                                                                                                                                @CookieParam(value="JSESSIONID")
                                                                                                                                String sessionId,
                                                                                                                                String options)

Post used because Angular not support Get with body

Parameters:

request -

xhttpOverride - the use of http override POST method

sessionId - the id of session

options - the option for creating query to find logbook

Returns:

Response

getLogbookResult

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

this method is used to request logbook with the Vitam DSL

Parameters:

request - request http

sessionId - using for pagination

options - JSON object representing the Vitam DSL query

Returns:

Response

getLogbookResultById

@GET
 @Path(value="/logbooks/{idOperation}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getLogbookResultById(@PathParam(value="idOperation")
                                                                                                                                        String operationId,
                                                                                                                                        @HeaderParam(value="X-Tenant-Id")
                                                                                                                                        String xTenantId)

Parameters:

operationId - id of operation

xTenantId - the tenant id

Returns:

Response

downloadObjectAsStream

@GET
 @Path(value="/logbooks/{idOperation}")
 @Produces(value="application/octet-stream")
public void downloadObjectAsStream(@PathParam(value="idOperation")
                                                                                                                             String operationId,
                                                                                                                             @Suspended
                                                                                                                             javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                                                                             @QueryParam(value="X-Tenant-Id")
                                                                                                                             String xTenantId)

Parameters:

operationId - the operation id

asyncResponse - the asynchronized response

xTenantId - the tenant id

downloadObjectAsStreamForBrowser

@GET
 @Path(value="/logbooks/{idOperation}/content")
 @Produces(value="application/octet-stream")
public void downloadObjectAsStreamForBrowser(@PathParam(value="idOperation")
                                                                                                                                               String operationId,
                                                                                                                                               @Suspended
                                                                                                                                               javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                                                                                               @QueryParam(value="X-Tenant-Id")
                                                                                                                                               Integer tenantId)

This method exist only to download a file with a browser

Parameters:

operationId - the operation id

asyncResponse - the asynchronized response

tenantId - the working tenant

findAccessContract

@POST
 @Path(value="/accesscontracts")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findAccessContract(@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

getAndExecuteTestRequest

@POST
 @Path(value="/dslQueryTest")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAndExecuteTestRequest(@Context
                                                                                                                                   javax.servlet.http.HttpServletRequest request,
                                                                                                                                   @CookieParam(value="JSESSIONID")
                                                                                                                                   String sessionId,
                                                                                                                                   com.fasterxml.jackson.databind.JsonNode criteria)

Parameters:

request - request http

sessionId - json session id from shiro

criteria - criteria search for units

Returns:

Reponse