PM18662: A JAX-WS Web service responds with a message containing illegal XML characters

Fixes are available

APAR status

Closed as program error.

Error description

A customer has a JAX-WS Web service that produces output
rendered as JAXB beans.

The fields within the JAXB beans are assigned data from
another legacy application owned by the customer.  In some
cases, the JAXB fields contain characters that are illegal xml
characters (for example, 0x15).

When the JAX-WS runtime sends a response from this Web
service, the illegal characters are embedded within the message.
As a result the SOAP node receiving the message will fail.
Normally the failure will indicate a problem parsing illegal
xml characters.

This problem is preventing the customer from migrating their
applications from the JAX-RPC programming model to the JAX-WS
programming model.

The JAX-WS engine should have a capability to strip out the
illegal xml characters.

Local fix

Problem summary

****************************************************************
* USERS AFFECTED:  IBM WebSphere Application Server V7.0 users *
*                  of JAX-WS                                   *
****************************************************************
* PROBLEM DESCRIPTION: JAX-WS Web service may respond with a   *
*                      message containing illegal XML          *
*                      characters.                             *
****************************************************************
* RECOMMENDATION:  Install a fix pack containing this APAR and *
*                  use the provided property.                  *
****************************************************************
A customer has a JAX-WS Web service that produces output
rendered as JAXB beans.

The fields within the JAXB beans are assigned data from
another legacy application owned by the customer.  In some
cases, the JAXB fields contain characters that are illegal XML
characters (0x15).

When the JAX-WS runtime sends a response from this Web
service, the illegal characters are embedded within the message.
As a result the SOAP node receiving the message will fail.
Normally the failure will indicate a problem parsing illegal
XML characters.

The following link defines the range of legal characters:
http://www.w3.org/TR/2008/REC-xml-20081126/#NT-Char

This problem is preventing the customer from migrating their
applications from the JAX-RPC programming model to the JAX-WS
programming model.

The JAX-WS engine should have a capability to strip out the
illegal XML characters.

IBM will provide a property that the customer can enable to
request filtering of illegal characters.  The property and
usage is defined in the Problem Conclusion.

Problem conclusion

A new property is added to the JAX-WS runtime:

Property Name:
"jaxws.jaxb.write.remove.illegal.chars"
Property Value:
java.lang.Boolean
Property Default:
Boolean.FALSE (illegal characters are not removed)
Property Location:
The property is located on the
javax.xml.ws.handler.MessageContext object.

Description:
A customer can set the property on the MessageContext to
instruct the JAX-WS runtime to remove illegal characters for a
particular web service.  Setting this property may cause a
decrease in performance due to the extra processing necessary
to examine and remove the illegal characters.  IBM suggests
that this property should only be used by customers requiring
this capability.

Example 1:
A customer may set this property within a JAX-WS handler
that is called during server inbound processing.
(Note that the JAX-WS will inspect both the inbound
and outbound MessageContexts to determine if illegal
characters should be removed during the outbound
processing.)


public class SampleHandler implements
SOAPHandler<SOAPMessageContext> {

...
public boolean handleMessage(SOAPMessageContext smc) {
// instruct JAXWS to remove illegal characters
// when the outbound message is written
smc.put("jaxws.jaxb.write.remove.illegal.chars",
Boolean.TRUE);
}
}


Example 2:

A customer may set this property using the
WebServiceContext.

@WebService
public class MyWebService {

@Resource
public WebServiceContext wsc = null;

@WebMethod
public MyBeanOut myMethod(MyBeanIn in) {

MessageContext mc = wsc.getMessageContext();
// instruct JAXWS to remove illegal characters
// when the outbound message is written
mc.put("jaxws.jaxb.write.remove.illegal.chars",
Boolean.TRUE);

This problem is fixed in the Version 6.1 Feature Pack for Web
Services product by APAR PM16907.

The fix for this APAR is currently targeted for inclusion in
fix pack 7.0.0.15.  Please refer to the Recommended Updates
page for delivery information:
http://www.ibm.com/support/docview.wss?rs=180&uid=swg27004980

Temporary fix

Comments

APAR Information

APAR number
PM18662
Reported component name
WEBSPHERE APP S
Reported component ID
5724J0800
Reported release
700
Status
CLOSED PER
PE
NoPE
HIPER
NoHIPER
Special Attention
NoSpecatt
Submitted date
2010-07-17
Closed date
2010-08-04
Last modified date
2010-08-04

APAR is sysrouted FROM one or more of the following:

PM16907
APAR is sysrouted TO one or more of the following:

Fix information

Fixed component name
WEBSPHERE APP S
Fixed component ID
5724J0800

Applicable component levels

R700 PSY
UP

[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSEQTP","label":"WebSphere Application Server"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"7.0","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
25 October 2021

Tips

PM18662: A JAX-WS Web service responds with a message containing illegal XML characters

Fixes are available

Subscribe

APAR status

Closed as program error.

Error description

Local fix

Problem summary

Problem conclusion

Temporary fix

Comments

APAR Information

APAR number

Reported component name

Reported component ID

Reported release

Status

PE

HIPER

Special Attention

Submitted date

Closed date

Last modified date

APAR is sysrouted FROM one or more of the following:

APAR is sysrouted TO one or more of the following:

Fix information

Fixed component name

Fixed component ID

Applicable component levels

R700 PSY

Document Information

Share your feedback

Need support?