SpringBoot (13) Let's start (1/10). Introduction to defining menu items.

 0. Introduction

Four menu item types are used:

  1. Menu/submenu: Can have children. They are the parent of a tree. You can go to children. No actions can be performed. No URL can redirect
  2. ActionForm: Execute the method of a class and can have parameters. The parameters can be displayed in a form to change any value. A URL is needed
  3. CRUDForm : To insert/update/delete objects from a class. A URL is needed.
  4. Grid: For displaying database elements in a grid.
The file "src/main/resources/config/menus/menus.yml" contains the menu configuration an definition
The most important common fields are:
  1. id: must be supplied and must be únique. Typical values "1","1-1","1-2","1-2-1", you can use any id, but it should be easy to 
  2. name: Is the description in the menu item
  3. accessLevel: Is the minimum access level required for the user to be executed or displayed. By default its value is 1 (0=No permissions required, 1: see, 2: list, 3: edit,4:insert, 5: delete, 6: admin)
  4. specialRole: A string identifying a special role as "ADMIN", "TERCERS", "TERRIRORI". To access this menu, the users must have the special role.
  5. allUsers: If true, all users can access this menu item.
Here is a YAML file where the fields id, name, and accessLevel are used. Also specialRole field is used in the first element (line 4)

1
2
3
4
5
6
menus:
  items:
  #--- Negociats: Nivell 0
    - { id: 1, name: Secretaria,  accessLevel:1, specialRole: SECRETARI,  idFills: [1-1, 1-2] } 
    - { id: 2, name: Estadística,  accessLevel:1,    idFills: [1-1-1, 1-1-2] } 
    - { id: 1-1,     name: Decrets ENI,  accessLevel:4,             idFills: [1-1-1, 1-1-2] }

1. Menu/submenu

The menu/submenu element is the first type of element and  has a field that is a list of children's ids that you can access. This field is idFills and you can see it in lines 4, 5, and 6. In this case, the menu with id 1 has 2 children with ids "1-1" and "1-2"

2. ActionForm

The action form is the second type of menu element and must have also these fields:
  1. href: it is discouraged to use this field, as it encloses the rest of the following fields. Internally, the following fields are combined to build the href field.
  2. url: where the Spring controller  (webController.java) must have a method with a @GetMapping or @RequestMaspping annotation whose value is this url field. Usually, the URL is "/generalActionForm"
  3. title: A title of the form
  4. subtitle: A subtitle of the form for additional information
  5. processClassName: A class name in the package ximo.actions that will be executed when the form is submitted. This class must have a main method.
  6. lFields: A list of fields that will be displayed in the form and provides the execution parameters of the class. Each field can have these fields:
    1. name: must be unique. 
    2. label: that appears in the form for this field
    3. value: default value.
    4. component: The component type may be SELECT, NUMBER, HIDDEN, INPUT, RADIO, CHECK, FILE.
    5. optionValues: Only for components of type SELECT for instance "1,2,3,4"
    6. optionText: Only for components of type SELECT for instance "BIG,MEDIUM,SMALL"
    7. accept: Only for components of type FILE, for instance, "image/png, image/jpg" or  ".doc,.docx,.xml"
Here are 2 examples of defining the same action form. The first is more structured but the second includes all references to the href that is discouraged as it is more error prune, so it is commented wit "#"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
menus:
  items:
    - { id: 6-1, name: MargaPDFSplit3, specialRole: ADMIN, url: /generalActionForm,  
        processClassName: A01_ActionMarga_IRPF_Split_Alcalde_Signature,
        title: Trocejar un PDF en grups de 2 pàgines i ficar segell i firma Alcalde,
        subtitle: Tresoreria-IRPF,
        lFields: [ 
          { name: resource,  label: Document Sencer,       component: FILE,  value: /home/eduard/PDF/190_2022/190_IRPF_2022.pdf,     accept: .pdf  },
          { name: imgAlc,    label: Fitxer Firma Alcalde,  component: FILE,  value: /home/eduard/PDF/190_2022/firma_sergi.png,       accept: ".png,.jpg,.jpeg"  },
          { name: imgSegell, label: Segell Tresoreria,     component: FILE,  value: /home/eduard/PDF/190_2022/segell_tresoreria.png, accept: ".png,.jpg,.jpeg"  },
          { name: prova,     label: Prova (sols 2 rebuts), component: CHECK, value: prova }
        ]  
      }
    #- { id: 6-1, name: MargaPDFSplit3, specialRole: ADMIN,                        
    #        href: "/generalActionForm?processClassName=A01_ActionMarga_IRPF_Split_Alcalde_Signature\
    #              &title=Trocejar un PDF en grups de 2 pàgines i ficar segell i firma Alcalde\
    #              &subtitle=Tresoreria-IRPF\
    #              &field={'name':'resource', 'label':'Document Sencer', 'value':'/home/eduard/PDF/190_2022/190_IRPF_2022.pdf','accept':'.pdf','component':'FILE' }\
    #              &field={'name':'imgAlc', 'label':'Fitxer Firma Alcalde', 'value':'/home/eduard/PDF/190_2022/firma_sergi.png','accept':'.png,.jpg,.jpeg','component':'FILE'}\
    #              &field={'name':'imgSegell', 'label':'Segell Tresoreria', 'value':'/home/eduard/PDF/190_2022/segell_tresoreria.png','accept':'.png,.jpg,.jpeg','component':'FILE'}\
    #              &field={'name':'prova', 'label':'Prova (sols 2 rebuts)', 'value':'prova','component':'CHECK'}" }

3. The CRUD Form

It is the third type of menu element and represents a form for database elements. It must have these fields (and also the common fields):
  1. modelClassName: It is the class whose elements are stored in the database and we want to add, delete, modify, or look up
  2. pkg: The java package where the class is stored
  3. action: a word that can be "crud" or a combination of the letters or this word for instance "cu", "r", "u", "c". CRUD is the acronym for Create-Read-Update-Delete.
  4. where: is a JPA expression. Note that the $DNI$ is used for getting the DNI from the certificate CN. For instance "a.DNI='$DNI$' AND a.plaza.id=1"
  5. opts: is formed by a combination of words separated by commas. It is used in the thymeleaf forms. By now, "rebutx,admin" represents the admitted options, the first is for invalidating some information included by the user and the second is for accessing only the administrator.
Here are some examples of CRUD forms:


 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
menus:
  items:
    - { id: 3-1, name: Autobaremació, url: '/crud',
         modelClassName: RHPlazaPersona, pkg: ximo.xotherapps.model.rrhhv3, 
         action: u, allUsers: true, where: "a.DNI='$DNI$' AND a.plaza.id=1"
      }
    - { id: 3-2, name: Autobaremació amb rebutx, url: '/crud',
         modelClassName: RHPlazaPersona, pkg: ximo.xotherapps.model.rrhhv3, 
         action: u, allUsers: true, where: "a.DNI='$DNI$' AND a.plaza.id=1", opts: 'rebutx,admin'
      }
    - { id: 3-3, name: Definició Places, url: '/crud',
         modelClassName: RHPlaza, pkg: ximo.xotherapps.model.rrhhv3, 
         action: u, allUsers: false, where: "a.id=1"
      }

4. Grid

This is the fourth menu element type and displays the database elements in tabular form.
It shares with the CRUD Form element these fields: modelClassName, pkg, and it is in construction.

A simple example is:

1
2
3
4
5
6
7
8
menus:
  items:
    - { id: 8-2, name: Prova AG-Grid,               url: '/ag-grid',
        #modelClassName: KKK, pkg: ximo.xproves,
        modelClassName: RHPlaza, pkg: ximo.xotherapps.model.rrhhv3,
        title: Prova AgGrid,
        subtitle: Informatica
      }

Here is an example of the displayed menu




Comentarios

Publicar un comentario

Entradas populares de este blog

SpringBoot (6) Spring Data JPA (1)

 1. application.yml This file is in the folder src/main/resources 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 spring: #--JPA datasource: #--Connection Pool hiraki: connectionTimeout: 20000 maximumPoolSize: 5 # PostgreSQL url: jdbc:postgresql://localhost:5432/mydb driver-class-name: org.postgresql.Driver username: user password: password jpa: hibernate: ddl-auto: update show-sql: true This will create or update tables 2. Defining Entities to persist There are many entries where defining entities but an Entity needs: The @Entity annotation The@Audited annotation if you want a control version The @Table (name="table_name",  schema = "myschema", uniqueConstraints..., indexes ..) All the related entities ( referenced in @OneToMany, @ManyToMany and ManyToOne) must be annotated with @Entity and @Audited (if any of the has the @Audited, then all classes should have this annotation also) Common error
Leer más

SpringBoot (10) Authentication (1). Server certificate, application.yml and Application.java

 0. Introduction The goal is to use a certificate for client authentication. So the HTTPS protocol should be used.  To use this protocol, a server certificate is needed. Let's see the steps to accomplish this target: 1. Server certificate Get a server certificate in "p12" format with a password.  Create a folder ( keystores ) in src/main/resources and place the server certificate in this folder. 2. application.yml file Here is the file ====================================================================== server : #==================================================================================== # 1. For accepting "{ }" in parameters and for accepting a long number of parameters #==================================================================================== #@see https://stackoverflow.com/a/58440058/7704658 #@see https://www.programmersought.com/article/4517808578/ tomcat : relaxed-query-chars : [ ' { ' , ' } '
Leer más

Spring Boot (2) Websockets. Subscriptions of only one member

Imagen
 1. Introduction WebSockets are useful for informing a user of the progress of a heavy process. There are a lot of blogs and videos about this question.  Spring boot uses the STOMP protocol 2. Creating the project Use Spring boot initializer  for creating the project, use these dependencies: Spring boot dev tools Lombok Spring Web Thymeleaf Websocket And use gradle format Then import it from Eclipse as File > Import > Gradle > Existing Gradle Project The final project structure after adding all the needed classes, html and js file is: 3. Add the needed dependencies to the build.gradle file Add javascript dependencies to the build.gradle implementation ' org.webjars:webjars-locator-core ' implementation ' org.webjars:sockjs-client:1.5.1 ' implementation ' org.webjars:stomp-websocket:2.3.4 ' implementation ' org.webjars:bootstrap:3.3.7 ' implementation ' org.webjars:jquery:3.6.4 ' Add also the Gson dependencies, and the build.xml file
Leer más