Conception µS Operations

Diagrammes C4

Diagrammes C4 partagés (source centralisée dans gestion-budget-ihm.wiki/schemas).

C1 - Contexte

C2 - Conteneurs "Application Budgets"

C3 - Composant "Opérations"

API BudgetsResource

La classe BudgetsResource est un contrôleur REST qui gère les opérations liées aux budgets mensuels des utilisateurs. Elle agit comme un adaptateur pour le port IOperationsAppProvider, fournissant des points d'entrée pour les opérations de gestion des budgets.

Points d'entrée

getBudgetUtilisateur

• Description : Recherche d'un budget mensuel pour un compte d'un utilisateur.
• Méthode HTTP : GET
• Chemin : /budgets/v2/query
• Rôles autorisés : USER_OPERATIONS
• Paramètres (query) :
  • idCompte : Identifiant du compte.
  • mois : Mois du budget.
  • annee : Année du budget.
• Réponses :
  • 200 : Opération réussie – retourne le budget mensuel (BudgetMensuel).
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.

getBudgetSoldes

• Description : Recherche d'un solde d'un budget mensuel pour un compte d'un utilisateur.
• Méthode HTTP : GET
• Chemin : /budgets/v2/{idBudget}/soldes
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idBudget : Identifiant du budget.
• Réponses :
  • 200 : Opération réussie – retourne les soldes du budget (ProjectionBudgetSoldes).
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.

getiIntervalleBudgets

• Description : Recherche l'intervalle des budgets disponibles pour un compte.
• Méthode HTTP : GET
• Chemin : /budgets/v2/intervalles
• Rôles autorisés : USER_OPERATIONS
• Paramètres (query) :
  • idCompte : Identifiant du compte.
• Réponses :
  • 200 : Opération réussie – retourne l'intervalle de dates (Instant[]).
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.

getOperationById

• Description : Charge le détail d'une opération d'un budget.
• Méthode HTTP : GET
• Chemin : /budgets/v2/{idBudget}/operations/{idOperation}
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idBudget : Identifiant du budget.
  • idOperation : Identifiant de l'opération.
• Réponses :
  • 200 : Détail de l'opération.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.

isBudgetActif

• Description : Retourne l'état d'un budget mensuel (ouvert ou clôturé).
• Méthode HTTP : GET
• Chemin : /budgets/v2/{idBudget}/etat
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idBudget : Identifiant du budget.
  • actif (query) : État attendu du budget.
• Réponses :
  • 200 : Budget actif.
  • 400 : Paramètres incorrects.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.
  • 423 : Budget clôturé (inactif).

setBudgetActif

• Description : Met à jour l'état d'un budget mensuel (ouverture ou clôture).
• Méthode HTTP : PUT
• Chemin : /budgets/v2/{idBudget}/etat
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idBudget : Identifiant du budget.
  • actif (query) : Nouvel état du budget.
• Réponses :
  • 200 : Opération réussie.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.
  • 500 : Opération en échec.

createOperation

• Description : Crée une nouvelle opération dans un budget.
• Méthode HTTP : POST
• Chemin : /budgets/v2/{idBudget}/operations
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idBudget : Identifiant du budget.
  • Corps de la requête : LigneOperation (JSON).
• Réponses :
  • 200 : Opération créée – retourne le budget mis à jour.
  • 400 : Paramètres incorrects.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.
  • 423 : Budget clôturé.

updateOperation

• Description : Met à jour une opération existante dans un budget.
• Méthode HTTP : PUT
• Chemin : /budgets/v2/{idBudget}/operations/{idOperation}
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idBudget : Identifiant du budget.
  • idOperation : Identifiant de l'opération.
  • Corps de la requête : LigneOperation (JSON).
• Réponses :
  • 200 : Opération mise à jour – retourne le budget mis à jour.
  • 400 : Paramètres incorrects.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.
  • 423 : Budget clôturé.

deleteOperation

• Description : Supprime une opération existante dans un budget.
• Méthode HTTP : DELETE
• Chemin : /budgets/v2/{idBudget}/operations/{idOperation}
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idBudget : Identifiant du budget.
  • idOperation : Identifiant de l'opération.
• Réponses :
  • 200 : Opération supprimée – retourne le budget mis à jour.
  • 204 : Opération supprimée (budget vide).
  • 400 : Paramètres incorrects.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.
  • 405 : Compte clos.

createOperationIntercomptes

• Description : Crée une opération de virement interne vers un autre compte.
• Méthode HTTP : POST
• Chemin : /budgets/v2/{idBudget}/operations/versCompte/{idCompte}
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idBudget : Identifiant du budget source.
  • idCompte : Identifiant du compte destination.
  • Corps de la requête : LigneOperation (JSON).
• Réponses :
  • 200 : Opération créée – retourne le budget mis à jour.
  • 400 : Paramètres incorrects.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.
  • 423 : Budget clôturé.

libellesOperationsCompte

• Description : Retourne la liste des libellés des opérations pour un compte spécifique.
• Méthode HTTP : GET
• Chemin : /budgets/v2/compte/{idCompte}/operations/libelles
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idCompte : Identifiant du compte.
• Réponses :
  • 200 : Liste des libellés (LibelleCategorieOperation).
  • 400 : Paramètres incorrects.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.
  • 423 : Compte clos.

overrideLibelleOperationCompte

• Description : Surcharge un libellé d'opération pour un compte donné.
• Méthode HTTP : POST
• Chemin : /budgets/v2/compte/{idCompte}/operations/libelles/override
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idCompte : Identifiant du compte.
  • Corps de la requête : payload de surcharge du libellé.
• Réponses :
  • 200 : Libellé surchargé.
  • 400 : Paramètres incorrects.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.

API AdminBudgetResource

La classe AdminBudgetResource est un contrôleur REST d'administration (/budgets/v2/admin) qui gère la consolidation en masse des libellés d'opérations d'un compte. Elle agit comme un adaptateur pour le port IBudgetAdminAppProvider.

consolidateLibellesOperations

• Description : Met à jour en masse les libellés des opérations d'un compte.
• Méthode HTTP : POST
• Chemin : /budgets/v2/admin/{idCompte}/operations/libelles/override
• Rôles autorisés : USER_OPERATIONS
• Paramètres :
  • idCompte : Identifiant du compte.
  • Corps de la requête : liste de LibelleAvantApres (JSON).
• Réponses :
  • 200 : Opération réussie.
  • 401 : Utilisateur non authentifié.
  • 403 : Opération non autorisée.
  • 404 : Données introuvables.
  • 500 : Opération en échec.

Filtres

preMatchingFilter

• Description: Filtre les requêtes entrantes avant le matching des routes pour appliquer des règles de sécurité.
• Annotation: @ServerRequestFilter(preMatching = true)

postMatchingFilter

• Description: Filtre les réponses sortantes après le matching des routes pour appliquer des règles de sécurité.
• Annotation: @ServerResponseFilter

Injections

• IBudgetAppProvider budgetService: Fournisseur de services pour les opérations sur les budgets mensuels.
• IBudgetAdminAppProvider budgetAdminService: Fournisseur de services pour l'administration des budgets (AdminBudgetResource).

Navigation

• Home
• Conception globale
• Conception µS Paramétrages
• Conception µS Utilisateurs
• Conception µS Comptes