fr.gouv.vitam.functional.administration.rest

Class ProfileResource

java.lang.Object

fr.gouv.vitam.functional.administration.rest.ProfileResource

@Path(value="/adminmanagement/v1")
 @ApplicationPath(value="webresources")
public class ProfileResource
extends Object

This resource manage profiles create, update, find, ...

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROFILE_URI
static String	UPDATE_PROFIL_URI

Constructor Summary

Constructors

Constructor and Description
ProfileResource(AdminManagementConfiguration configuration, MongoDbAccessAdminImpl mongoAccess, VitamCounterService vitamCounterService, FunctionalBackupService functionalBackupService)
ProfileResource(WorkspaceClientFactory workspaceClientFactory, MongoDbAccessAdminImpl mongoAccess, VitamCounterService vitamCounterService, FunctionalBackupService functionalBackupService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createProfiles(List<ProfileModel> profileModelList, javax.ws.rs.core.UriInfo uri) Import a set of profiles.
javax.ws.rs.core.Response	downloadProfileFile(String profileMetadataId)
javax.ws.rs.core.Response	findProfiles(com.fasterxml.jackson.databind.JsonNode queryDsl) Find profiles by queryDsl
javax.ws.rs.core.Response	importProfileFile(javax.ws.rs.core.UriInfo uri, String profileMetadataId, InputStream profileFile) Import a Profile file document (xsd or rng, ...)
javax.ws.rs.core.Response	updateProfileFile(String profileMetadataId, com.fasterxml.jackson.databind.JsonNode queryDsl) Update the detail of the profile

Methods inherited from class java.lang.Object

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

Field Detail

PROFILE_URI

public static final String PROFILE_URI

See Also:

Constant Field Values

UPDATE_PROFIL_URI

public static final String UPDATE_PROFIL_URI

See Also:

Constant Field Values

Constructor Detail

ProfileResource

public ProfileResource(AdminManagementConfiguration configuration,
                       MongoDbAccessAdminImpl mongoAccess,
                       VitamCounterService vitamCounterService,
                       FunctionalBackupService functionalBackupService)

Parameters:

configuration -

mongoAccess -

vitamCounterService -

ProfileResource

public ProfileResource(WorkspaceClientFactory workspaceClientFactory,
                       MongoDbAccessAdminImpl mongoAccess,
                       VitamCounterService vitamCounterService,
                       FunctionalBackupService functionalBackupService)

Method Detail

createProfiles

@Path(value="/profiles")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createProfiles(List<ProfileModel> profileModelList,
                                                                                                                                                          @Context
                                                                                                                                                          javax.ws.rs.core.UriInfo uri)

Import a set of profiles. If all the profiles are valid, they will be stored in the collection and indexed.
The input is invalid in the following situations :

• The json is invalid
• The json contains 2 ore many profiles having the same identifier
• One or more mandatory field is missing
• A field has an invalid format
• One or many profile already exist in the database

Parameters:

profileModelList - as InputStream

uri - the uri info

Returns:

Response jersey response

importProfileFile

@Path(value="/profiles/{id}")
 @PUT
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response importProfileFile(@Context
                                                                                                                                                                         javax.ws.rs.core.UriInfo uri,
                                                                                                                                                                         @PathParam(value="id")
                                                                                                                                                                         String profileMetadataId,
                                                                                                                                                                         InputStream profileFile)

Import a Profile file document (xsd or rng, ...)

Parameters:

uri - used to construct the created resource and send it back as location in the response

profileMetadataId - id of the profile metadata

profileFile - inputStream representing the data to import

Returns:

The jersey Response

updateProfileFile

@Path(value="/profiles/{id}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateProfileFile(@PathParam(value="id")
                                                                                                                                                                 String profileMetadataId,
                                                                                                                                                                 com.fasterxml.jackson.databind.JsonNode queryDsl)

Update the detail of the profile

Parameters:

profileMetadataId -

queryDsl -

Returns:

Response

downloadProfileFile

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

findProfiles

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

Find profiles by queryDsl

Parameters:

queryDsl -

Returns:

Response