fr.gouv.vitam.functional.administration.rest

Class AdminManagementResource

java.lang.Object

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

fr.gouv.vitam.functional.administration.rest.AdminManagementResource

All Implemented Interfaces:

VitamResource

@Path(value="/adminmanagement/v1")
 @ApplicationPath(value="webresources")
public class AdminManagementResource
extends ApplicationStatusResource

FormatManagementResourceImpl implements AccessResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_LIST Audit actions constant
static String	AUDIT_TYPE Audit type constant
static String	OBJECT_ID Object id constant

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
AdminManagementResource(AdminManagementConfiguration configuration) Constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	checkFormat(InputStream xmlPronom) check the file format
javax.ws.rs.core.Response	checkRulesFile(InputStream rulesStream) check the rules file
javax.ws.rs.core.Response	createAccessionRegister(AccessionRegisterDetail accessionRegister) create or update an accession register
javax.ws.rs.core.Response	findDetailAccessionRegister(String documentId, com.fasterxml.jackson.databind.JsonNode select) retrieve accession register detail based on a given dsl query
javax.ws.rs.core.Response	findDocumentFundsRegister(com.fasterxml.jackson.databind.JsonNode select) retrieve all accession summary from accession summary collection
javax.ws.rs.core.Response	findDocumentRules(com.fasterxml.jackson.databind.JsonNode select) show all file rules inserted in the collection fileRules
javax.ws.rs.core.Response	findFileFormatByID(String formatId, javax.ws.rs.core.Request request) Find the file format detail related to a specified Id
javax.ws.rs.core.Response	findFormats(com.fasterxml.jackson.databind.JsonNode select) retrieve all the file format inserted in the collection fileFormat
javax.ws.rs.core.Response	findRuleByID(String ruleId, javax.ws.rs.core.Request request) findRuleByID : find the rules details based on a given Id
javax.ws.rs.core.Response	importFormat(javax.ws.rs.core.HttpHeaders headers, InputStream xmlPronom) import the file format
javax.ws.rs.core.Response	importRulesFile(javax.ws.rs.core.HttpHeaders headers, InputStream rulesStream) import the rules file
javax.ws.rs.core.Response	launchAudit(com.fasterxml.jackson.databind.JsonNode options) Launch audit with options
javax.ws.rs.core.Response	launchRuleAudit()
void	setVitamCounterService(VitamCounterService vitamCounterService)

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

AUDIT_TYPE

public static final String AUDIT_TYPE

Audit type constant

See Also:

Constant Field Values

OBJECT_ID

public static final String OBJECT_ID

Object id constant

See Also:

Constant Field Values

ACTION_LIST

public static final String ACTION_LIST

Audit actions constant

See Also:

Constant Field Values

Constructor Detail

AdminManagementResource

public AdminManagementResource(AdminManagementConfiguration configuration)

Constructor

Parameters:

configuration - config for constructing AdminManagement

Method Detail

checkFormat

@Path(value="format/check")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response checkFormat(InputStream xmlPronom)

check the file format

Parameters:

xmlPronom - as InputStream

Returns:

Response response

importFormat

@Path(value="format/import")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response importFormat(@Context
                                                                                                                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                    InputStream xmlPronom)

import the file format

Parameters:

headers - http headers

xmlPronom - as InputStream

Returns:

Response jersey response

findFileFormatByID

@GET
 @Path(value="format/{id_format:.+}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findFileFormatByID(@PathParam(value="id_format")
                                                                                                                                    String formatId,
                                                                                                                                    @Context
                                                                                                                                    javax.ws.rs.core.Request request)

Find the file format detail related to a specified Id

Parameters:

formatId - path param as String

request -

Returns:

Response jersey response

findFormats

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

retrieve all the file format inserted in the collection fileFormat

Parameters:

select - as String the query to get format

Returns:

Response jersey Response

checkRulesFile

@Path(value="rules/check")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response checkRulesFile(InputStream rulesStream)

check the rules file

Parameters:

rulesStream - as InputStream

Returns:

Response response jersey

importRulesFile

@Path(value="rules/import")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response importRulesFile(@Context
                                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                      InputStream rulesStream)

import the rules file

Parameters:

headers - http headers

rulesStream - as InputStream

Returns:

Response jersey response

findRuleByID

@GET
 @Path(value="rules/{id_rule}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findRuleByID(@PathParam(value="id_rule")
                                                                                                                        String ruleId,
                                                                                                                        @Context
                                                                                                                        javax.ws.rs.core.Request request)

findRuleByID : find the rules details based on a given Id

Parameters:

ruleId - path param as String

request - the request

Returns:

Response jersey response

findDocumentRules

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

show all file rules inserted in the collection fileRules

Parameters:

select - as String

Returns:

Response jersey Response

createAccessionRegister

@Path(value="accession-register")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createAccessionRegister(AccessionRegisterDetail accessionRegister)

create or update an accession register

Parameters:

accessionRegister - AccessionRegisterDetail object

Returns:

Response jersey response

findDocumentFundsRegister

@Path(value="accession-register/document")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findDocumentFundsRegister(com.fasterxml.jackson.databind.JsonNode select)

retrieve all accession summary from accession summary collection

Parameters:

select - as String the query to find accession register

Returns:

Response jersey Response

findDetailAccessionRegister

@Path(value="accession-register/detail/{id}")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findDetailAccessionRegister(@PathParam(value="id")
                                                                                                                                                                                            String documentId,
                                                                                                                                                                                            com.fasterxml.jackson.databind.JsonNode select)

retrieve accession register detail based on a given dsl query

Parameters:

documentId -

select - as String the query to find the accession register

Returns:

Response jersey Response

launchRuleAudit

@Path(value="/auditRule")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response launchRuleAudit()

launchAudit

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

Launch audit with options

Parameters:

options -

Returns:

Response jersey response

setVitamCounterService

public void setVitamCounterService(VitamCounterService vitamCounterService)

Parameters:

vitamCounterService -