fr.gouv.vitam.access.internal.rest

Class AccessInternalResourceImpl

java.lang.Object

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

fr.gouv.vitam.access.internal.rest.AccessInternalResourceImpl

All Implemented Interfaces:

AccessInternalResource, VitamResource

@Path(value="/access-internal/v1")
public class AccessInternalResourceImpl
extends ApplicationStatusResource
implements AccessInternalResource

AccessResourceImpl implements AccessResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPORT_DIP
static String	UNITS

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
AccessInternalResourceImpl(AccessInternalConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportDIP(com.fasterxml.jackson.databind.JsonNode queryDsl) get Archive Unit list by query based on identifier
javax.ws.rs.core.Response	findDIPByID(String id)
javax.ws.rs.core.Response	getObjectByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode dslQuery, String objectId) gets object group by Id with Json query
javax.ws.rs.core.Response	getObjectByUnitIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode queryDsl, String idUnit) gets object group by Id with Json query
javax.ws.rs.core.Response	getObjectGroup(String idObjectGroup, com.fasterxml.jackson.databind.JsonNode query) Retrieve an ObjectGroup by its id
javax.ws.rs.core.Response	getObjectStreamAsync(javax.ws.rs.core.HttpHeaders headers, String idObjectGroup) Retrieve an Object associated to the given ObjectGroup id based on given (via headers) Qualifier and Version (Async version)
javax.ws.rs.core.Response	getUnitById(com.fasterxml.jackson.databind.JsonNode queryDsl, String idUnit) get Archive Unit list by query based on identifier
javax.ws.rs.core.Response	getUnitByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode queryDsl, String idUnit) gets archive units by Id with Json query
javax.ws.rs.core.Response	getUnits(com.fasterxml.jackson.databind.JsonNode queryDsl) get Archive Unit list by query based on identifier
javax.ws.rs.core.Response	updateUnitById(com.fasterxml.jackson.databind.JsonNode queryDsl, String idUnit, String requestId) 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

Field Detail

EXPORT_DIP

public static final String EXPORT_DIP

See Also:

Constant Field Values

UNITS

public static final String UNITS

See Also:

Constant Field Values

Constructor Detail

AccessInternalResourceImpl

public AccessInternalResourceImpl(AccessInternalConfiguration configuration)

Parameters:

configuration - to associate with AccessResourceImpl

Method Detail

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 queryDsl)
                                                                                                                                         throws MetaDataDocumentSizeException,
                                                                                                                                                MetaDataExecutionException,
                                                                                                                                                MetaDataClientServerException

get Archive Unit list by query based on identifier

Specified by:

getUnits in interface AccessInternalResource

Parameters:

queryDsl - as JsonNode

Returns:

an archive unit result list

Throws:

MetaDataDocumentSizeException

MetaDataExecutionException

MetaDataClientServerException

exportDIP

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

get Archive Unit list by query based on identifier

Specified by:

exportDIP in interface AccessInternalResource

Parameters:

queryDsl - as JsonNode

Returns:

an archive unit result list

findDIPByID

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

Specified by:

findDIPByID in interface AccessInternalResource

Parameters:

id - of operation (X-Request-Id)

Returns:

getUnitById

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

get Archive Unit list by query based on identifier

Specified by:

getUnitById in interface AccessInternalResource

Parameters:

queryDsl - as JsonNode

idUnit - identifier

Returns:

an archive unit result list

getUnitByIdWithXMLFormat

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

Description copied from interface: AccessInternalResource

gets archive units by Id with Json query

Specified by:

getUnitByIdWithXMLFormat in interface AccessInternalResource

Parameters:

queryDsl - DSL, null not allowed

idUnit - units identifier

Returns:

a archive unit result list on xml format

updateUnitById

@PUT
 @Path(value="/units/{id_unit}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateUnitById(com.fasterxml.jackson.databind.JsonNode queryDsl,
                                                                                                                                                                @PathParam(value="id_unit")
                                                                                                                                                                String idUnit,
                                                                                                                                                                @HeaderParam(value="X-Request-Id")
                                                                                                                                                                String requestId)

update archive units by Id with Json query

Specified by:

updateUnitById in interface AccessInternalResource

Parameters:

requestId - request identifier

queryDsl - DSK, null not allowed

idUnit - units identifier

Returns:

a archive unit result list

getObjectGroup

@GET
 @Path(value="/objects/{id_object_group}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectGroup(@PathParam(value="id_object_group")
                                                                                                                                                                          String idObjectGroup,
                                                                                                                                                                          com.fasterxml.jackson.databind.JsonNode query)

Description copied from interface: AccessInternalResource

Retrieve an ObjectGroup by its id

Specified by:

getObjectGroup in interface AccessInternalResource

Parameters:

idObjectGroup - the ObjectGroup id

query - the json query

Returns:

an http response containing the objectGroup as json or a json serialized error

getObjectByIdWithXMLFormat

@GET
 @Path(value="/objects/{id_object_group}")
 @Consumes(value="application/json")
 @Produces(value="application/xml")
public javax.ws.rs.core.Response getObjectByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode dslQuery,
                                                                                                                                                                                     @PathParam(value="id_object_group")
                                                                                                                                                                                     String objectId)

Description copied from interface: AccessInternalResource

gets object group by Id with Json query

Specified by:

getObjectByIdWithXMLFormat in interface AccessInternalResource

Parameters:

dslQuery - DSL, null not allowed

objectId - units identifier

Returns:

an object group result list on xml format

getObjectByUnitIdWithXMLFormat

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

Description copied from interface: AccessInternalResource

gets object group by Id with Json query

Specified by:

getObjectByUnitIdWithXMLFormat in interface AccessInternalResource

Parameters:

queryDsl - DSL, null not allowed

idUnit - units identifier

Returns:

an object group result list on xml format

getObjectStreamAsync

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

Description copied from interface: AccessInternalResource

Retrieve an Object associated to the given ObjectGroup id based on given (via headers) Qualifier and Version (Async version)

Specified by:

getObjectStreamAsync in interface AccessInternalResource

Returns:

response