Dos Ideas. - Contribuciones del usuario [es]

Work Manager en Weblogic

2010-07-15T13:57:14Z

Pocho: Página creada con 'Un Work Manager en Weblogic permite, entre otras cosas, crear limitaciones para los hilos (threads) de aquellas aplicaciones que estén asociadas a él. == Configuración en We…'

Un Work Manager en Weblogic permite, entre otras cosas, crear limitaciones para los hilos (threads) de aquellas aplicaciones que estén asociadas a él.

== Configuración en Weblogic 10.x ==

El proceso consiste en crear por consola el Work Manager en si, y luego un componente especifico por cada limitación que quisiéramos activar.

El primer paso es ir a la consola del Weblogic --> Enviroment --> Work Managers --> New --> Work Manager. El nombre que elijamos luego lo utilizaremos en la aplicacion destino.

Luego debemos crear un componente por tipo de limitación que necesitamos.

Si por ejemplo queremos que se ejecuten como máximo dos hilos y otros dos queden encolados, creamos un ''Maximum Threads Constraint'' con valor dos y ''Capacity Constraint'' con valor 4.

Paso siguiente ingresamos en el Work Manager que creamos al comienzo, y le asignamos las limitaciones correspondientes. Recordar que al hacer este paso debemos reiniciar los servidores donde afecte dicha configuración.

Finalmente debemos decirle a nuestra aplicacion que utilice un Work Manager específico y no el ''default'' que provee Weblogic. Esto se configura en los descriptores de nuestra aplicación. En el caso de una aplicacion web, lo indicamos en el ''weblogic.xml'':

<code xml>
<?xml version="1.0" encoding="UTF-8"?>

<weblogic-web-app xmlns="http://www.bea.com/ns/weblogic/weblogic-web-app">
<context-root>/conexto-aplicacion</context-root>


<wl-dispatch-policy>miWorkManager</wl-dispatch-policy>

</weblogic-web-app>
</code>

WebLogic

2010-07-15T13:13:50Z

Pocho: /* Ver también */

WebLogic es el [[Servidor de Aplicaciones]] [[Java EE]] de BEA (actualmente propiedad de [[Oracle]]).

==Versiones==
=== 8.x ===
La version 8.x es compatible con el JDK 1.4 y JEE 1.4

=== 9.x ===
La version 9.x es compatible con el JDK 5 y JEE 1.4 (con compatibilidad parcial para [[Java EE]] 5)

=== 10.x ===
La versión 10.x es compatible con el [[Java SE]] 5 y [[Java EE]] 5.

==Ver también==
* [[MDB en Weblogic]]
* [[Debug Remoto De Weblogic]]
* [[AquaLogic]]
* [[Compartir sesión en WebLogic]]
* [[SAF en WebLogic]]
* [[Transaction Manager en Weblogic]]
* [[Work Manager en Weblogic]]

[[Category:WebLogic]]

Integración de Maven con IDEs

2010-04-08T19:19:57Z

Pocho: /* M2Eclipse */

== Eclipse ==

Existen 2 plugins disponibles para Eclipse, pero solo uno se encuentra estable.

=== M2Eclipse ===

Provee las siguientes características:

* Crear builds desde Eclipse.
* Configuración de las dependencias del proyecto desde el pom.xml
* Descarga automática de dependencias desde repositorios remotos de Maven.
* Editor gráfico del POM, incluyendo agregado de dependencias con Autocomplete.
* Wizards para la creación de proyectos Maven y para la conversión de proyectos sin Maven.

Update site: http://m2eclipse.sonatype.org/sites/m2e

Para poder montar un proyecto en Eclipse, primero deberemos generar los archivos de configuración para el IDE. Esto realiza invocando la tarea:

mvn eclipse:eclipse

Una vez ejecutada correctamente, el proyecto se puede montar en Eclipse accediendo a: File -> Import y en esa ventana General -> Existing Projects into Workspace.

En caso que se vaya a trabajar con varios projectos en simultáneo (a través de un POM multiproyecto), es necesario realizar un paso previo para que el plugin de eclipse pueda interpretar correctamente las dependencias.

mvn install
mvn eclipse:eclipse

== NetBeans ==

== Mas Detalles ==
* [http://m2eclipse.sonatype.org/ M2Eclipse Home Page]
* [[Maven]]

MTOM

2010-03-31T18:54:23Z

Pocho: /* Ver también */

MTOM es un mecanismo optimizado, declarado por la W3C, para la transmisión de datos binarios a través de un [[Web Service]].

La eficiencia de este mecanismo reside en el tamaño del texto que genera al transformar los datos binarios a texto. Transformación obligatoria al utilizar servicios web, ya que usan xml.

== Ver también ==
* [[MTOM con Spring Web Services]]
* [[Web Service]]
* [[Spring Web Services]]
* [http://www.w3.org/TR/soap12-mtom/ SOAP Message Transmission Optimization Mechanism - MTOM en W3]

[[Categoría:Web Service]]

MTOM

2010-03-31T18:54:09Z

Pocho: /* Ver también */

MTOM es un mecanismo optimizado, declarado por la W3C, para la transmisión de datos binarios a través de un [[Web Service]].

La eficiencia de este mecanismo reside en el tamaño del texto que genera al transformar los datos binarios a texto. Transformación obligatoria al utilizar servicios web, ya que usan xml.

== Ver también ==
* [[MTOM con Spring Web Services]]
* [[Web Service]]
* [[Spring Web Services]]
* [[http://www.w3.org/TR/soap12-mtom/ SOAP Message Transmission Optimization Mechanism - MTOM en W3]]

[[Categoría:Web Service]]

MTOM con Spring Web Services

2010-03-22T13:54:21Z

Pocho:

[[Spring Web Services]] tiene soporte para poder publicar y consumir web services que adjuntan un archivo, utilizando el protocolo [[MTOM]].

A continuación vamos a ver un ejemplo concreto de publicación e invocación a un Web Service de prueba.

== Servidor ==

Para el servidor, vamos a crear un modulo web. La configuración del servlet de Spring Web Services es la estándar y vamos a hacer foco en los pasos siguientes.

=== Publicacion del servicio ===

La idea para este ejemplo es crear un servicio que sea la interfaz de un repositorio de archivos pdf, por lo tanto, deberíamos poder pasarle el nombre de un archivo y éste debería retornar el mismo en caso de encontrarlo. Teniendo en mente esto, creamos nuestro contrato (contract-first):

<code xml>

<element name="LoadPdfRequest" type="string"/>


<element name="LoadPdfResponse" type="tns:Pdf"/>

<complexType name="Pdf">
<sequence>
<element name="name" type="string"/>
<element name="file" type="base64Binary" xmime:expectedContentTypes="application/pdf"/>
</sequence>
</complexType>
</code>

De lo anterior, debemos prestar atención a la definición del archivo, en donde le indicamos que es del tipo "base64Binary". Una vez resuelto el contrato, debemos decirle a Spring Web Services que lo publique. Esto lo hacemos a traves de un bean especifico que a partir de un schema, crea el WSDL:

<code xml>
<bean id="mtom" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
<property name="schema" ref="schema"/>
<property name="portTypeName" value="PdfRepository"/>
<property name="locationUri" value="/ws/pdf"/>
</bean>
</code>

=== Procesar invocación ===

Debemos configurar la aplicación, para que pueda procesar pedidos del servicio que publicamos en el paso anterior.

Primero definimos un bean que busca la anotacion @Endpoint (un endpoint es el encargado de procesar el pedido):

<code xml>
<bean class="org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping" />
</code>

Luego definimos un adaptador, para que procese el pedido de forma que el endpoint lo pueda entender. Lo mismo hace con la respuesta:

<code xml>

<bean class="org.springframework.ws.server.endpoint.adapter.GenericMarshallingMethodEndpointAdapter">
<constructor-arg ref="marshaller"/>
</bean>
</code>

Este adaptador necesita de un serializador. Aca es donde entra el manejo del archivo binario. Vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.springws.ejemplos.mtom.schema"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

El próximo paso es generar a partir del esquema, las clases de 'bindeo' de '''JAXB'''. Para esto hay varias herramientas. En nuestro caso utilizamos el NetBeans (6.8): click derecho en el proyecto -> New.. -> Xml -> JAXB Binding. Entre las opciones que figuran, por un lado debemos elegir el .xsd que definimos anteriormente y por el otro el ''Package Name'', que debe concordar con el valor del ''contextPath'' que le pusimos en la configuración al Jaxb2Marshaller (en nuestro caso "com.dosideas.springws.ejemplos.mtom.schema").

Una vez configurado JAXB, podemos proceder a implementar el endpoint:

<code java5>
@Endpoint
public class PdfRepositorioEndPoint {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();

@PayloadRoot(localPart = "LoadPdfRequest", namespace = "http://www.dosideas.com/spring-ws/ejemplos/mtom")
public JAXBElement<Pdf> pedidoPdf(JAXBElement<String> requestElement) throws IOException {
String nombrePdf = requestElement.getValue();
Pdf response = new Pdf();
response.setName(nombrePdf);
//Se puede crear un DataHandler de muchas formas. Aca una simple para el ejemplo.
response.setFile(new DataHandler(getClass().getResource(nombrePdf)));

return objectFactory.createLoadPdfResponse(response);
}
}
</code>

Debemos prestarle atención a la creación del ''DataHandler'', el cual se encarga de nuestro archivo binario. Luego es manejo trivial de Spring Web Services y JAXB.

== Cliente ==

Si bien el cliente podría ser un test del servidor, vamos a crear en este ejemplo otro modulo web, por un lado para no confundir la configuración entre cliente y servidor y por el otro para poder visualizar en el browser el pdf.

Básicamente vamos a tener un servlet, que invoca al servicio y luego escribe el pdf a la pagina.

=== Configurar cliente ===

En el ejemplo que se pueden bajar, van a encontrar dos implementaciones, una con Saaj (SOAP with Attachments API for Java) y otra con Axiom (Axis Object Model). A continuación vamos a detallar la implementación con Saaj.

Primero definimos un bean, indicando donde esta el servicio:

<code xml>

<bean id="client" abstract="true">
<property name="defaultUri" value="http://localhost:7001/mtom-pdf/ws/pdf"/>
</bean>
</code>

Luego definimos el cliente:

<code xml>

<bean id="saajClient" class="com.dosideas.mtom.ws.SaajMtomClient" parent="client">
<constructor-arg>
<bean class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>
</constructor-arg>
<property name="marshaller" ref="marshaller"/>
<property name="unmarshaller" ref="marshaller"/>
</bean>
</code>

En el caso de utilizar Saaj, vamos a necesitar indicarle un serializador, y al igual que en el servidor, vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.mtom.cliente.sws"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

=== Implementar el cliente ===

Para invocar servicios, Spring Web Services provee de una clase utilitaria que facilita bastante las cosas: '''WebServiceTemplate'''. En la configuración que realizamos en el paso anterior nos adelantamos a esto, indicándole a nuestro cliente donde estaba el servicio.

El WebServiceTemplate lo podemos obtener, heredando de '''WebServiceGatewaySupport''':

<code java5>
public class SaajMtomClient extends WebServiceGatewaySupport {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();
/**
* Construye el cliente a traves de la message factory.
* @param messageFactory message factory que utiliza SAAJ.
*/
public SaajMtomClient(SaajSoapMessageFactory messageFactory) {
super(messageFactory);
}
</code>

Lo que resta es el método principal que se encargue de enviar el pedido y procesar la respuesta:

<code java5>
/**
* Carga un pdf en un DataHandler para luego poder leerlo.
* @param path donde se encuentra el pdf.
* @return un DataHandler que contiene el pdf.
*/
public DataHandler loadPdf(String path) {
//generar el pedido a traves de la clase de bindeo de JAXB
JAXBElement<String> loadPdfRequest = objectFactory.createLoadPdfRequest(StringUtils.getFilename(path));
//invocar al servicio con el WebServiceTemplate
JAXBElement<Pdf> loadPdfResponse =
(JAXBElement<Pdf>) getWebServiceTemplate().marshalSendAndReceive(loadPdfRequest);

Pdf pdf = loadPdfResponse.getValue();//clase bindeada con JAXB

return pdf.getFile();
}
</code>

La clase '''DataHandler''' nos permite obtener un '''InputStream''' para ir leyendo el pdf.

La implementación del Servlet es bastante trivial y se puede ver en detalle en el archivo adjunto que esta disponible para bajar.

Solo resta configurar el modulo para que levante la configuración de Spring Web Services. En el web.xml definimos un listener y le indicamos donde esta el archivo con la configuración:

<code xml>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
classpath:cliente-springws.xml
</param-value>
</context-param>

<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
</code>

== Ver también ==
* [[Spring Web Services]]

[[Category:Web Service]]

MTOM con Spring Web Services

2010-03-22T13:52:54Z

Pocho:

[[Spring Web Services]] tiene soporte para poder publicar y consumir web services que adjuntan un archivo, utilizando el protocolo [[MTOM]].

A continuación vamos a ver un ejemplo concreto de publicación e invocación a un Web Service de prueba.

== Servidor ==

Para el servidor, vamos a crear un modulo web. La configuración del servlet de Spring Web Services es la estándar y vamos a hacer foco en los pasos siguientes.

=== Publicacion del servicio ===

La idea para este ejemplo es crear un servicio que sea la interfaz de un repositorio de archivos pdf, por lo tanto, deberíamos poder pasarle el nombre de un archivo y éste debería retornar el mismo en caso de encontrarlo. Teniendo en mente esto, creamos nuestro contrato (contract-first):

<code xml>

<element name="LoadPdfRequest" type="string"/>


<element name="LoadPdfResponse" type="tns:Pdf"/>

<complexType name="Pdf">
<sequence>
<element name="name" type="string"/>
<element name="file" type="base64Binary" xmime:expectedContentTypes="application/pdf"/>
</sequence>
</complexType>
</code>

De lo anterior, debemos prestar atención a la definición del archivo, en donde le indicamos que es del tipo "base64Binary". Una vez resuelto el contrato, debemos decirle a Spring Web Services que lo publique. Esto lo hacemos a traves de un bean especifico que a partir de un schema, crea el WSDL:

<code xml>
<bean id="mtom" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
<property name="schema" ref="schema"/>
<property name="portTypeName" value="PdfRepository"/>
<property name="locationUri" value="/ws/pdf"/>
</bean>
</code>

=== Procesar invocación ===

Debemos configurar la aplicación, para que pueda procesar pedidos del servicio que publicamos en el paso anterior.

Primero definimos un bean que busca la anotacion @Endpoint (un endpoint es el encargado de procesar el pedido):

<code xml>
<bean class="org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping" />
</code>

Luego definimos un adaptador, para que procese el pedido de forma que el endpoint lo pueda entender. Lo mismo hace con la respuesta:

<code xml>

<bean class="org.springframework.ws.server.endpoint.adapter.GenericMarshallingMethodEndpointAdapter">
<constructor-arg ref="marshaller"/>
</bean>
</code>

Este adaptador necesita de un serializador. Aca es donde entra el manejo del archivo binario. Vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.springws.ejemplos.mtom.schema"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

El próximo paso es generar a partir del esquema, las clases de 'bindeo' de '''JAXB'''. Para esto hay varias herramientas. En nuestro caso utilizamos el NetBeans (6.8): click derecho en el proyecto -> New.. -> Xml -> JAXB Binding. Entre las opciones que figuran, por un lado debemos elegir el .xsd que definimos anteriormente y por el otro el ''Package Name'', que debe concordar con el valor del ''contextPath'' que le pusimos en la configuración al Jaxb2Marshaller (en nuestro caso "com.dosideas.springws.ejemplos.mtom.schema").

Una vez configurado JAXB, podemos proceder a implementar el endpoint:

<code java5>
@Endpoint
public class PdfRepositorioEndPoint {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();

@PayloadRoot(localPart = "LoadPdfRequest", namespace = "http://www.dosideas.com/spring-ws/ejemplos/mtom")
public JAXBElement<Pdf> pedidoPdf(JAXBElement<String> requestElement) throws IOException {
String nombrePdf = requestElement.getValue();
Pdf response = new Pdf();
response.setName(nombrePdf);
//Se puede crear un DataHandler de muchas formas. Aca una simple para el ejemplo.
response.setFile(new DataHandler(getClass().getResource(nombrePdf)));

return objectFactory.createLoadPdfResponse(response);
}
}
</code>

Debemos prestarle atención a la creación del ''DataHandler'', el cual se encarga de nuestro archivo binario. Luego es manejo trivial de Spring Web Services y JAXB.

== Cliente ==

Si bien el cliente podría ser un test del servidor, vamos a crear en este ejemplo otro modulo web, por un lado para no confundir la configuración entre cliente y servidor y por el otro para poder visualizar en el browser el pdf.

Básicamente vamos a tener un servlet, que invoca al servicio y luego escribe el pdf a la pagina.

=== Configurar cliente ===

En el ejemplo que se pueden bajar, van a encontrar dos implementaciones, una con Saaj (SOAP with Attachments API for Java) y otra con Axiom (Axis Object Model). A continuación vamos a detallar la implementación con Saaj.

Primero definimos un bean, indicando donde esta el servicio:

<code xml>

<bean id="client" abstract="true">
<property name="defaultUri" value="http://localhost:7001/mtom-pdf/ws/pdf"/>
</bean>
</code>

Luego definimos el cliente:

<code xml>

<bean id="saajClient" class="com.dosideas.mtom.ws.SaajMtomClient" parent="client">
<constructor-arg>
<bean class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>
</constructor-arg>
<property name="marshaller" ref="marshaller"/>
<property name="unmarshaller" ref="marshaller"/>
</bean>
</code>

En el caso de utilizar Saaj, vamos a necesitar indicarle un serializador, y al igual que en el servidor, vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.mtom.cliente.sws"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

=== Implementar el cliente ===

Para invocar servicios, Spring Web Services provee de una clase utilitaria que facilita bastante las cosas: '''WebServiceTemplate'''. En la configuración que realizamos en el paso anterior nos adelantamos a esto, indicándole a nuestro cliente donde estaba el servicio.

El WebServiceTemplate lo podemos obtener, heredando de '''WebServiceGatewaySupport''':

<code java5>
public class SaajMtomClient extends WebServiceGatewaySupport {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();
/**
* Construye el cliente a traves de la message factory.
* @param messageFactory message factory que utiliza SAAJ.
*/
public SaajMtomClient(SaajSoapMessageFactory messageFactory) {
super(messageFactory);
}
</code>

Lo que resta es el método principal que se encargue de enviar el pedido y procesar la respuesta:

<code java5>
/**
* Carga un pdf en un DataHandler para luego poder leerlo.
* @param path donde se encuentra el pdf.
* @return un DataHandler que contiene el pdf.
*/
public DataHandler loadPdf(String path) {
//generar el pedido a traves de la clase de bindeo de JAXB
JAXBElement<String> loadPdfRequest = objectFactory.createLoadPdfRequest(StringUtils.getFilename(path));
//invocar al servicio con el WebServiceTemplate
JAXBElement<Pdf> loadPdfResponse =
(JAXBElement<Pdf>) getWebServiceTemplate().marshalSendAndReceive(loadPdfRequest);

Pdf pdf = loadPdfResponse.getValue();//clase bindeada con JAXB

return pdf.getFile();
}
</code>

La clase '''DataHandler''' nos permite obtener un '''InputStream''' para ir leyendo el pdf.

La implementación del Servlet es bastante trivial y se puede ver en detalle en el archivo adjunto que esta disponible para bajar.

Solo resta configurar el modulo para que levante la configuración de Spring Web Services. En el web.xml definimos un listener y le indicamos donde esta el archivo con la configuración:

<code xml>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
classpath:cliente-springws.xml
</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
</code>

== Ver también ==
* [[Spring Web Services]]

[[Category:Spring Framework]]
[[Category:Web Service]]

MTOM con Spring Web Services

2010-03-22T13:49:20Z

Pocho: /* Implementar el cliente */

[[Spring Web Services]] tiene soporte para poder publicar y consumir web services que adjuntan un archivo, utilizando el protocolo [[MTOM]].

A continuación vamos a ver un ejemplo concreto de publicación e invocación a un Web Service de prueba.

== Servidor ==

Para el servidor, vamos a crear un modulo web. La configuración del servlet de Spring Web Services es la estándar y vamos a hacer foco en los pasos siguientes.

=== Publicacion del servicio ===

La idea para este ejemplo es crear un servicio que sea la interfaz de un repositorio de archivos pdf, por lo tanto, deberíamos poder pasarle el nombre de un archivo y éste debería retornar el mismo en caso de encontrarlo. Teniendo en mente esto, creamos nuestro contrato (contract-first):

<code xml>

<element name="LoadPdfRequest" type="string"/>


<element name="LoadPdfResponse" type="tns:Pdf"/>

<complexType name="Pdf">
<sequence>
<element name="name" type="string"/>
<element name="file" type="base64Binary" xmime:expectedContentTypes="application/pdf"/>
</sequence>
</complexType>
</code>

De lo anterior, debemos prestar atención a la definición del archivo, en donde le indicamos que es del tipo "base64Binary". Una vez resuelto el contrato, debemos decirle a Spring Web Services que lo publique. Esto lo hacemos a traves de un bean especifico que a partir de un schema, crea el WSDL:

<code xml>
<bean id="mtom" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
<property name="schema" ref="schema"/>
<property name="portTypeName" value="PdfRepository"/>
<property name="locationUri" value="/ws/pdf"/>
</bean>
</code>

=== Procesar invocación ===

Debemos configurar la aplicación, para que pueda procesar pedidos del servicio que publicamos en el paso anterior.

Primero definimos un bean que busca la anotacion @Endpoint (un endpoint es el encargado de procesar el pedido):

<code xml>
<bean class="org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping" />
</code>

Luego definimos un adaptador, para que procese el pedido de forma que el endpoint lo pueda entender. Lo mismo hace con la respuesta:

<code xml>

<bean class="org.springframework.ws.server.endpoint.adapter.GenericMarshallingMethodEndpointAdapter">
<constructor-arg ref="marshaller"/>
</bean>
</code>

Este adaptador necesita de un serializador. Aca es donde entra el manejo del archivo binario. Vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.springws.ejemplos.mtom.schema"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

El próximo paso es generar a partir del esquema, las clases de 'bindeo' de '''JAXB'''. Para esto hay varias herramientas. En nuestro caso utilizamos el NetBeans (6.8): click derecho en el proyecto -> New.. -> Xml -> JAXB Binding. Entre las opciones que figuran, por un lado debemos elegir el .xsd que definimos anteriormente y por el otro el ''Package Name'', que debe concordar con el valor del ''contextPath'' que le pusimos en la configuración al Jaxb2Marshaller (en nuestro caso "com.dosideas.springws.ejemplos.mtom.schema").

Una vez configurado JAXB, podemos proceder a implementar el endpoint:

<code java5>
@Endpoint
public class PdfRepositorioEndPoint {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();

@PayloadRoot(localPart = "LoadPdfRequest", namespace = "http://www.dosideas.com/spring-ws/ejemplos/mtom")
public JAXBElement<Pdf> pedidoPdf(JAXBElement<String> requestElement) throws IOException {
String nombrePdf = requestElement.getValue();
Pdf response = new Pdf();
response.setName(nombrePdf);
//Se puede crear un DataHandler de muchas formas. Aca una simple para el ejemplo.
response.setFile(new DataHandler(getClass().getResource(nombrePdf)));

return objectFactory.createLoadPdfResponse(response);
}
}
</code>

Debemos prestarle atención a la creación del ''DataHandler'', el cual se encarga de nuestro archivo binario. Luego es manejo trivial de Spring Web Services y JAXB.

== Cliente ==

Si bien el cliente podría ser un test del servidor, vamos a crear en este ejemplo otro modulo web, por un lado para no confundir la configuración entre cliente y servidor y por el otro para poder visualizar en el browser el pdf.

Básicamente vamos a tener un servlet, que invoca al servicio y luego escribe el pdf a la pagina.

=== Configurar cliente ===

En el ejemplo que se pueden bajar, van a encontrar dos implementaciones, una con Saaj (SOAP with Attachments API for Java) y otra con Axiom (Axis Object Model). A continuación vamos a detallar la implementación con Saaj.

Primero definimos un bean, indicando donde esta el servicio:

<code xml>

<bean id="client" abstract="true">
<property name="defaultUri" value="http://localhost:7001/mtom-pdf/ws/pdf"/>
</bean>
</code>

Luego definimos el cliente:

<code xml>

<bean id="saajClient" class="com.dosideas.mtom.ws.SaajMtomClient" parent="client">
<constructor-arg>
<bean class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>
</constructor-arg>
<property name="marshaller" ref="marshaller"/>
<property name="unmarshaller" ref="marshaller"/>
</bean>
</code>

En el caso de utilizar Saaj, vamos a necesitar indicarle un serializador, y al igual que en el servidor, vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.mtom.cliente.sws"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

=== Implementar el cliente ===

Para invocar servicios, Spring Web Services provee de una clase utilitaria que facilita bastante las cosas: '''WebServiceTemplate'''. En la configuración que realizamos en el paso anterior nos adelantamos a esto, indicándole a nuestro cliente donde estaba el servicio.

El WebServiceTemplate lo podemos obtener, heredando de '''WebServiceGatewaySupport''':

<code java5>
public class SaajMtomClient extends WebServiceGatewaySupport {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();
/**
* Construye el cliente a traves de la message factory.
* @param messageFactory message factory que utiliza SAAJ.
*/
public SaajMtomClient(SaajSoapMessageFactory messageFactory) {
super(messageFactory);
}
</code>

Lo que resta es el método principal que se encargue de enviar el pedido y procesar la respuesta:

<code java5>
/**
* Carga un pdf en un DataHandler para luego poder leerlo.
* @param path donde se encuentra el pdf.
* @return un DataHandler que contiene el pdf.
*/
public DataHandler loadPdf(String path) {
//generar el pedido a traves de la clase de bindeo de JAXB
JAXBElement<String> loadPdfRequest = objectFactory.createLoadPdfRequest(StringUtils.getFilename(path));
//invocar al servicio con el WebServiceTemplate
JAXBElement<Pdf> loadPdfResponse =
(JAXBElement<Pdf>) getWebServiceTemplate().marshalSendAndReceive(loadPdfRequest);

Pdf pdf = loadPdfResponse.getValue();//clase bindeada con JAXB

return pdf.getFile();
}
</code>

La clase '''DataHandler''' nos permite obtener un '''InputStream''' para ir leyendo el pdf.

== Ver también ==
* [[Spring Web Services]]

[[Category:Spring Framework]]
[[Category:Web Service]]

MTOM con Spring Web Services

2010-03-22T13:47:42Z

Pocho: /* Implementar el cliete */

[[Spring Web Services]] tiene soporte para poder publicar y consumir web services que adjuntan un archivo, utilizando el protocolo [[MTOM]].

A continuación vamos a ver un ejemplo concreto de publicación e invocación a un Web Service de prueba.

== Servidor ==

Para el servidor, vamos a crear un modulo web. La configuración del servlet de Spring Web Services es la estándar y vamos a hacer foco en los pasos siguientes.

=== Publicacion del servicio ===

La idea para este ejemplo es crear un servicio que sea la interfaz de un repositorio de archivos pdf, por lo tanto, deberíamos poder pasarle el nombre de un archivo y éste debería retornar el mismo en caso de encontrarlo. Teniendo en mente esto, creamos nuestro contrato (contract-first):

<code xml>

<element name="LoadPdfRequest" type="string"/>


<element name="LoadPdfResponse" type="tns:Pdf"/>

<complexType name="Pdf">
<sequence>
<element name="name" type="string"/>
<element name="file" type="base64Binary" xmime:expectedContentTypes="application/pdf"/>
</sequence>
</complexType>
</code>

De lo anterior, debemos prestar atención a la definición del archivo, en donde le indicamos que es del tipo "base64Binary". Una vez resuelto el contrato, debemos decirle a Spring Web Services que lo publique. Esto lo hacemos a traves de un bean especifico que a partir de un schema, crea el WSDL:

<code xml>
<bean id="mtom" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
<property name="schema" ref="schema"/>
<property name="portTypeName" value="PdfRepository"/>
<property name="locationUri" value="/ws/pdf"/>
</bean>
</code>

=== Procesar invocación ===

Debemos configurar la aplicación, para que pueda procesar pedidos del servicio que publicamos en el paso anterior.

Primero definimos un bean que busca la anotacion @Endpoint (un endpoint es el encargado de procesar el pedido):

<code xml>
<bean class="org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping" />
</code>

Luego definimos un adaptador, para que procese el pedido de forma que el endpoint lo pueda entender. Lo mismo hace con la respuesta:

<code xml>

<bean class="org.springframework.ws.server.endpoint.adapter.GenericMarshallingMethodEndpointAdapter">
<constructor-arg ref="marshaller"/>
</bean>
</code>

Este adaptador necesita de un serializador. Aca es donde entra el manejo del archivo binario. Vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.springws.ejemplos.mtom.schema"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

El próximo paso es generar a partir del esquema, las clases de 'bindeo' de '''JAXB'''. Para esto hay varias herramientas. En nuestro caso utilizamos el NetBeans (6.8): click derecho en el proyecto -> New.. -> Xml -> JAXB Binding. Entre las opciones que figuran, por un lado debemos elegir el .xsd que definimos anteriormente y por el otro el ''Package Name'', que debe concordar con el valor del ''contextPath'' que le pusimos en la configuración al Jaxb2Marshaller (en nuestro caso "com.dosideas.springws.ejemplos.mtom.schema").

Una vez configurado JAXB, podemos proceder a implementar el endpoint:

<code java5>
@Endpoint
public class PdfRepositorioEndPoint {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();

@PayloadRoot(localPart = "LoadPdfRequest", namespace = "http://www.dosideas.com/spring-ws/ejemplos/mtom")
public JAXBElement<Pdf> pedidoPdf(JAXBElement<String> requestElement) throws IOException {
String nombrePdf = requestElement.getValue();
Pdf response = new Pdf();
response.setName(nombrePdf);
//Se puede crear un DataHandler de muchas formas. Aca una simple para el ejemplo.
response.setFile(new DataHandler(getClass().getResource(nombrePdf)));

return objectFactory.createLoadPdfResponse(response);
}
}
</code>

Debemos prestarle atención a la creación del ''DataHandler'', el cual se encarga de nuestro archivo binario. Luego es manejo trivial de Spring Web Services y JAXB.

== Cliente ==

Si bien el cliente podría ser un test del servidor, vamos a crear en este ejemplo otro modulo web, por un lado para no confundir la configuración entre cliente y servidor y por el otro para poder visualizar en el browser el pdf.

Básicamente vamos a tener un servlet, que invoca al servicio y luego escribe el pdf a la pagina.

=== Configurar cliente ===

En el ejemplo que se pueden bajar, van a encontrar dos implementaciones, una con Saaj (SOAP with Attachments API for Java) y otra con Axiom (Axis Object Model). A continuación vamos a detallar la implementación con Saaj.

Primero definimos un bean, indicando donde esta el servicio:

<code xml>

<bean id="client" abstract="true">
<property name="defaultUri" value="http://localhost:7001/mtom-pdf/ws/pdf"/>
</bean>
</code>

Luego definimos el cliente:

<code xml>

<bean id="saajClient" class="com.dosideas.mtom.ws.SaajMtomClient" parent="client">
<constructor-arg>
<bean class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>
</constructor-arg>
<property name="marshaller" ref="marshaller"/>
<property name="unmarshaller" ref="marshaller"/>
</bean>
</code>

En el caso de utilizar Saaj, vamos a necesitar indicarle un serializador, y al igual que en el servidor, vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.mtom.cliente.sws"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

=== Implementar el cliente ===

Para invocar servicios, Spring Web Services provee de una clase utilitaria que facilita bastante las cosas: '''WebServiceTemplate'''. En la configuración que realizamos en el paso anterior nos adelantamos a esto, indicándole a nuestro cliente donde estaba el servicio.

El WebServiceTemplate lo podemos obtener, heredando de '''WebServiceGatewaySupport''':

<code java5>
public class SaajMtomClient extends WebServiceGatewaySupport {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();
/**
* Construye el cliente a traves de la message factory.
* @param messageFactory message factory que utiliza SAAJ.
*/
public SaajMtomClient(SaajSoapMessageFactory messageFactory) {
super(messageFactory);
}
</code>

Lo que resta es el método principal que se encargue de enviar el pedido y procesar la respuesta:

<code java5>
/**
* Carga un pdf en un DataHandler para luego poder leerlo.
* @param path donde se encuentra el pdf.
* @return un DataHandler que contiene el pdf.
*/
public DataHandler loadPdf(String path) {
//pedido
JAXBElement<String> loadPdfRequest = objectFactory.createLoadPdfRequest(StringUtils.getFilename(path));
//respuesta
JAXBElement<Pdf> loadPdfResponse =
(JAXBElement<Pdf>) getWebServiceTemplate().marshalSendAndReceive(loadPdfRequest);

Pdf pdf = loadPdfResponse.getValue();

return pdf.getFile();
}
<code>

La clase '''DataHandler''' nos permite obtener un '''InputStream''' para ir leyendo el pdf.

== Ver también ==
* [[Spring Web Services]]

[[Category:Spring Framework]]
[[Category:Web Service]]

MTOM con Spring Web Services

2010-03-22T13:46:25Z

Pocho:

[[Spring Web Services]] tiene soporte para poder publicar y consumir web services que adjuntan un archivo, utilizando el protocolo [[MTOM]].

A continuación vamos a ver un ejemplo concreto de publicación e invocación a un Web Service de prueba.

== Servidor ==

Para el servidor, vamos a crear un modulo web. La configuración del servlet de Spring Web Services es la estándar y vamos a hacer foco en los pasos siguientes.

=== Publicacion del servicio ===

La idea para este ejemplo es crear un servicio que sea la interfaz de un repositorio de archivos pdf, por lo tanto, deberíamos poder pasarle el nombre de un archivo y éste debería retornar el mismo en caso de encontrarlo. Teniendo en mente esto, creamos nuestro contrato (contract-first):

<code xml>

<element name="LoadPdfRequest" type="string"/>


<element name="LoadPdfResponse" type="tns:Pdf"/>

<complexType name="Pdf">
<sequence>
<element name="name" type="string"/>
<element name="file" type="base64Binary" xmime:expectedContentTypes="application/pdf"/>
</sequence>
</complexType>
</code>

De lo anterior, debemos prestar atención a la definición del archivo, en donde le indicamos que es del tipo "base64Binary". Una vez resuelto el contrato, debemos decirle a Spring Web Services que lo publique. Esto lo hacemos a traves de un bean especifico que a partir de un schema, crea el WSDL:

<code xml>
<bean id="mtom" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
<property name="schema" ref="schema"/>
<property name="portTypeName" value="PdfRepository"/>
<property name="locationUri" value="/ws/pdf"/>
</bean>
</code>

=== Procesar invocación ===

Debemos configurar la aplicación, para que pueda procesar pedidos del servicio que publicamos en el paso anterior.

Primero definimos un bean que busca la anotacion @Endpoint (un endpoint es el encargado de procesar el pedido):

<code xml>
<bean class="org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping" />
</code>

Luego definimos un adaptador, para que procese el pedido de forma que el endpoint lo pueda entender. Lo mismo hace con la respuesta:

<code xml>

<bean class="org.springframework.ws.server.endpoint.adapter.GenericMarshallingMethodEndpointAdapter">
<constructor-arg ref="marshaller"/>
</bean>
</code>

Este adaptador necesita de un serializador. Aca es donde entra el manejo del archivo binario. Vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.springws.ejemplos.mtom.schema"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

El próximo paso es generar a partir del esquema, las clases de 'bindeo' de '''JAXB'''. Para esto hay varias herramientas. En nuestro caso utilizamos el NetBeans (6.8): click derecho en el proyecto -> New.. -> Xml -> JAXB Binding. Entre las opciones que figuran, por un lado debemos elegir el .xsd que definimos anteriormente y por el otro el ''Package Name'', que debe concordar con el valor del ''contextPath'' que le pusimos en la configuración al Jaxb2Marshaller (en nuestro caso "com.dosideas.springws.ejemplos.mtom.schema").

Una vez configurado JAXB, podemos proceder a implementar el endpoint:

<code java5>
@Endpoint
public class PdfRepositorioEndPoint {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();

@PayloadRoot(localPart = "LoadPdfRequest", namespace = "http://www.dosideas.com/spring-ws/ejemplos/mtom")
public JAXBElement<Pdf> pedidoPdf(JAXBElement<String> requestElement) throws IOException {
String nombrePdf = requestElement.getValue();
Pdf response = new Pdf();
response.setName(nombrePdf);
//Se puede crear un DataHandler de muchas formas. Aca una simple para el ejemplo.
response.setFile(new DataHandler(getClass().getResource(nombrePdf)));

return objectFactory.createLoadPdfResponse(response);
}
}
</code>

Debemos prestarle atención a la creación del ''DataHandler'', el cual se encarga de nuestro archivo binario. Luego es manejo trivial de Spring Web Services y JAXB.

== Cliente ==

Si bien el cliente podría ser un test del servidor, vamos a crear en este ejemplo otro modulo web, por un lado para no confundir la configuración entre cliente y servidor y por el otro para poder visualizar en el browser el pdf.

Básicamente vamos a tener un servlet, que invoca al servicio y luego escribe el pdf a la pagina.

=== Configurar cliente ===

En el ejemplo que se pueden bajar, van a encontrar dos implementaciones, una con Saaj (SOAP with Attachments API for Java) y otra con Axiom (Axis Object Model). A continuación vamos a detallar la implementación con Saaj.

Primero definimos un bean, indicando donde esta el servicio:

<code xml>

<bean id="client" abstract="true">
<property name="defaultUri" value="http://localhost:7001/mtom-pdf/ws/pdf"/>
</bean>
</code>

Luego definimos el cliente:

<code xml>

<bean id="saajClient" class="com.dosideas.mtom.ws.SaajMtomClient" parent="client">
<constructor-arg>
<bean class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>
</constructor-arg>
<property name="marshaller" ref="marshaller"/>
<property name="unmarshaller" ref="marshaller"/>
</bean>
</code>

En el caso de utilizar Saaj, vamos a necesitar indicarle un serializador, y al igual que en el servidor, vamos a utilizar JAXB:

<code xml>

<bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPath" value="com.dosideas.mtom.cliente.sws"/>
<property name="mtomEnabled" value="true"/>
</bean>
</code>

=== Implementar el cliete ===

Para invocar servicios, Spring Web Services provee de una clase utilitaria que facilita bastante las cosas: '''WebServiceTemplate'''. En la configuración que realizamos en el paso anterior nos adelantamos a esto, indicándole a nuestro cliente donde estaba el servicio.

El WebServiceTemplate lo podemos obtener, heredando de ''WebServiceGatewaySupport''':

<code java5>
public class SaajMtomClient extends WebServiceGatewaySupport {
/**
* object factory creada por JAXB para bindear clases con el schema.
*/
private ObjectFactory objectFactory = new ObjectFactory();
/**
* Construye el cliente a traves de la message factory.
* @param messageFactory message factory que utiliza SAAJ.
*/
public SaajMtomClient(SaajSoapMessageFactory messageFactory) {
super(messageFactory);
}
</code>

Lo que resta es el método principal que se encargue de enviar el pedido y procesar la respuesta:

<code java5>
/**
* Carga un pdf en un DataHandler para luego poder leerlo.
* @param path donde se encuentra el pdf.
* @return un DataHandler que contiene el pdf.
*/
public DataHandler loadPdf(String path) {
//pedido
JAXBElement<String> loadPdfRequest = objectFactory.createLoadPdfRequest(StringUtils.getFilename(path));
//respuesta
JAXBElement<Pdf> loadPdfResponse =
(JAXBElement<Pdf>) getWebServiceTemplate().marshalSendAndReceive(loadPdfRequest);

Pdf pdf = loadPdfResponse.getValue();

return pdf.getFile();
}
<code>

La clase '''DataHandler''' nos permite obtener un '''InputStream''' para ir leyendo el pdf.

== Ver también ==
* [[Spring Web Services]]

[[Category:Spring Framework]]
[[Category:Web Service]]

MTOM con Spring Web Services

2010-03-22T13:11:33Z

Pocho: /* Procesar invocación */

MTOM con Spring Web Services

2010-03-19T20:15:17Z

Pocho: Página creada con 'Spring Web Services tiene soporte para poder publicar y consumir web services que adjuntan un archivo, utilizando el protocolo MTOM. A continuación vamos a ver un ejem…'

MTOM

2010-03-19T19:18:25Z

Pocho: Página creada con 'MTOM es un mecanismo optimizado, declarado por la W3C, para la transmisión de datos binarios a través de un Web Service. La eficiencia de este mecanismo reside en el tama…'

XStream

2009-04-03T17:57:12Z

Pocho:

XStream es una libreria [[Java]] para la serializacion y deserealizacion de objetos a XML (o también [[JSON]]).

==Encoding del XML==
XStream utiliza Writers para generar los XML, usando el encoding por default de la plataforma. Para cambiarlo, es necesario proveer a XStream con un Writer propio, que contenga el encoding deseado.

Para hacer esto basta programar:
<code java>
private static final String ENCODING = "ISO-8859-1";

.....

OutputStream os = new ByteArrayOutputStream();
OutputStreamWriter osw = new OutputStreamWriter(os, ENCODING);

XStream xstream = new XStream();
xstream.toXML(objetoParaTransformar, osw);

String xml = os.toString();

osw.close();
os.close();
</code>

La variable ENCODING puede tener alguno de los nombres de los charset estándares, o incluso algunos encoding no comunes.

=== El XML con el encabezado correspondiente ===

XStream no genera el encabezado de los XML, donde se indica el encoding usado. Es necesario entonces que lo generemos nosotros antes de devolver el xml.

De esta forma:
<code java>
private static final String ENCODING = "ISO-8859-1";

.....

XStream xstream = new XStream();
OutputStream os = new ByteArrayOutputStream();
OutputStreamWriter osw = new OutputStreamWriter(os, ENCODING);

xstream.toXML(objetoParaTransformar, osw);

String header = "<?xml version=\"1.0\" encoding=\"" + osw.getEncoding() + "\"?>\n";

StringBuffer xml = new StringBuffer();
xml.append(header);
xml.append(os.toString());
</code>

Noten que creamos el encabezado para el XML, indicando el encoding que usaremos. Luego, concatenamos este encabezado al xml resultante.

== Ejemplo de uso ==
El [http://xstream.codehaus.org/tutorial.html Tutorial de XStream] tiene un ejemplo claro y simple de uso.

Con XStream cuando serializamos una clase los tags del XML generado quedan con el nombre de los atributos de esta clase. Por ejemplo, aca vemos como serializamos el siguiente DTO compuesto:
===Los objetos a serializar===
<code java>
public class PersonaDTO {

private String identidad;
private Long edad;
private DocumentoDTO documentoIdentidad;

// Getters y Setters
}

public class DocumentoDTO {
private Long numero;
private String tipo;

// Getters y Setters
}
</code>

===Serialización===
<code java>
import com.thoughtworks.xstream.XStream;

public class XStreamConAnnotation {
public String toXml(PersonaDTO dto) {
XStream xstream = new XStream();
return (String) xstream.toXML(dto);
}
}
</code>

===XML resultante===
Lo cual genera el siguiente XML:
<code xml>
<test.PersonaDTO.java>
<identidad>Juancito</identidad>
<edad>16</edad>
<documentoIdentidad>
<numero>35123125</numero>
<tipo>DNI</tipo>
</documentoIdentidad>
</test.PersonaDTO.java>
</code>

Es posible cambiar los nombres de los atributos en el XML utilizando los alias que provee XStream.

==Ejemplo de uso con anotaciones==
Desde la version 1.3 de [XStream] se agrego como funcionalidad la posibilidad de usar Annotations en lugar de los alias para establecer el mapeo entre las clases, los atributos y los tags de los XML.

Con esta nueva funcionalidad para modificar algun tag hay que hacer 2 cosas
# Anotar la clase
# Activar el uso de anotaciones al usar XStream

===Anotación de la clase===
En las clases a serializar hay que poner sobre el atributo (o clase) la annotation con el nombre que queremos que tenga una vez serializado. Ejemplo:

<code java>
@XStreamAlias("Persona")
public class PersonaDTO {

@XStreamAlias("nombre")
private String identidad;

@XStreamAlias("años")
private Long edad;

@XStreamAlias("documento")
private DocumentoDTO documentoIdentidad;

// Getters y Setters
}

public class DocumentoDTO {

@XStreamAlias("numeroDocumento")
private Long numero;

@XStreamAlias("tipoDocumento")
private String tipo;

// Getters y Setters
}
</code>

===Activación de anotaciones===
En el codigo que invoca a XStream se agrega para que procese las annotations, pasandole el .class de la clase que contiene las annotations.
<code java>
public class XStreamConAnnotation {

public String toXml(PersonaDTO dto) {
XStream xstream = new XStream();
xstream.autodetectAnnotations(true);

return (String) xstream.toXML(dto);
}
}
</code>

También es posible activar clase-por-clase el uso de anotaciones, con una línea similar a
xstream.processAnnotations(PersonaDTO.class);

===XML resultante===
<code xml>
<Persona>
<nombre>Juancito</nombre>
<años>16</años>
<documento>
<numeroDocumento>35123125</numeroDocumento>
<tipoDocumento>DNI</tipoDocumento>
</documento>
</Persona>
</code>

==Namespaces==
Es muy común con la utilización de Web Services que se tenga que procesar un xml que tiene definido un namespace. Por ejemplo:

<code xml>
<dosideas:Persona xmlns:dosideas="http://www.dosideas.com/wsdl/buscarClientes">
<nombre>Juancito</nombre>
<años>16</años>
</dosideas:body>
</code>

Si se quiere mapear el ejemplo anterior con la clase PersonaDTO (definida en otro ejemplo anteriormente), se deberá colocar el alias @XStreamAlias("'''dosideas:'''Persona"). Si solo se coloca @XStreamAlias("Persona"), XStream no sabra contra que clase mapear "dosideas:Persona" ya que desconoce los namespaces.

Como el namespace puede cambiar a gusto del consumidor (si es un Web Service por ejemplo), se deberá contar con algo mas genérico. Para solucionar este inconveniente se utiliza el StaxDriver que provee XStream, el cual permite especificar un map de QNames.

Un QName permite identificar un elemento o atributo de xml y tiene 3 componentes:
; Namespace URI : la definicion del namespace. En el ejemplo corresponde a ''xmlns:dosideas="ht..."''
; local part : el nombre del tag. En el ejemplo corresponde a ''Persona''
; prefix : el prefijo. En el ejemplo corresponde a ''dosideas''

Como se puede observar, lo que varia es el prefijo. Entonces se debe crear un QName dejando el prefijo en blanco. El código resultante para el ejemplo seria el siguiente:

<code java>
QNameMap qnameMap = new QNameMap();
QName qname = new QName("http://www.dosideas.com/wsdl/buscarClientes",
"Persona");
qnameMap.registerMapping(qname, PersonaDTO.class);
XStream xStream = new XStream(new StaxDriver(qnameMap));
</code>

==Conversores==
La librería xstream nos provee de una serie de conversores. La función de un conversor es la de convertir tipos de objetos particulares en xml o construir los mismos a partir de un xml.
Entre los conversores que tiene xstream se destacan: String, File, Collections, arrays, and Dates. En la página oficial de xstream se encuentra [http://xstream.codehaus.org/converters.html la lista de todos los conversores].

==Ejemplo de uso DateConverter==
El DateConverter en un conversor para el tipo de objeto java.util.Date.
Para usarlo debemos crear una nueva instancia indicando los formatos de fechas aceptados
El constructor recibe dos parámetros:

'''String defaultFormat:''' formato de la fecha que sera tomado por default.

'''String[] acceptableFormats:''' Array con todos los formatos de fecha aceptables.

Los formatos de la fecha esperados son los patrones de [http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html SimpleDateFormat].

El funcionamiento se describe así: cuando xstream encuentra un tag que esta mapeado a un objeto del tipo java.util.Date usara el conversor, el mismo tratará de convertir el tag usando el formato default, si falla ira probando los otros formatos aceptados hasta encontrar el adecuado, de no encontrarlo lanzará una ConversionException. Si se se esta convirtiendo un objeto Date a xml siempre se usara el formato default para convertirlo.

Supongamos que queremos convertir la siguiente clase usando el DateConverter:

<code java>
public class PersonaDTO {

private String identidad;
private Date fechaNacimiento;

// Getters y Setters
}
</code>

El formato esperado de la fecha será 'ddMMyyyy', el siguiente código muestra como crear y regisrar el DateConverter.

<code java>
class Main {
public static void main( String args[] ) {
//objetoq ue se convertira a xml usando DateConverter
PersonaDTO persona = new PersonaDTO();
persona.setIdentidad("dos ideas");
persona.setFechaNacimiento(new Date());

//se crea una nueva instancia de DateConverter con los formatos requeridos
String defaultFormat = "ddMMyyyy"
String[] acceptableFormats = new String[]{"yyyyMM"};
DateConverter dateConverter = new DateConverter(defaultFormat, acceptableFormats );

//ya instanciamos nuestro DateConverter, falta registralo
XStream xstream = new XStream();
xstream.registerConverter(dateConverter);

System.out.println(xstream.toXML(persona);
}
}
</code>

===XML resultante===
<code xml>
<Persona>
<identificacion>dos ideas</identificacion>
<fechaNacimiento>29112000</fechaNacimiento>
</Persona>
</code>

==Ver también==
* [[Serializacion De Objetos En Java]]
* [[JSON]]
* [http://xstream.codehaus.org/ Web oficial de XStream]
* [http://xstream.codehaus.org/tutorial.html Tutorial de XStream]
* [http://xstream.codehaus.org/json-tutorial.html Exportación a JSON con XStream]

Stored Procedures con Spring

2009-04-01T15:05:03Z

Pocho: Página creada con 'Spring Framework brinda una herramienta bastante práctica para invocar a stored procredures o funciones de forma de evitar el manejo de la conexión y facilitar el seteo de...'

[[Spring Framework]] brinda una herramienta bastante práctica para invocar a stored procredures o funciones de forma de evitar el manejo de la conexión y facilitar el seteo de los parámetros.

==SimpleJdbcCall==

Es una clase que provee Spring que representa la llamada a un stored procedure o store function. Se diferencia de cualquier otra clase utilitaria por leer la meta data de la base de datos, permitiendo que solo tengamos que pasarle en la invocación un map con los nombres de los parámetros y sus respectivos valores. No hace falta especificar los tipos de datos. Adicionalmente encapsula el manejo de la conexión y del statement (internamente usa otra clase mas genérica de Spring para JDBC llamada JdbcTemplate).

Como depende de la información que brinda la meta data, que es obtenida por el driver JDBC, las bases soportadas son Derby, MySQL, Microsoft SQL Server, Oracle y DB2.

===Ejemplo invocación===

<code java>
public class MiDao {

private SimpleJdbcCall miStoreProcedureCall;

public void buscarDireccion(String pametro1, String parametro2) {
SqlParameterSource mapIn = new MapSqlParameterSource()
.addValue("CODIGO_CLIENTE", pametro1)
.addValue("NUMERO_DOCUMENTO", parametro2);

Map<String, Object> out = getMiStoreProcedureCall().execute(mapIn);

String direccionCliente = (String) out.get("DIRECCION");

System.out.println("Invocacion exitosa. Direccion cliente: "+direccionCliente);
}
}
</code>

===Configuración===

En el ejemplo se decidió por inyectar la clase utilitaria, utilizando configuración en xml. De igual manera se podría haber hecho en el mismo código Java.

La clase SimpleJdbcCall necesita como parámetro del constructor el data source asociado a la base de datos en la cual se encuentra el store procedure.

En el ejemplo, el procedure se encuentra dentro de un package y de ahí una propiedad extra que hay que configurar (sino simplemente obviarla). Arhivo xml:

<code xml>
<beans>
<bean id="dataSourceApp" class="org.springframework.jndi.JndiObjectFactoryBean"
destroy-method="close">
<property name="jndiName" value="jdbc/miApp"/>
</bean>

<bean id="jdbc.miStoreP" class="org.springframework.jdbc.core.simple.SimpleJdbcCall">
<constructor-arg ref="dataSourceApp"/>
<property name="procedureName" value="BUSCAR_DIRECCION"/>
<property name="catalogName" value="PACKAGE_CLIENTES"/>
</bean>

<bean id="dao.MiDao" class="com.dosideas.MiDao">
<property name="miStoreProcedureCall" ref="jdbc.miStoreP"/>
</bean>
</beans>
</code>

==Schema==

Como se menciono anteriormente, esta clase se basa en la obtención de la meta data. Para asegurarnos de que la obtenga correctamente debemos saber mas en detalle como la obtiene. Si corremos el ejemplo con un nivel de log en debug vamos a ver lo siguiente:

<code>
Retrieving metadata for PACKAGE_CLIENTES/SCHEMA/BUSCAR_DIRECCION
</code>

Si el dueño (owner) del package es diferente al del schema al cual nos estamos conectado, no va a poder obtener la meta data, aunque el mismo tenga un sinónimo publico. Lo importante es que Spring no da error en estos casos, sino que continua con la invocación. En nuestro caso seria algo del tipo:

<code>
Compiled stored procedure. Call string is [{call PACKAGE_CLIENTES.BUSCAR_DIRECCION()}]
</code>

Luego la base de datos nos dara un error indicando que estamos invocando al procedure con una cantidad incorrecta de parametros (ninguno), ocultado el error que origina todo esto.

Para solucionarlo basta con modificar la llamada al execute de SimpleJdbcCall de la siguiente forma:

<code java>
Map<String, Object> out = getMiStoreProcedureCall().withSchemaName("MI_ESQUEMA")
.execute(mapIn);
</code>