fr.gouv.vitam.access.external.rest

Class AccessExternalResource

java.lang.Object

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

fr.gouv.vitam.access.external.rest.AccessExternalResource

All Implemented Interfaces:

VitamResource

@Path(value="/access-external/v1")
public class AccessExternalResource
extends ApplicationStatusResource

Access External Resource

Field Summary

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
AccessExternalResource(SecureEndpointRegistry secureEndpointRegistry) Constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportDIP(DipExportRequest dipExportRequest) get units list by query
javax.ws.rs.core.Response	findDIPByID(String id) get units list by query
javax.ws.rs.core.Response	getAccessLog(com.fasterxml.jackson.databind.JsonNode params)
javax.ws.rs.core.Response	getDataObjectByUnitId(javax.ws.rs.core.HttpHeaders headers, String unitId) The caller is responsible to close the Response after consuming the inputStream.
javax.ws.rs.core.Response	getObjectGroupMetadataByUnitId(javax.ws.rs.core.HttpHeaders headers, String unitId, com.fasterxml.jackson.databind.JsonNode queryJson) Retrieve Object group list by query based on identifier of the unit
javax.ws.rs.core.Response	getObjects(com.fasterxml.jackson.databind.JsonNode queryJson) get Objects group list based on DSL query
javax.ws.rs.core.Response	getUnitById(com.fasterxml.jackson.databind.JsonNode queryJson, String idUnit) get units list by query based on identifier
javax.ws.rs.core.Response	getUnits(com.fasterxml.jackson.databind.JsonNode queryJson) get a DIP by dsl query
javax.ws.rs.core.Response	listResourceEndpoints() List secured resource end points
javax.ws.rs.core.Response	massUpdateUnits(com.fasterxml.jackson.databind.JsonNode queryJson) Mass update of archive units with json query.
javax.ws.rs.core.Response	massUpdateUnitsRules(MassUpdateUnitRuleRequest massUpdateUnitRuleRequest) Mass update of archive units rules with json request.
javax.ws.rs.core.Response	reclassification(com.fasterxml.jackson.databind.JsonNode queryJson) Performs a reclassification workflow.
javax.ws.rs.core.Response	selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode queryJson) Select units with inherited rules
javax.ws.rs.core.Response	startEliminationAction(EliminationRequestBody eliminationRequestBody) Performs an elimination action workflow.
javax.ws.rs.core.Response	startEliminationAnalysis(EliminationRequestBody eliminationRequestBody) Performs an elimination analysis workflow.
javax.ws.rs.core.Response	updateUnitById(com.fasterxml.jackson.databind.JsonNode queryJson, String idUnit) update archive units by Id with Json query

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

Constructor Detail

AccessExternalResource

public AccessExternalResource(SecureEndpointRegistry secureEndpointRegistry)

Constructor

Parameters:

secureEndpointRegistry - endpoint list registry

Method Detail

listResourceEndpoints

@Path(value="/")
 @OPTIONS
 @Produces(value="application/json")
public javax.ws.rs.core.Response listResourceEndpoints()

List secured resource end points

Returns:

response

getUnits

@GET
 @Path(value="/units")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getUnits(com.fasterxml.jackson.databind.JsonNode queryJson)

get a DIP by dsl query

Parameters:

queryJson - the query to get units

Returns:

Response

exportDIP

@POST
 @Path(value="/dipexport")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response exportDIP(DipExportRequest dipExportRequest)

get units list by query

Parameters:

dipExportRequest - the query to get units

Returns:

Response

reclassification

@POST
 @Path(value="/reclassification")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response reclassification(com.fasterxml.jackson.databind.JsonNode queryJson)

Performs a reclassification workflow.

Parameters:

queryJson - List of reclassification DSL queries.

Returns:

Response

startEliminationAnalysis

@POST
 @Path(value="/elimination/analysis")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response startEliminationAnalysis(EliminationRequestBody eliminationRequestBody)

Performs an elimination analysis workflow.

Parameters:

eliminationRequestBody - object that contain dsl request and a given date.

Returns:

Response

startEliminationAction

@POST
 @Path(value="/elimination/action")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response startEliminationAction(EliminationRequestBody eliminationRequestBody)

Performs an elimination action workflow.

Parameters:

eliminationRequestBody - object that contain dsl request and a given date.

Returns:

Response

findDIPByID

@GET
 @Path(value="/dipexport/{id}/dip")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response findDIPByID(@PathParam(value="id")
                                                                                                                                   String id)

get units list by query

Parameters:

id - operationId correponding to the current dip

Returns:

Response

getUnitById

@GET
 @Path(value="/units/{idu}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getUnitById(com.fasterxml.jackson.databind.JsonNode queryJson,
                                                                                                                                                         @PathParam(value="idu")
                                                                                                                                                         String idUnit)

get units list by query based on identifier

Parameters:

queryJson - query as String

idUnit - the id of archive unit to get

Returns:

Archive Unit

updateUnitById

@PUT
 @Path(value="/units/{idu}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateUnitById(com.fasterxml.jackson.databind.JsonNode queryJson,
                                                                                                                                                            @PathParam(value="idu")
                                                                                                                                                            String idUnit)

update archive units by Id with Json query

Parameters:

queryJson - the update query (null not allowed)

idUnit - units identifier

Returns:

a archive unit result list

getObjectGroupMetadataByUnitId

@GET
 @Path(value="/units/{idu}/objects")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectGroupMetadataByUnitId(@Context
                                                                                                                                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                    @PathParam(value="idu")
                                                                                                                                                                                    String unitId,
                                                                                                                                                                                    com.fasterxml.jackson.databind.JsonNode queryJson)

Retrieve Object group list by query based on identifier of the unit

Parameters:

headers - the http header defined parameters of request

unitId - the id of archive unit

queryJson - the query to get object

Returns:

Response

getDataObjectByUnitId

@GET
 @Path(value="/units/{idu}/objects")
 @Consumes(value="application/json")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getDataObjectByUnitId(@Context
                                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                   @PathParam(value="idu")
                                                                                                                                                                                   String unitId)

The caller is responsible to close the Response after consuming the inputStream.

Parameters:

headers - the http header defined parameters of request

unitId - the id of archive unit

Returns:

response

massUpdateUnits

@POST
 @Path(value="/units")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response massUpdateUnits(com.fasterxml.jackson.databind.JsonNode queryJson)

Mass update of archive units with json query.

Parameters:

queryJson - the mass_update query (null not allowed)

Returns:

massUpdateUnitsRules

@POST
 @Path(value="/units/rules")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response massUpdateUnitsRules(MassUpdateUnitRuleRequest massUpdateUnitRuleRequest)
                                                                                                                                                            throws InvalidParseOperationException

Mass update of archive units rules with json request.

Parameters:

massUpdateUnitRuleRequest - the mass update rules request (null not allowed)

Returns:

Throws:

InvalidParseOperationException

selectUnitsWithInheritedRules

@GET
 @Path(value="/unitsWithInheritedRules")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode queryJson)

Select units with inherited rules

Parameters:

queryJson - the query to get units

Returns:

Response

getObjects

@GET
 @Path(value="/objects")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjects(com.fasterxml.jackson.databind.JsonNode queryJson)

get Objects group list based on DSL query

Parameters:

queryJson - the query to get units

Returns:

Response

getAccessLog

@Path(value="/storageaccesslog")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getAccessLog(com.fasterxml.jackson.databind.JsonNode params)