Interface AccessExternalClient

    • Method Detail

      • selectUnits

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnits​(VitamContext vitamContext,
                                                                             com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                                      throws VitamClientException
        selectUnits /units
        Parameters:
        vitamContext - the vitam context
        selectQuery - the select query
        Returns:
        Json representation
        Throws:
        VitamClientException
      • selectUnitbyId

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitbyId​(VitamContext vitamContext,
                                                                                com.fasterxml.jackson.databind.JsonNode selectQuery,
                                                                                java.lang.String unitId)
                                                                         throws VitamClientException
        selectUnitbyId GET(POST overrided) /units/{id}
        Parameters:
        vitamContext - the vitam context
        selectQuery - the select query
        unitId - the unit id to select
        Returns:
        Json representation
        Throws:
        VitamClientException
      • updateUnitbyId

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnitbyId​(VitamContext vitamContext,
                                                                                com.fasterxml.jackson.databind.JsonNode updateQuery,
                                                                                java.lang.String unitId)
                                                                         throws VitamClientException
        updateUnitbyId UPDATE /units/{id}
        Parameters:
        vitamContext - the vitam context
        updateQuery - the update query
        unitId - the unit id to update
        Returns:
        Json representation
        Throws:
        VitamClientException
      • selectObjectMetadatasByUnitId

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectObjectMetadatasByUnitId​(VitamContext vitamContext,
                                                                                               com.fasterxml.jackson.databind.JsonNode selectQuery,
                                                                                               java.lang.String unitId)
                                                                                        throws VitamClientException
        selectObjectById
        Parameters:
        vitamContext - the vitam context
        selectQuery - the select query
        unitId - the unit id for getting object
        Returns:
        Json representation
        Throws:
        VitamClientException
      • selectUnitLifeCycleById

        RequestResponse<LogbookLifecycle> selectUnitLifeCycleById​(VitamContext vitamContext,
                                                                  java.lang.String unitLifeCycleId,
                                                                  com.fasterxml.jackson.databind.JsonNode select)
                                                           throws VitamClientException
        selectUnitLifeCycleById
        Parameters:
        vitamContext - the vitam context
        unitLifeCycleId - the unit LFC id
        select - the select query
        Returns:
        logbooklifecycle representation
        Throws:
        VitamClientException
      • selectObjectGroupLifeCycleById

        RequestResponse<LogbookLifecycle> selectObjectGroupLifeCycleById​(VitamContext vitamContext,
                                                                         java.lang.String objectGroupLifeCycleId,
                                                                         com.fasterxml.jackson.databind.JsonNode select)
                                                                  throws VitamClientException
        selectObjectGroupLifeCycleById
        Parameters:
        vitamContext - the vitam context
        objectGroupLifeCycleId - the objectGroup LFC id
        select - the select query
        Returns:
        logbooklifecycle representation
        Throws:
        VitamClientException
      • getDIPById

        javax.ws.rs.core.Response getDIPById​(VitamContext vitamContext,
                                             java.lang.String dipId)
                                      throws VitamClientException
        getDIPById

        The caller is responsible to close the Response after consuming the inputStream.
        Parameters:
        vitamContext - the vitam context
        dipId - the previously generated DIP id to download the DIP
        Returns:
        Response including InputStream
        Throws:
        VitamClientException
      • reclassification

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> reclassification​(VitamContext vitamContext,
                                                                                  com.fasterxml.jackson.databind.JsonNode reclassificationRequest)
                                                                           throws VitamClientException
        Performs a reclassification workflow.
        Parameters:
        vitamContext - the vitam context
        reclassificationRequest - List of attachment and detachment operations in unit graph.
        Returns:
        Response
        Throws:
        VitamClientException - VitamClientException
      • massUpdateUnits

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> massUpdateUnits​(VitamContext vitamContext,
                                                                                 com.fasterxml.jackson.databind.JsonNode updateQuery)
                                                                          throws VitamClientException
        Mass update of archive units.
        Parameters:
        vitamContext - the vitam context
        updateQuery - the update query
        Returns:
        Json representation
        Throws:
        VitamClientException
      • massUpdateUnitsRules

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> massUpdateUnitsRules​(VitamContext vitamContext,
                                                                                      com.fasterxml.jackson.databind.JsonNode updateRulesQuery)
                                                                               throws VitamClientException
        Mass update of archive units rules.
        Parameters:
        vitamContext - the vitam context
        updateRulesQuery - the update request (query and actions)
        Returns:
        Json representation
        Throws:
        VitamClientException
      • selectObjects

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectObjects​(VitamContext vitamContext,
                                                                               com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                                        throws VitamClientException
        selectObjects /objects
        Parameters:
        vitamContext - the vitam context
        selectQuery - the select query
        Returns:
        Json representation
        Throws:
        VitamClientException
      • selectUnitsWithInheritedRules

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitsWithInheritedRules​(VitamContext vitamContext,
                                                                                               com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                                                        throws VitamClientException
        Select units with inherited rules by select query (DSL)
        Parameters:
        vitamContext - the vitam context
        selectQuery - the select query
        Returns:
        Json representation
        Throws:
        VitamClientException
      • getAccessLog

        javax.ws.rs.core.Response getAccessLog​(VitamContext vitamContext,
                                               com.fasterxml.jackson.databind.JsonNode params)
                                        throws VitamClientException
        Get AccessLog file matching the given params
        Parameters:
        vitamContext - the vitam context
        params - Could contains StartDate and EndDate information for file filter
        Returns:
        accesslog file
        Throws:
        VitamClientException
      • computedInheritedRules

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> computedInheritedRules​(VitamContext vitamContext,
                                                                                        com.fasterxml.jackson.databind.JsonNode ComputedInheritedRulesQuery)
                                                                                 throws VitamClientException
        compute inherited rules.
        Parameters:
        vitamContext - the vitam context
        ComputedInheritedRulesQuery - the query request (query and actions)
        Returns:
        Json representation
        Throws:
        VitamClientException
      • deleteComputedInheritedRules

        RequestResponse<com.fasterxml.jackson.databind.JsonNode> deleteComputedInheritedRules​(VitamContext vitamContext,
                                                                                              com.fasterxml.jackson.databind.JsonNode deleteComputedInheritedRulesQuery)
                                                                                       throws VitamClientException
        compute inherited rules.
        Parameters:
        vitamContext - the vitam context
        deleteComputedInheritedRulesQuery - the query request (query and actions)
        Returns:
        Json representation
        Throws:
        VitamClientException