The javax.xml.bind.annotation.XmlMimeType annotation is a JAXB annotation that is used for associating Java type and MIME type, and this annotation is used for associating the Java type and MIME type when using the javax.xml.ws.soap.MTOM annotation.

You can specify the javax.xml.bind.annotation.XmlMimeType annotation in the service method argument, and the return value possessed by the Web Service Implementation Class containing SEI or implicit SEI, or the getter method of user definition type. The operation is not guaranteed if specified at any other location (fields such as service method argument, a return value, user definition exceptions possessed by the Web Service Implementation Class without implicit SEI).

When the javax.xml.bind.annotation.XmlMimeType annotation is annotated in SEI, the WSDL file issued by the Web Service JAX-WS engine and the WSDL file generated by the cjwsgen tool is assigned by the xmime:expectedContentTypes attribute that possesses a value specified in the value element of the annotation to the schema element that corresponds to the Java type with annotated javax.xml.bind.annotation.XmlMimeType.

The following figure shows an example using the javax.xml.bind.annotation.XmlMimeType annotation.

Figure 16-19 Example using the javax.xml.bind.annotation.XmlMimeType annotation

When Java type and MIME type are not associated, the javax.xml.bind.annotation.XmlMimeType annotation need not be annotated. In this case, the initial value that corresponds to the Java type is used as a value in the Content-Type field in the attachment part of the message that is sent in the attachment of the MTOM/XOP specification format.

The following figure shows an example where the javax.xml.bind.annotation.XmlMimeType annotation is not used.

Figure 16-20 Example where javax.xml.bind.annotation.XmlMimeType annotation is not used

The following table lists the Java type with which the MIME type can be associated and its specification location by annotating the javax.xml.bind.annotation.XmlMimeType annotation. Note that the operation is not guaranteed if the javax.xml.bind.annotation.XmlMimeType annotation is annotated with any other type.

Table 16-17 Java type where MIME type can be associated and its specification location

No	Java type	Possibility of association	Specification location
			Method argument	Method return value	User definition type field	User definition exception fields
1	java.awt.Image	Y#1	Y	Y	A#2	N#3
2	javax.xml.transform.Source	Y	Y	Y	A #2	N #3
3	javax.activation.DataHandler	Y	Y	Y	A #2	N #3
4	java.awt.Image array type	A #4	Y	Y	A #2	N #3
5	javax.activation.DataHandler array type	A #4	Y	Y	A #2	N #3
6	java.util.List<Image>	Y	Y	Y	A #2	N #3
7	java.util.List<DataHandler>	Y	Y	Y	A #2	N #3
8	javax.xml.ws.Holder<Image>	Y	Y	N #5	N #5	N #5
9	javax.xml.ws.Holder<Source>	Y	Y	N #5	N #5	N #5
10	javax.xml.ws.Holder<DataHandler>	Y	Y	N #5	N #5	N #5

Legend:

Y: Can be specified.

A: Can be specified with conditions.

N: Cannot be specified.

#1

This complies with the JAXB specifications. The java.awt.Image class is an abstract class that expresses the graphical image in the Java SE specifications, where the data format is not prescribed. When the image data is instantiated by using this relationship, only the decoded information might be retained in a concrete class. Therefore, when sending an image that can be reduced while decoding such as the images in JPEG format, as an attachment, the instance at receiving side might differ from the instance at sending side or from the original data.

If you want to handle the image as is in the original format, use the MIME type (such as application/octet-stream) that is mapped to javax.activation.DataHandler.

#2

While associating the MIME type to the Java property, annotate the javax.xml.bind.annotation.XmlMimeType annotation in the getter method. If this is annotated in the field and the setter method, the operation is not guaranteed. The following is an example of associating MIME type in the Java property.

package com.sample; import java.awt.Image; public class UserData { private Image image; public void setImage(Image image) { this.image = image; } @javax.xml.bind.annotation.XmlMimeType("image/png") public Image getImage() { return image; } }

#3

If you specify the javax.xml.bind.annotation.XmlMimeType annotation in a user-defined exception field, the operation is not guaranteed.

#4

You can use only a one-dimensional array. You cannot use multi-dimensional arrays. If you use multi-dimensional arrays, the operation is not guaranteed.

#5

You can specify the Holder type only as an argument. You cannot specify the Holder type in the return value.

Organization of this subsection

(1) value element (javax.xml.bind.annotation.XmlMimeType)