PK82021: UTF-16 MTOM WEB SERVICE CLIENT CONNECTED TO A WEBSPHERE APPLICATION SERVER 7.0 ENDPOINT HANGS

Fixes are available

APAR status

Closed as program error.

Error description

When a client attempts to send a UTF-16 encoded message to a
web service, the actual message payload appears
to contain UTF-8 encoding. The UTF-16 setting is only
partially honored.

In some instances, the client waits for around 15 minutes
followed by this exception:

2902 EXCEPTION java.net.SocketTimeoutException: Socket
operation timed out before it could be completed

Here is the scenario for recreating this:
1. Create a JAX-WS web service and client
2. Enable UTF-16 encoding

(Example of setting UTF-16 encoding)
getRequestContext().put("CHARACTER_SET_ENCODING", "UTF-16");

If you inspect the soap messages on the wire, you will see
that the soap envelope is using UTF-16 but the payload itself
inside the soap body element is using UTF-8 as shown below:

<.s.o.a.p.e.n.v.:.E.n.v.e.l.o.p.e.
.x.m.l.n.s.:.s.o.a.p.e.n.v.=.".h.t.t.p.:././.
w.w.w...w.3...o.r.g./.2.0.0.3./.0.5./.s.o.a.p.-.e.n.v.e.l.o.p.e.
".>.<.s.o.a.p.e.
n.v.:.B.o.d.y.><ns2:EchoBinaryAsString
xmlns="http://schemas.example.com/2003/10
/Serialization/Arrays" xmlns:ns2="http://xmlsoap.org/Ping"
xmlns:ns3="http://sch
emas.example.com/2003/10/Serialization/"><ns2:array><xop:Include
xmlns:xop="http
://www.w3.org/2004/08/xop/include"
href="cid:urn:uuid:B7877DB4C5F25294E312338588
48772@apache.org"/></ns2:array></ns2:EchoBinaryAsString>.<./.s.o
.a.p.e.n.v.:.B.o
.d.y.>.<./.s.o.a.p.e.n.v.:.E.n.v.e.l.o.p.e.>

Local fix

Problem summary

****************************************************************
* USERS AFFECTED:  All IBM WebSphere Application Server V7.0   *
*                  users of JAX-WS and UTF-16                  *
****************************************************************
* PROBLEM DESCRIPTION: A JAX-WS web service client sends an    *
*                      incorrectly encoded message when        *
*                      UTF-16 encoding is requested            *
****************************************************************
* RECOMMENDATION:  Install a FixPack containing this APAR      *
****************************************************************
When a client attempts to send a UTF-16 encoded message to a
web service, the actual message payload appears
to contain UTF-8 encoding. The UTF-16 setting is only
partially honored.

(Example of setting UTF-16 encoding)
getRequestContext().put("CHARACTER_SET_ENCODING", "UTF-16");

If you inspect the soap messages on the wire, you will see
that the soap envelope is using UTF-16 but the payload itself
inside the soap body element is using UTF-8 as shown below:

<.s.o.a.p.e.n.v.:.E.n.v.e.l.o.p.e.
.x.m.l.n.s.:.s.o.a.p.e.n.v.=.".h.t.t.p.:././.
w.w.w...w.3...o.r.g./.2.0.0.3./.0.5./.s.o.a.p.-.e.n.v.e.l.o.p.e.
".>.<.s.o.a.p.e.
n.v.:.B.o.d.y.><ns2:EchoBinaryAsString
xmlns="http://schemas.example.com/2003/10
/Serialization/Arrays" xmlns:ns2="http://xmlsoap.org/Ping"
xmlns:ns3="http://sch
emas.example.com/2003/10/Serialization/"><ns2:array><xop:Include
 xmlns:xop="http
://www.w3.org/2004/08/xop/include"
href="cid:urn:uuid:B7877DB4C5F25294E312338588
48772@apache.org"/></ns2:array></ns2:EchoBinaryAsString>.<./.s.o
.a.p.e.n.v.:.B.o
.d.y.>.<./.s.o.a.p.e.n.v.:.E.n.v.e.l.o.p.e.>

The root of the problem is the JAX-WS engine is not marshaling
the xml data with a UTF-16 encoding.

Problem conclusion

The JAX-WS engine is corrected to properly set the encoding
property on the xml marshaller to the designated encoding from
the JAX-WS RequestContext.  The client JAX-WS code will now
send a properly encoded JAX-WS message.

APAR PK91898 provides this same solution for the WebSphere
Application Server V6.1 Feature Pack for Web Services.

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

Temporary fix

```
ZE Fix Error, see PM13777 2010/06/03
```

Comments

APAR Information

APAR number
PK82021
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
2009-03-06
Closed date
2009-05-12
Last modified date
2010-06-03

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

PK91898

Fix information

Fixed component name
WEBSPHERE APP S
Fixed component ID
5724J0800

Applicable component levels

R700 PSY
UP

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSEQTP","label":"WebSphere Application Server"},"Component":"","ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"7.0","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
10 February 2022

Tips

PK82021: UTF-16 MTOM WEB SERVICE CLIENT CONNECTED TO A WEBSPHERE APPLICATION SERVER 7.0 ENDPOINT HANGS

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?