Question on MTOM - The image is returned inline instead of an attachment.

[Kumar Raja]

Hello All,

I'm working on the example quoted in Ivan's notes (Section 10.3, MessageOptimization), the ImageManager example. I coded the webservice as below

@WebService
@MTOM(enabled = true, threshold = 512)

public class ImageManager {
	@Resource
	private WebServiceContext context;
	
	public Image getImage(String imageName){
               // Image upload logic, taken from Ivan's notes	
               }
	public void setImage(String imageName,Image image){
	//TODO
	}
}

My environment is Glassfish v 3.0 and I deployed and ran the service and I can successfully access the WSDL and snippet is below

<definitions xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsp="http://www.w3.org/ns/ws-policy"  xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://mtom.ws.learning.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://mtom.ws.learning.org/" name="ImageManagerService">
   <wsp:Policy wsu:Id="ImageManagerPortBinding_MTOM_Policy-ImageManagerPortBinding_MTOM_Policy">
           <ns1:OptimizedMimeSerialization xmlns:ns1="http://schemas.xmlsoap.org/ws/2004/09/policy/optimizedmimeserialization" wsp:Optional="true" /> 
  </wsp:Policy>
  <types>
.......................
.......................
   <binding name="ImageManagerPortBinding" type="tns:ImageManager">
  <wsp:PolicyReference URI="#ImageManagerPortBinding_MTOM_Policy-ImageManagerPortBinding_MTOM_Policy" /> 
  <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" /> 

First of all, I see "wsp:Optional = "true". What does this mean? I thought, this attribute being false, does not mandate MTOM. Is this right?

secondly, in the xsd

<xs:complexType name="getImageResponse">
    <xs:sequence>
         <xs:element name="return" type="xs:base64Binary" minOccurs="0" /> 
    </xs:sequence>
</xs:complexType>

I was expecting to see encodedContentType attribute. First of all do I see this here or should I be expecting this at some other location or not at all.

Thirdly, when I tested my service using SOAPUI, I see

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mtom="http://mtom.ws.learning.org/">
   <soapenv:Header/>
   <soapenv:Body>
      <mtom:retrievePicture>
         <!--Optional:-->
         <inImage>sample.bmp</inImage> <!-- Sample.bmp is huge file about 1.5 MB > 512 Threshold-->
      </mtom:retrievePicture>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:retrievePictureResponse xmlns:ns2="http://mtom.ws.learning.org/">
         <return>iVBORw0KGgoAAAAN.............................................</return>
      </ns2:retrievePictureResponse>
   </S:Body>
</S:Envelope>

The return is really huge, so I removed most of the data.

In SOAPUi, I have observed few things which may be irrelevant to my question, but just for information purpose. Under Request properties of getImage() request, I see following options as false.

Enable MTOM, Force MTOM, InlineResponseAttach, ExpandMTOMAttachment, EncodeAttachments.

Coming to the question, I was expecting the response to be a part of attachment as the image "Sample.bmp" is bigger than threshold. But I see the result to be inline in the SOAP Response.

Can you advise me what mistake I'm doing here and also any thoughts on SOAPUi Request properties

[Kumar Raja]

Merry Christmas to All.

I know people might be busy in Christmas celebrations, but anytime if you get a chance, could you please look into my post and guide me.

[Hany Shafik]

To reply your first question, as quoted from the ws-policy specification optional-policy optional means

A policy assertion is marked as optional using the wsp:Optional attribute. Optional assertions represent the capabilities of the service provider as opposed to the requirements of the service provider.

To answer your second question about encodedContentType (it should be expectedContentTypes instead) attribute you should add annotation @XmlMimeType("image/gif") to the instance variable of the JAXB class. this will cause to generate expectedContentTypes="image/gif" in the respective element.

[Hany Shafik]

Sorry forgot to answer your original question I am using soapUI 3.5 you just right click and click insert file as Base64 and you must enable and force using MTOM in the request properties.

[Kumar Raja]

Hany Shafik wrote:To reply your first question, as quoted from the ws-policy specification optional-policy optional means

A policy assertion is marked as optional using the wsp:Optional attribute. Optional assertions represent the capabilities of the service provider as opposed to the requirements of the service provider.

To answer your second question about encodedContentType (it should be expectedContentTypes instead) attribute you should add annotation @XmlMimeType("image/gif") to the instance variable of the JAXB class. this will cause to generate expectedContentTypes="image/gif" in the respective element.

Thanks Hany. In order to see the expectedContentTypes in generated xsd, you mentioned that we need to add @XmlMimeType annotation to the JAXB class. I'm currently following the Java first approach. So after the generation of WSDL and XSD through wsgen, I'm using wsimport to generate the client side artifacts and JAXB binding classes.

so where do I add this annotation on SEI implementation class, so that in the generated XSD I can see expectedContentTypes. I tried something like

@WebService
@MTOM(enabled = true, threshold = 512)
public class ImageManager {
	@Resource
	private WebServiceContext context;
	
	@XmlMimeType(value = "image/jpeg")
	private Image image;

But I do not see any difference in xsd generated from what it was when @XmlMimeType was not used. Probably I did not use this annotation appropriately.

[Hany Shafik]

May be you got me wrong, What I meant is the JAXB annotated class and not the SEI. please see below an example that can help you

@XmlType
public class TestType {
	@XmlMimeType("image/gif")
	protected Image imageData;

}

@WebService(name = "RequestOrderPort")
@MTOM(enabled = true)
public interface TestPort {
	public void test(TestType test);
}

in your case you will annotate the image instance variable inside the GetImageResponse JAXB generated class

[Kumar Raja]

Thanks Hany,

I tried to change my code as follows but getting an exception while generating WSDL using wsgen.

        package org.learning.ws.domain;

        import java.awt.Image;

        import javax.xml.bind.annotation.XmlMimeType;
        import javax.xml.bind.annotation.XmlType;

        @XmlType
       public class CustomImage {
	    @XmlMimeType("image/gif")
	     private Image image;

 	     public Image getImage() {
		return image;
	     }

	     public void setImage(Image image) {
		  this.image = image;
	     }
	}
     

package org.learning.ws.mtom;

import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;

import javax.annotation.Resource;
import javax.imageio.ImageIO;
import javax.jws.WebService;
import javax.servlet.ServletContext;
import javax.xml.ws.WebServiceContext;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.soap.MTOM;

import org.learning.ws.domain.CustomImage;

@WebService
@MTOM(enabled = true, threshold = 512)
public class ImageManager {
	@Resource
	private WebServiceContext context;
		
	private CustomImage output;
	
	public CustomImage getImage(String imageName){
		output = new CustomImage();
		MessageContext mContext = context.getMessageContext();
		ServletContext sContext = (ServletContext)mContext.get(MessageContext.SERVLET_CONTEXT);
		if(sContext != null){
			try{
				System.out.println("URL of photos is "+sContext.getResource("/photos"));
			}catch(MalformedURLException e){
				e.printStackTrace();
			}
			InputStream is = sContext.getResourceAsStream("/photos/"+imageName);
			try{
				output.setImage(ImageIO.read(is));
			}catch(IOException i){
				i.printStackTrace();
			}
		}
		return output;
	}
	public void setImage(String imageName,CustomImage image){
		//TODO
	}
}

     

build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project default="main" basedir=".">
	
	<property name="class-dir" value="${basedir}/build/classes/"/>
	<property name="wsgen-outdir" value="${basedir}/build/wsgen-output/"/>
	<property name="wsdl-outdir" value="${basedir}/WebContent/WEB-INF/wsdl/"/>
	<property name="gen-srcdir" value="${basedir}/srcgen/"/>
	<property name="gen-classdir" value="${wsgen-outdir}/classes/"/>
	<property name="wsgen-cmd"
			  value="C:/DevCenter/Sun/jdk1.6/bin/wsgen"/>
	<echo message="calling the web services generation task wsgen" />
	
	<target name="main" depends="init">
		<exec executable="${wsgen-cmd}">
			<arg value="-verbose"/>
			<arg value="-classpath"/>
			<arg value="${class-dir}"/>
			<arg value="-wsdl"/>
			<arg value="-d"/>
			<arg value="${wsgen-outdir}"/>
			<!-- Specify where to write WSDL and XML schema files. -->
			<arg value="-r"/>
			<arg value="${wsdl-outdir}"/>
			<!-- Specify where to write generated source files. -->
			<arg value="-s"/>
			<arg value="${gen-srcdir}"/>
			<!-- Keep generated source files. -->
			<arg value="-keep"/>
			<!-- Specify service endpoint interface/class. -->
			<arg value="org.learning.ws.mtom.ImageManager" />
		</exec>
	</target>
	
	<target name="init" depends="clean">
		<mkdir dir ="${wsgen-outdir}"/>
		<mkdir dir ="${wsdl-outdir}"/>
		<mkdir dir ="${gen-srcdir}"/>
		<mkdir dir ="${gen-classdir}"/>
	</target>
	
	<target name="clean">
		<delete dir ="${wsgen-outdir}"/>
		<delete dir ="${wsdl-outdir}"/>
		<delete dir ="${gen-srcdir}"/>
		<delete dir ="${gen-classdir}"/>
	</target>
</project>

Exception

Note: 	ap round: 2
     [exec] Exception in thread "main" javax.xml.ws.WebServiceException: Unable to create JAXBContext
     [exec] 	at com.sun.xml.internal.ws.model.AbstractSEIModelImpl.createJAXBContext(AbstractSEIModelImpl.java:153)
     [exec] 	at com.sun.xml.internal.ws.model.AbstractSEIModelImpl.postProcess(AbstractSEIModelImpl.java:83)
     [exec] 	at com.sun.xml.internal.ws.model.RuntimeModeler.buildRuntimeModel(RuntimeModeler.java:244)
     [exec] 	at com.sun.tools.internal.ws.wscompile.WsgenTool.buildModel(WsgenTool.java:229)
     [exec] 	at com.sun.tools.internal.ws.wscompile.WsgenTool.run(WsgenTool.java:112)
     [exec] 	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
     [exec] 	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
     [exec] 	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
     [exec] 	at java.lang.reflect.Method.invoke(Method.java:597)
     [exec] 	at com.sun.tools.internal.ws.Invoker.invoke(Invoker.java:105)
     [exec] 	at com.sun.tools.internal.ws.WsGen.main(WsGen.java:41)
     [exec] Caused by: java.security.PrivilegedActionException: com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationsException: 1 counts of IllegalAnnotationExceptions
     [exec] Class has two properties of the same name "image"
     [exec] 	this problem is related to the following location:
     [exec] 		at public java.awt.Image org.learning.ws.domain.CustomImage.getImage()
     [exec] 		at org.learning.ws.domain.CustomImage
     [exec] 		at private org.learning.ws.domain.CustomImage org.learning.ws.mtom.jaxws.GetImageResponse._return
     [exec] 		at org.learning.ws.mtom.jaxws.GetImageResponse
     [exec] 	this problem is related to the following location:
     [exec] 		at private java.awt.Image org.learning.ws.domain.CustomImage.image
     [exec] 		at org.learning.ws.domain.CustomImage
     [exec] 		at private org.learning.ws.domain.CustomImage org.learning.ws.mtom.jaxws.GetImageResponse._return
     [exec] 		at org.learning.ws.mtom.jaxws.GetImageResponse

I knew that I'm doing a terrible mistake here, but could not locate what it is.

Also, from Ivan's notes (the example is taken from Ivan's notes), there are no instructions to annotate a domain object with @XmlType...

[Ivan Krizsan]

Hi!

Hany Shafik wrote:Sorry forgot to answer your original question I am using soapUI 3.5 you just right click and click insert file as Base64 and you must enable and force using MTOM in the request properties.

Sorry, have been busy over the holidays, so I didn't see this thread until today.
Yes, Hany is right - the Enable MTOM and Force MTOM properties in soapUI must be set to true. This has been described in a more recent version of the study notes. Please make sure you have the lates version Kumar!

I see that you have modified the code - it is different than the example in my study notes.
While it is an excellent exercise, I am more limited in answering questions in connection to such endeavors since I have not tried the program myself.
Best wishes!

[Hany Shafik]

Hi Kumar,

You should add the annotation @XmlAccessorType(XmlAccessType.FIELD) to your class (or remove the getter method), as by default jaxb will try to bind both field and getter method to the same element name, that is why this exception is raised.

[Kumar Raja]

Thanks Hany. Your suggestion worked.

But, this time I was trying an example quoted in Ivan's notes. The class is defined as below

package org.learning.ws.mtom;

import java.awt.Image;
import java.io.IOException;
import java.io.InputStream;

import javax.annotation.Resource;
import javax.imageio.ImageIO;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
import javax.servlet.ServletContext;
import javax.xml.ws.WebServiceContext;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.soap.MTOM;

@WebService
@MTOM( enabled = true, threshold = 512)
public class ImgManager {
	@Resource
	private WebServiceContext mWSContext;
	
	@WebMethod(operationName = "retrievePicture")
	public Image retrievePicture(@WebParam(name = "inImageNumber") final String inImage){
		Image theImage = null;
		MessageContext theMsgContext = mWSContext.getMessageContext();
		ServletContext theServletContext = (ServletContext) theMsgContext.get(MessageContext.SERVLET_CONTEXT);
		if (theServletContext != null){
			InputStream thePicStream;
			/* Try reading the image. */
			thePicStream = theServletContext.getResourceAsStream("/photos/" + inImage);
			try{
				theImage = ImageIO.read(thePicStream);
			} catch (IOException theException){
				System.out.println("An error occurred trying to read image:");
				theException.printStackTrace();
			}
		} else{
			System.out.println("No servlet context, cannot retrieve image!");
		}
		return theImage;
	}
}

The above class is same as whats given in the notes, except that I removed an operation and kept the example much simple. I ran wsgen and generated the WSDL and XSD.

The WSDL is as below

<definitions targetNamespace="http://mtom.ws.learning.org/" name="ImgManagerService" xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:tns="http://mtom.ws.learning.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/">
  <types>
    <xsd:schema>
      <xsd:import namespace="http://mtom.ws.learning.org/" schemaLocation="ImgManagerService_schema1.xsd"/>
    </xsd:schema>
  </types>
  <message name="retrievePicture">
    <part name="parameters" element="tns:retrievePicture"/>
  </message>
.....................
....................
<binding name="ImgManagerPortBinding" type="tns:ImgManager">
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
    <operation name="retrievePicture">
      <soap:operation soapAction=""/>
      <input>
        <soap:body use="literal"/>
      </input>

As seen above, there is no MTOM policy generated in the WSDL. However, after deployment if I browse for the wsdl "http://localhost:8080/ImageManager/ImgManagerService?wsdl" I see the MTOM policy

<definitions xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://mtom.ws.learning.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://mtom.ws.learning.org/" name="ImgManagerService">
  <wsp:Policy wsu:Id="ImgManagerPortBinding_MTOM_Policy-ImgManagerPortBinding_MTOM_Policy">
  <ns1:OptimizedMimeSerialization xmlns:ns1="http://schemas.xmlsoap.org/ws/2004/09/policy/optimizedmimeserialization" wsp:Optional="true" /> 
  </wsp:Policy>
.......................................
<binding name="ImgManagerPortBinding" type="tns:ImgManager">
  <wsp:PolicyReference URI="#ImgManagerPortBinding_MTOM_Policy-ImgManagerPortBinding_MTOM_Policy" /> 

Am I doing any mistake here ?

In the notes, Ivan advised to look at the WSDL to see if MTOM is enabled or not, but not sure, if he meant to check this in the wsgen generated WSDL or through browser.

[Hany Shafik]

Hi Kumar,

I assume this is because the jax-ws wsgen you used to generate the wsdl is of different version than the one used in glassfish.
Please try wsgen -v to print the jax-ws version for both the wsgen tool you used and go inside the glassfish bin directory and try wsgen -v.

[Kumar Raja]

Hany,

I'm using the wsgen that is a part of JDK1.6. So when I ran -version on wsgen, I got "JAX-WS RI 2.1.6 in JDK 6". Do I need to use any other version ?

[Hany Shafik]

Glassfish v3 implements jax-ws 2.2. As I told you before please try wsgen -v for the one that resides inside glassfish bin directory.

[Kumar Raja]

Thanks Hany,

I used the wsgen that shipped along with glassfish and I see the wsdl with the policy element. By the way, -version I see here is "JAX-WS RI 2.2.1-hudson-28-"