openxava / documentación / Migración

¿Cómo actualizar tu proyecto a la última versión de OpenXava?

Edita el archivo pom.xml de tu proyecto y cambia el valor de la propiedad openxava.version para que apunte a la última versión de OpenXava, así:

<properties>
    <openxava.version>7.4.1</openxava.version>
    ...
</properties>

Compila tu proyecto:

• Con OpenXava Studio:
• Botón derecho del ratón en tu proyecto > Run As > Maven clean
• Botón derecho del ratón en tu proyecto > Run As > Maven install
• O con línea de órdenes: mvn clean package

assertPopupPDFLinesCount(7);
assertPopupPDFLine(2, "Name");

assertPopupPDFLinesCount(8); // +1
assertPopupPDFLine(2, "Record count: 3"); // SE AGREGÓ ESTA NUEVA FILA
assertPopupPDFLine(3, "Name");

String [] actions = { 
    "Collection.new",
    "Collection.edit",
    "Collection.removeSelected", // QUITA ESTA ENTRADA SI LA COLECCIÓN TIENE ELIMINAR EN CASCADA
    "Collection.deleteSelected" // AÑADE ESTA ENTRADA
};		
assertActions(actions);

public void testDeleteElementInCollection() throws Exception {
	....
	execute("Collection.removeSelected", "row=0,viewObject=xava_view_humans"); // QUITAR
	execute("Collection.deleteSelected", "row=0,viewObject=xava_view_humans"); // CAMBIAR POR
	...
}

@OneToMany (mappedBy="delivery", cascade=CascadeType.REMOVE)
@RemoveSelectedAction(forViews="DEFAULT, MoreSections", value="DeliveryDetail.removeSelected") // QUITAR
@DeleteSelectedAction(forViews="DEFAULT, MoreSections", value="DeliveryDetail.deleteSelected") // CAMBIAR POR @DeleteSelectedAction, 
										       // EL NOMBRE DE LA ACCIÓN EN EL CONTROLADOR NO ES OBLIGATORIO CAMBIARLO
private Collection<Detail> details;	

public class DeleteSelectedDeliveryDetailsAction 
	extends RemoveSelectedInCollectionAction { // QUITAR
	extends DeleteSelectedInCollectionAction { // CAMBIAR POR

String [] actions = { 
    "Collection.edit",
    "CollectionOpenInNewTab.openInNewTab" // AÑADE ESTA ENTRADA
};		
assertActions(actions);

Para migrar de OpenXava 7.3.2 a OpenXava 7.3.3

Para migrar de OpenXava 7.3.1 a OpenXava 7.3.2

Para migrar de OpenXava 7.3 a OpenXava 7.3.1

Para migrar de OpenXava 7.2.3 a OpenXava 7.3

Nuevas acciones en controlador Collection

Si no has sobrescrito el controlador Collection puedes saltear este paso. De lo contrario debes agregar manualmente las acciones previous y next en el controlador:

<action name="next"
	image="next.gif"
	icon="skip-next"
	class="org.openxava.actions.EditElementInCollectionAction">
	<set property="openDialog" value="false"/> 
	<set property="nextValue" value="1"/> 
</action>	
			
<action name="previous"
	image="previous.gif"
	icon="skip-previous"
	class="org.openxava.actions.EditElementInCollectionAction">
	<set property="openDialog" value="false"/> 
	<set property="nextValue" value="-1"/> 
</action>

Nuevas acciones en diálogos de colecciones (para pruebas JUnit)

Ahora los diálogos de las colecciones tienen dos nuevas acciones, Collection.previous y Collection.next, por lo que si comprueban todas las acciones presentes en las pruebas JUnit, hace falta modificarlas y agregar las nuevas acciones. Por ejemplo:

String [] bottomActions = { 
    "Collection.save",
    "Collection.hideDetail",
    "Collection.next", // AÑADE ESTA ENTRADA
    "Collection.previous" // AÑADE ESTA ENTRADA
};		
assertActions(bottomActions);

Ya no se soportan el uso de eval() en JavaScript

Si tienes tus propios editores o vistas personalizadas y estás utilizando tu propio código JavaScript, ten en cuenta que eval() ya no es compatible por razones de seguridad. Debes reescribir tu código JavaScript para no utilizar eval().

Si estás utilizando una biblioteca de terceros o si la cantidad de código que debes reescribir es considerable, y tu aplicación no requiere altos estándares de seguridad, puedes habilitar el soporte de eval() para tu aplicación OpenXava agregando la siguiente entrada a tu archivo xava.properties:

unsafeEvalInScripts=true

Para migrar de OpenXava 7.2.2 a OpenXava 7.2.3

Para migrar de OpenXava 7.2.1 a OpenXava 7.2.2

Para migrar de OpenXava 7.2 a OpenXava 7.2.1

Para migrar de OpenXava 7.1.6 a OpenXava 7.2

Ya no se soportan eventos en línea en editores y vistas personalizadas

Si tienes que escribir tus propios editores o vistas personalizadas y estás usando onclick, onfocus, onblur, etc., ya no van a funcionar. Tampoco funcionan los href="javascript: ". Esto es por razones de seguridad. Tienes que eliminar los eventos del HTML y moverlos a un archivo JS.

Es decir, si tienes un código como este en tu editor:

<a class="ox-card" 
    onclick="openxava.executeAction('<%=request.getParameter("application")%>', '<%=request.getParameter("module")%>', false, false, '<%=action%>', '<%="row=" + (i++)%>');">

Quita el evento onclick dejándolo de esta manera:

<a class="ox-card" data-action="<%=action%>" data-row="<%=i++%>">

Fíjate que hemos añadido atributos data- para guardas datos dinámicos que antes estaban en el JavaScript en línea, así podremos leer estos atributos desde nuestro código JavaScript después.

A continuación añade un archivo JS, digamos cardEditor.js (si el editor JSP se llama cardEditor.jsp), en src/main/webapp/xava/editors/js (crea la carpeta si todavía no existe) de tu proyecto, con el siguiente contenido:

openxava.addEditorInitFunction(function() {
	$('.ox-card').off('click').click(function() {
		openxava.executeAction(openxava.lastApplication, openxava.lastModule, false, false, 
			$(this).data('action'), "row=" + $(this).data('row'));
	});
});

Observa cómo utilizamos la clase, .ox-card en este caso, para añadir el evento usando código JavaScript. También usamos data() para obtener los valores de los atributos data que hemos guardado en el elemento HTML. Este código es seguro porque es descargado desde el servidor que aloja la aplicación.

Librerías JavaScript jQuery y jQuery UI actualizadas

jQuery se ha actualizado a la versión 3.7.1 desde la 1.11.2 y jQuery UI a la versión 1.13.2 desde la v1.11.2. Esta actualización se ha hecho por motivos de seguridad. Si únicamente usas la interfaz de usuario generada por OpenXava no tienes que hacer nada, sin embargo si tienes vistas personalizadas o editores propios y en estos usas jQuery deberías echas un vistazo a la guía de actualización para jQuery 3, puede que necesites hacer algún ajuste.

Incluir archivos JavaScript en JSP de editores o vista personalizada ya no funciona

Esto es por razones de seguridad. Normalmente los JS usados en editores propios o vistas personalizadas se incluyen en la carpeta xava/editors/js, cuando este es el caso no hay que hacer ningún cambio. Sin embargo, en algunas ocasiones el archivo JavaScript se ha incluido en el editor o la vista directamente, si este es el caso tenemos varias opciones.

La mejor alternativa es quitar el <script> del JSP y copiar tu archivo JS a la carpeta xava/editors/js.

Si esto no es posible, porque por ejemplo el JS es generado dinámicamente por un servlet, la solución es quitar el <script> del JSP y añadir un openxava.getString() en el archivo JS de tu editor. Por ejemplo, para el editor Discussion tenemos un discussion.js que está en xava/editors/js donde tenemos el código:

openxava.getScript(openxava.contextPath + "/dwr/interface/Discussion.js");

Si tu editor o vista personalizada aún no tiene un archivo JS, simplemente créalo y colócalo en xava/editors/js, sin importar que, por ahora, su única función sea cargar otro JS.

La última opción es mantener la etiqueta <script> en el JSP y agregarle un atributo de nonce. En otras palabras, si en el código JSP de tu editor o vista tienes algo como esto:

<script type='text/javascript' src='<%=contextPath%>/dwr/interface/Discussion.js?ox=<%=version%>'></script>

Lo deberías cambiar por:

<script type='text/javascript' <xava:nonce/> src='<%=contextPath%>/dwr/interface/Discussion.js?ox=<%=version%>'></script>

Fíjate en el <xava:nonce/> que hemos añadido. Aunque esta opción es la más rápida de implementar, las dos formas de JavaScript mencionadas anteriormente funcionan mejor.

Para migrar de OpenXava 7.1.5 a OpenXava 7.1.6

Para migrar de OpenXava 7.1.4 a OpenXava 7.1.5

Para migrar de OpenXava 7.1.3 a OpenXava 7.1.4

Para migrar de OpenXava 7.1.2 a OpenXava 7.1.3

Para migrar de OpenXava 7.1.1 a OpenXava 7.1.2

Para migrar de OpenXava 7.1 a OpenXava 7.1.1

Para migrar de OpenXava 7.0.6 a OpenXava 7.1

<div style="padding: 20px; background-color: green;">

<div class="mi-fondo">

.mi-fondo {
    padding: 20px; 
    background-color: green;
}

return "<i class='mdi mdi-square' style='color: " + valorHexColor + "'></i>";

return "<font color='" + valorHexColor + "'><i class='mdi mdi-square ox-color-inherit'></i></font>"; 

response.setContentType("text/html"); 

<script type="text/javascript"> 
    var button = document.getElementById('welcome_go_signin');
    button.onclick = function () { window.location='m/SignIn'; }
</script>

<%@include file="../xava/imports.jsp"%>
    
    ...
    
<script type="text/javascript" <xava:nonce/>> 
    var button = document.getElementById('welcome_go_signin');
    button.onclick = function () { window.location='m/SignIn'; }
</script>

<input type="button" tabindex="1" onclick="window.location='m/SignIn'" value="<xava:label key='SignIn'/>">

<input id="welcome_go_signin" type="button" tabindex="1" value="<xava:label key='SignIn'/>">

var button = document.getElementById('welcome_go_signin');
button.onclick = function () { window.location='m/SignIn'; }

public class DecirHola extends BaseAction implements IForwardAction {    

    public void execute() throws Exception {
    }

    public String getForwardURI() {
    	return "javascript:alert('Hola')";
    }

    public boolean inNewWindow() {
        return false;
    }

}

public class DecirHola extends BaseAction implements IJavaScriptPostAction {

    public void execute() throws Exception {
    }

    public String getPostJavaScript() {
	return "alert('Hola')";
    }

}

assertLabelInList(0, "Year of invoice");

assertLabelInList(0, "Invoice year");

customer.address = Address of customer
customer.address.street = Street of address of customer
customer.address.street.number = Number of street of address of customer 

customer.address = Customer address
customer.address.street = Customer address street
customer.address.street.number = Customer address street number

getWebClient().getOptions().setCssEnabled(true); // Si haces esto...
reload(); // ...has de añadir esta línea

String [] acciones= {
	"CRUD.new",
	"CRUD.save",
	"CRUD.refresh",
	"Mode.list",
	"Reference.search",
	"Reference.createNew",
	"Reference.modify",
	"Reference.clear", // AÑADE ESTA ENTRADA
	"Sections.change"
};
assertActions(acciones); 

Tomcat 8.x requiere nivel de compilación Java 8 como mínimo

<servlet>
	<servlet-name>jsp</servlet-name>
	<servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
	...
	<!-- Añade los siguiente parametros para compilar con Java 8 -->
	<init-param>
	  <param-name>compilerSourceVM</param-name>
	  <param-value>1.8</param-value>
	</init-param>
	<init-param>
	  <param-name>compilerTargetVM</param-name>
	  <param-value>1.8</param-value>
	</init-param>		
	...
</servlet>

Nueva entidad a declarar en persistence.xml (para XavaPro)

<class>com.openxava.naviox.model.SSORecord</class>

Añadir nuevo módulo SSO a rol admin y carpeta Admin (para XavaPro)

Para migrar de OpenXava 7.0.5 a OpenXava 7.0.6

@Column(length=x) sin scale ya no es scale=2 por defecto

Hemos arreglado un fallo relacionado con que scale=0 para @Column no funciona, y dado que cuando scale no está definido su valor por defecto es 0, ahora @Column(length=x) tiene scale=0 como valor por defecto en lugar de scale=2. Es decir, has de cambiar este código:

@Column(length=6)
BigDecimal factor;

Por este otro:

@Column(length=6, scale=2) // AÑADE scale=2
BigDecimal factor;

Si no defines length o precision el valor de scale todavía es 2, como siempre, por tanto si tienes:

@Column(column="FCTR")// scale es 2 por defecto, como siempre
BigDecimal factor;

Para migrar de OpenXava 7.0.4 a OpenXava 7.0.5

Para migrar de OpenXava 7.0.3 a OpenXava 7.0.4

Para migrar de OpenXava 7.0.2 a OpenXava 7.0.3

Los combos de @DescriptionsList en la parte del filtro de la lista ya no usan la clave

Para arreglar un fallo, los combos de las referencias marcadas como @DescriptionsList en el filtro de la lista o colecciones ya no usan la clave, sino el valor del campo. Esto es algo interno, no afecta el funcionamiento de la aplicación. Pero es posible que tengas que adaptar algo de código. Si tienes una condición como esta en una acción:

getTab().setConditionValue("vendedor.nombre", 1);

Cámbiala por:

getTab().setConditionValue("vendedor.nombre", "JUAN HERRERO");

Fíjate como ahora para vendedor.nombre usamos el nombre del vendedor, no el id. Hemos hecho esto para arreglar un bug, pero como efecto secundario ahora es más natural y además funciona de la misma manera para referencias con o sin @DescriptionsList, así que añadir o quitar un @DescriptionsList a una referencia no afecta al código de tus acciones.

También tienes que adaptar tu código JUnit que pone valor al filtro de la lista si se usan referencias con @DescriptionsList. Es decir,  cambia:

setConditionValues("", "1");

setConditionValues("", "AUTOMÓVIL");

String [][] valoresValidos = {
    { "", "" },
    { "2:_:FAROLA", "FAROLA" },
    { "0:_:CASA", "CASA" },
    { "3:_:PUERTA", "PUERTA" },
    { "1:_:AUTOMÓVIL", "AUTOMÓVIL" }
};
assertValidValues("conditionValue___3", valoresValidos);        

String [][] valoresValidos = {
    { "", "" },
    { "FAROLA", "FAROLA" },
    { "CASA", "CASA" },
    { "PUERTA", "PUERTA" },
    { "AUTOMÓVIL", "AUTOMÓVIL" }
};
assertValidValues("conditionValue___3", valoresValidos);

Para migrar de OpenXava 7.0.1 a OpenXava 7.0.2

Para migrar de OpenXava 7.0 a OpenXava 7.0.1

Para migrar de OpenXava 6.6.3 a OpenXava 7.0

Convertir tu proyecto a estructura Maven

La forma más fácil de migrar a Maven es crear un nuevo proyecto usando OpenXava 7.0 y después copiar el código fuente y los recursos desde tu proyecto actual al nuevo. Es decir, lo primero es crear un nuevo proyecto OpenXava usando Openxava Studio 7, para ello sigue las instrucciones de la guía de primeros pasos.

El siguiente paso es copiar todo el código fuente y los recursos desde el viejo proyecto a la carpeta correspondiente en el nuevo proyecto, como sigue:

• De src a src/main/java (si estás usando XavaPro no copies com.openxava.naviox.model que ahora está incluido en xavapro.jar)
• De xava a src/main/resources/xava
• De i18n a src/main/resources/i18n
• De properties a src/main/resources
• De persistence/META-INF a src/main/resources/META-INF
• De persistence a src/main/resources

El código de pruebas está en una carpeta diferente en Maven, por lo que deberías copiar:

• De src/com.tuempresa.tuaplicacion.pruebas a src/test/java/com.tuempresa.tuaplicacion.pruebas
• properties/xava-junit.properties a src/test/resources/xava-junit.properties

Lo de arriba es suficiente para la mayoría de las aplicaciones.

• De web/xava/editors a src/main/webapp/xava/editors
• De web/xava/editors/js a src/main/webapp/xava/editors/js
• De web/xava/editors/style a src/main/webapp/xava/editors/style

Copia también:

• custom.css de web/xava/style a src/main/webapp/xava/style
• Tus propios JSPs de web to src/main/webapp
• Si has modificado algún JSP de OpenXava, puedes copiarlo desde web/xava a src/main/webapp/xava y desde web/naviox a src/main/webapp/naviox. No te preocupes si no ves ningún JSP allí, ahora el código JSP de OpenXava está dentro del jar de OpenXava y no se incluye en tu proyecto, pero si pones algún JSP en la carpeta xava éste sobrescribe el de OpenXava.

Los archivos servlets.xml, filters.xml y listeners.xml ya no se soportan. Puedes copiar su contenido a web.xml, que ahora está vacío y listo para tus propias cosas, en src/main/webapp/WEB-INF. Si usas las anotaciones @WebServlet, @WebFilter y @WebListener no tienes que hacer ningún cambio.

Si usas una librería de terceros extra en tu aplicación has de añadir una dependencia en el archivo pom.xml en la raíz de tu proyecto. Ya no vas a copiar jars en web/WEB/lib. Si no estás familiarizado con Maven lee sobre el mecanismo de depencia de Maven.

Si usas una base de datos que no sea HSQLDB has de añadir la dependencía para tu controlador JDBC. Por ejemplo, si usas MySQL añade la siguiente entrada a tu pom.xml:

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.29</version>
</dependency>

Para otra base de datos simplemente pregunta a Google, algo como "maven dependency oracle" por ejemplo. Para que tu controlador JDBC se descargue y se incluya en tu proyecto has de ejecutar "mvn package" en tu proyecto. Puedes hacerlo desde la línea de órdenes (si tienes Maven instalado en tu máquina) o desde OpenXava Studio (no es necesario tener Maven instalado), con Run As > Maven Build... en tu proyecto y tecleando "package" como goal. Este paso no es necesario si usas HSQLDB como base de datos.

Ahora puede ejecutar tu aplicación. Pon tu ratón en src/main/java de to proyecto y escoge Run As > Java Application. A partir de ahora, puedes modificar tu código y relanzar tu aplicación como siempre, incluso si la lanzas en modo de depuración puedes modificar el código y ver el resultado sin relanzar la aplicación. Es decir, puedes trabajar en desarrollo como lo has hecho siempre.

Ya no usamos Ant. Ahora lo vas a hacer todo usando comandos de Maven. Si no conoces Maven muy bien lee alguna documentación de introducción a Maven. Por ejemplo, para crear el war para desplegar en producción usaras "mvn package", y obtendrás el war listo para ser desplegado en Tomcat en la carpeta target de tu proyecto.  Puedes ejecutar todos los comandos Maven desde dentro de OpenXava Studio, con la opción Run As en tu proyecto.

<artifactId>almacenes</artifactId>

<artifactId>Almacenes</artifactId>

<finalName>almacenes</finalName>

<finalName>Almacenes</finalName>

<aplicacion nombre="almacenes">

<aplicacion nombre="Almacenes">

AppServer.run("almacenes");

AppServer.run("Almacenes");

@Entity
public class CargoTransporte {
	
    @Id @ManyToOne
    private Albaran albaran;

    ...
	
}

@Entity
public class Albaran {
	
    @Id 
    private int numero;

    @Id @ManyToOne
    private Factura factura;

    ...
	
}

@Entity
public class Factura {
	
    @Id 
    private int anyo;
	
    @Id 
    private int numero;

    ...
	
}

String consulta="from CargoTransporte c where c.albaran.factura.anyo = :albaran_factura_anyo";
Query query = XPersistence.getManager().createQuery(consulta);
query.setParameter("albaran_factura_anyo", 2022);

String consulta="from CargoTransporte c join fetch c.albaran a where a.factura.anyo = :albaran_factura_anyo";
Query query = XPersistence.getManager().createQuery(consulta);
query.setParameter("albaran_factura_anyo", 2022);

<persistence-unit name="default">
    ...
    <properties>
        <property name="javax.persistence.schema-generation.database.action" value="update"/>
        <property name="javax.persistence.create-database-schemas" value="true"/> 
        <property name="hibernate.default_schema" value="MIESQUEMA"/>
    </properties>
</persistence-unit>

Clase de utilidad XHibernate quitada

La clase de utilidad XHibernate se ha quitado porque se usaba en las aplicaciones con componentes XML, en las aplicaciones JPA usamos XPersistence en su lugar, y hemos quitado el soporte para componentes XML en v7.0. El API de Hibernate todavía está disponible. En el raro caso de que uses XHibernate en algún punto de tu código, cambia:

Session session = XHibernate.getSession();
session.save(factura);

Por:

Session session = (Session) XPersistence.getManager().getDelegate();
session.save(factura);

Recursos del proyecto en lugar diferente (para las pruebas JUnit)

uploadFile("scripts", "informes/Corporacion.html");

uploadFile("scripts", "src/main/resources/informes/Corporacion.html");

HtmlElement tarjeta = body.getElementsByAttribute("div", "class", "ox-card").get(2);
assertEquals("Precio unitario: 0.00, Precio unitario en pesetas: 0"), tarjeta.asText());

HtmlElement tarjeta = body.getElementsByAttribute("div", "class", "ox-card").get(2);
assertEquals("Precio unitario: 0.00, Precio unitario en pesetas: 0"), tarjeta.asNormalizedText());

assertDiscussionCommentText("discusion", 0, Strings.multiline("admin - Ahora", "Hola, soy yo")); 

assertDiscussionCommentText("discusion", 0, "admin - Ahora\nHola, soy yo");

assertValueInList(2, "XAVA\r\n3\r\nPrecio unitario: 0");

assertValueInList(2, "XAVA\n3\nPrecio unitario: 0");

assertEquals(
    "javascript:openxava.executeAction('openxavatest', 'Carrier', 'Effacer l" 
        + (char) 145 // ANSI  
        +"entité courante: Etes-vous sûr(e) ?', false, 'CRUD.delete')", 
    deleteLink.getHrefAttribute());

assertEquals(
    "javascript:openxava.executeAction('openxavatest', 'Carrier', 'Effacer l" 
        + (char) 8216 // UNICODE
        +"entité courante: Etes-vous sûr(e) ?', false, 'CRUD.delete')", 
    deleteLink.getHrefAttribute());

assertValue("descripcion", "Esto es una gran discusión sobre jUnit");

assertValue("descripcion", "<p>Esto es una gran discusión sobre jUnit</p>");

assertValue("poblacion", "46540 ");

assertValue("poblacion", "46540");

getWebClient().getOptions().setCssEnabled(true); // Si haces esto...
reload(); // ...has de añadir esta línea

CellType.NUMERIC // En lugar de Cell.CELL_TYPE_NUMERIC
HyperlinkType.FILE // En lugar de Hyperlink.LINK_URL
FillPatternType.SOLID_FOREGROUND // En lugar de CellStyle.SOLID_FOREGROUND
HSSFColor.HSSFColorPredefined.RED // En lugar de HSSFColor.RED
BorderStyle.THIN // En lugar de CellStyle.BORDER_THIN
HorizontalAlignment.LEFT // En lugar de CellStyle.ALIGN_LEFT

Cell cell ... 
// cell.setCellType(Cell.CELL_TYPE_FORMULA); // Ya no existe, no es necesario
cell.setCellFormula(text);

font.setBoldweight(Font.BOLDWEIGHT_BOLD);

font.setBold(true);

Para migrar a OpenXava 6.6.3

Para migrar a OpenXava 6.6.3 desce cualquier versión anterior de OpenXava, incluso desde la 1.0:

Sigue las instrucciones de migración para OpenXava 6.x