fr.gouv.vitam.ihmdemo.core

Class UserInterfaceTransactionManager

java.lang.Object

fr.gouv.vitam.ihmdemo.core.UserInterfaceTransactionManager

public class UserInterfaceTransactionManager
extends Object

Manage all the transactions received form the User Interface : a gateway to VITAM intern

Constructor Summary

Constructors

Constructor and Description
UserInterfaceTransactionManager()

Method Summary

Modifier and Type	Method and Description
static RequestResponse<com.fasterxml.jackson.databind.JsonNode>	checkTraceabilityOperation(com.fasterxml.jackson.databind.JsonNode query, VitamContext context) Starts a Verification process based on a given DSLQuery
static boolean	downloadDIP(javax.ws.rs.container.AsyncResponse asyncResponse, String dipId, VitamContext context)
static RequestResponse<com.fasterxml.jackson.databind.JsonNode>	exportDIP(com.fasterxml.jackson.databind.JsonNode query, VitamContext context) generate a DIP to be exported
static com.fasterxml.jackson.databind.JsonNode	extractInformationFromTimestamp(String timestamp) Extract information from timestamp
static RequestResponse<com.fasterxml.jackson.databind.JsonNode>	findAccessionRegisterDetail(String id, String options, VitamContext context)
static RequestResponse<AccessionRegisterSummaryModel>	findAccessionRegisterSummary(String options, VitamContext context)
static String	getAppSessionId() Returns session id for the authenticated user.
static RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getArchiveUnitDetails(com.fasterxml.jackson.databind.JsonNode preparedDslQuery, String unitId, VitamContext context) Gets archive unit details
static String	getContractId(javax.servlet.http.HttpServletRequest request)
static boolean	getObjectAsInputStream(javax.ws.rs.container.AsyncResponse asyncResponse, String unitId, String usage, int version, String filename, VitamContext context) Retrieve an Object data as an input stream
static String	getPersonalCertificate(javax.servlet.http.HttpServletRequest request)
static Integer	getTenantId(javax.servlet.http.HttpServletRequest request)
static VitamContext	getVitamContext(javax.servlet.http.HttpServletRequest request)
static VitamContext	getVitamContext(Integer tenantId, String contractId, javax.servlet.http.HttpServletRequest request)
static VitamContext	getVitamContext(Integer tenantId, String contractId, String personalCert)
static RequestResponse<com.fasterxml.jackson.databind.JsonNode>	searchUnits(com.fasterxml.jackson.databind.JsonNode parameters, VitamContext context) Gets search units result
static RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectObjectbyId(com.fasterxml.jackson.databind.JsonNode preparedDslQuery, String objectId, VitamContext context) Retrieve an ObjectGroup as Json data based on the provided ObjectGroup id
static RequestResponse<LogbookLifecycle>	selectObjectGroupLifeCycleById(String objectGroupLifeCycleId, VitamContext context)
static RequestResponse<LogbookOperation>	selectOperation(com.fasterxml.jackson.databind.JsonNode query, VitamContext context)
static RequestResponse<LogbookOperation>	selectOperationbyId(String operationId, VitamContext context)
static RequestResponse<LogbookLifecycle>	selectUnitLifeCycleById(String unitLifeCycleId, VitamContext context)
static RequestResponse<com.fasterxml.jackson.databind.JsonNode>	updateUnits(com.fasterxml.jackson.databind.JsonNode parameters, String unitId, VitamContext context) Update units result

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserInterfaceTransactionManager

public UserInterfaceTransactionManager()

Method Detail

searchUnits

public static RequestResponse<com.fasterxml.jackson.databind.JsonNode> searchUnits(com.fasterxml.jackson.databind.JsonNode parameters,
                                                                                   VitamContext context)
                                                                            throws VitamClientException

Gets search units result

Parameters:

parameters - search criteria as DSL query

context - Vitamcontext

Returns:

result

Throws:

VitamClientException - access client exception

getArchiveUnitDetails

public static RequestResponse<com.fasterxml.jackson.databind.JsonNode> getArchiveUnitDetails(com.fasterxml.jackson.databind.JsonNode preparedDslQuery,
                                                                                             String unitId,
                                                                                             VitamContext context)
                                                                                      throws VitamClientException

Gets archive unit details

Parameters:

preparedDslQuery - search criteria as DSL query

unitId - archive unit id to find

context - Vitamcontext

Returns:

result

Throws:

VitamClientException - access client exception

updateUnits

public static RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnits(com.fasterxml.jackson.databind.JsonNode parameters,
                                                                                   String unitId,
                                                                                   VitamContext context)
                                                                            throws VitamClientException

Update units result

Parameters:

parameters - search criteria as DSL query

unitId - unitIdentifier

context - Vitamcontext

Returns:

result

Throws:

VitamClientException

selectObjectbyId

public static RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectObjectbyId(com.fasterxml.jackson.databind.JsonNode preparedDslQuery,
                                                                                        String objectId,
                                                                                        VitamContext context)
                                                                                 throws VitamClientException

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

Parameters:

preparedDslQuery - the query to be executed

objectId - the Id of the ObjectGroup

context - Vitamcontext

Returns:

JsonNode object including DSL queries, context and results

Throws:

VitamClientException - if the client encountered an exception

getObjectAsInputStream

public static boolean getObjectAsInputStream(javax.ws.rs.container.AsyncResponse asyncResponse,
                                             String unitId,
                                             String usage,
                                             int version,
                                             String filename,
                                             VitamContext context)
                                      throws UnsupportedEncodingException,
                                             VitamClientException

Retrieve an Object data as an input stream

Parameters:

asyncResponse - the asynchronous response to be used

unitId - the Id of the ObjectGroup

usage - the requested usage

version - the requested version of the usage

filename - the name od the file

context - Vitamcontext

Returns:

boolean for test purpose (solve mock issue)

Throws:

UnsupportedEncodingException - if unsupported encoding error for input file content

VitamClientException - if the client encountered an exception

selectUnitLifeCycleById

public static RequestResponse<LogbookLifecycle> selectUnitLifeCycleById(String unitLifeCycleId,
                                                                        VitamContext context)
                                                                 throws VitamClientException

Parameters:

unitLifeCycleId - the unit lifecycle id to select

context - Vitamcontext

Returns:

JsonNode result

Throws:

InvalidParseOperationException - if json data not well-formed

LogbookClientException - if the request with illegal parameter

AccessUnauthorizedException

VitamClientException

selectOperation

public static RequestResponse<LogbookOperation> selectOperation(com.fasterxml.jackson.databind.JsonNode query,
                                                                VitamContext context)
                                                         throws VitamClientException

Parameters:

query - the select query

context - Vitamcontext

Returns:

logbook operation result

Throws:

VitamClientException - access client exception

selectOperationbyId

public static RequestResponse<LogbookOperation> selectOperationbyId(String operationId,
                                                                    VitamContext context)
                                                             throws VitamClientException

Parameters:

operationId - the operation id

context - Vitamcontext

Returns:

logbook operation result

Throws:

VitamClientException

selectObjectGroupLifeCycleById

public static RequestResponse<LogbookLifecycle> selectObjectGroupLifeCycleById(String objectGroupLifeCycleId,
                                                                               VitamContext context)
                                                                        throws VitamClientException

Parameters:

objectGroupLifeCycleId - the object lifecycle id to select* @param context Vitamcontext http

Returns:

logbook lifecycle result

Throws:

VitamClientException - if the request with illegal parameter

findAccessionRegisterSummary

public static RequestResponse<AccessionRegisterSummaryModel> findAccessionRegisterSummary(String options,
                                                                                          VitamContext context)
                                                                                   throws VitamClientException,
                                                                                          InvalidParseOperationException,
                                                                                          InvalidCreateOperationException

Parameters:

options - for creating query

context - Vitamcontext

Returns:

AccessionRegisterSummaryModel result

Throws:

VitamClientException - if the request with illegal parameter

InvalidParseOperationException - if json data not well-formed

InvalidCreateOperationException - if error when create query

findAccessionRegisterDetail

public static RequestResponse<com.fasterxml.jackson.databind.JsonNode> findAccessionRegisterDetail(String id,
                                                                                                   String options,
                                                                                                   VitamContext context)
                                                                                            throws InvalidParseOperationException,
                                                                                                   AccessExternalClientServerException,
                                                                                                   AccessExternalClientNotFoundException,
                                                                                                   InvalidCreateOperationException,
                                                                                                   AccessUnauthorizedException

Parameters:

id - the id of accession register

options - for creating query

context - Vitamcontext

Returns:

JsonNode result

Throws:

InvalidParseOperationException - if json data not well-formed

AccessExternalClientServerException - if access internal server error

AccessExternalClientNotFoundException - if access external resource not found

InvalidCreateOperationException - if error when create query

AccessUnauthorizedException

checkTraceabilityOperation

public static RequestResponse<com.fasterxml.jackson.databind.JsonNode> checkTraceabilityOperation(com.fasterxml.jackson.databind.JsonNode query,
                                                                                                  VitamContext context)
                                                                                           throws AccessExternalClientServerException,
                                                                                                  InvalidParseOperationException,
                                                                                                  AccessUnauthorizedException

Starts a Verification process based on a given DSLQuery

Parameters:

query - DSLQuery to execute

context - Vitamcontext

Returns:

A RequestResponse contains the created logbookOperation for verification process

Throws:

AccessExternalClientServerException

InvalidParseOperationException

AccessUnauthorizedException

extractInformationFromTimestamp

public static com.fasterxml.jackson.databind.JsonNode extractInformationFromTimestamp(String timestamp)
                                                                               throws BadRequestException

Extract information from timestamp

Parameters:

timestamp - the timestamp to be used for extraction

Returns:

json node containing genTime and issuer certificate information

Throws:

BadRequestException - if the timestamp cant be extracted

exportDIP

public static RequestResponse<com.fasterxml.jackson.databind.JsonNode> exportDIP(com.fasterxml.jackson.databind.JsonNode query,
                                                                                 VitamContext context)
                                                                          throws InvalidParseOperationException,
                                                                                 VitamClientException

generate a DIP to be exported

Parameters:

query - search criteria as DSL query

context - VitamContext

Returns:

a JsonNode for dip results

Throws:

InvalidParseOperationException - unable to parse query

VitamClientException - access client exception

downloadDIP

public static boolean downloadDIP(javax.ws.rs.container.AsyncResponse asyncResponse,
                                  String dipId,
                                  VitamContext context)
                           throws UnsupportedEncodingException,
                                  VitamClientException

Parameters:

asyncResponse - AsyncResponse

dipId - dip id

context - vitam context

Returns:

Throws:

UnsupportedEncodingException

VitamClientException

getVitamContext

public static VitamContext getVitamContext(javax.servlet.http.HttpServletRequest request)

getVitamContext

public static VitamContext getVitamContext(Integer tenantId,
                                           String contractId,
                                           String personalCert)

getVitamContext

public static VitamContext getVitamContext(Integer tenantId,
                                           String contractId,
                                           javax.servlet.http.HttpServletRequest request)

getPersonalCertificate

public static String getPersonalCertificate(javax.servlet.http.HttpServletRequest request)

getContractId

public static String getContractId(javax.servlet.http.HttpServletRequest request)

getTenantId

public static Integer getTenantId(javax.servlet.http.HttpServletRequest request)

getAppSessionId

public static String getAppSessionId()

Returns session id for the authenticated user.

The application may track each logged user by a unique session id. This session id is passed to vitam and is persisted "as is" in Vitam logbook operations. In case of audit / legal dispute, the application session id can be used for correlation with application user login logs / db.

Returns:

application session id