PK92022: A "root element is required" error occurs when a gateway LoggingInterceptor is being used.

Fixes are available

APAR status

Closed as program error.

Error description

The following error occurred when the customer's application
received an inbound message:

org.xml.sax.SAXParseException: The root element is required
in a well-formed document.
at
com.ibm.xml.xlxp.api.sax.impl.SAX2ParserBase.reportFatalError(SA
X2ParserBase.java:528)
at
com.ibm.xml.xlxp.api.was.WSXMLReader$WSScannerHelper.produceFata
lErrorEvent(WSXMLReader.java:469)
at
com.ibm.xml.xlxp.api.util.SimpleScannerHelper.reportFatalError(S
impleSca
nnerHelper.java:1458)

This message usually indicates that the incoming message is
empty or corrupted.  However in this case, the trace reveals
that the inbound message is correctly printed by a interceptor:

[7/21/09 7:32:54:793 MST] 0000002e SystemOut     O
07:32:54,793 INFO
com.wfhm.gateway.interceptor.LoggingInterceptor - Received SOAP
message:
...

The error occurs when the WebService's runtime attempts to
parse the message.   This seems to indicate that the incoming
message buffer is not reset after the interceptor prints the
message.

Local fix

Problem summary

****************************************************************
* USERS AFFECTED:  IBM WebSphere Application Server V6.1 and   *
*                  V7.0 users of Web Services.                 *
****************************************************************
* PROBLEM DESCRIPTION: A SAXParseException occurs when an      *
*                      incoming message is intercepted and     *
*                      then read by the web service runtime.   *
****************************************************************
* RECOMMENDATION:  Install a fixpack containing this APAR.     *
****************************************************************
The Web Service's engine parses incoming messages so that they
can be transformed into SAAJ, JAX-RPC or JAX-WS applicable Java
objects.

In some cases, other code outside of the web service engine
may intercept and read the message.  For example, in the
reported scenario the message is read by the gateway
LoggingInterceptor.

The external code may not reset the buffer.  This causes the
Web Services engine to assume that there is no incoming
message.  Normally this situation results in the following
error:

org.xml.sax.SAXParseException: The root element is required
in a well-formed document.

The root of the problem is a missing reset on the incoming
buffer.

Problem conclusion

The Web Service engine owns the message buffer for the
incoming message, WebServicesInputSource.  The
WebServicesInputSource code is changed to detect that the
buffer has been read, and it automatically resets itself.  The
Web Service parser will now correctly read the incoming
message, and the error is avoided.

The fix for this APAR is currently targeted for inclusion in
fix packs 6.1.0.29 and 7.0.0.7.  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
PK92022
Reported component name
WEBSPHERE APP S
Reported component ID
5724J0800
Reported release
61Z
Status
CLOSED PER
PE
NoPE
HIPER
NoHIPER
Special Attention
NoSpecatt
Submitted date
2009-07-22
Closed date
2009-08-05
Last modified date
2009-08-05

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
WEBSPHERE APP S
Fixed component ID
5724J0800

Applicable component levels

R61A PSY
UP
R61H PSY
UP
R61I PSY
UP
R61P PSY
UP
R61S PSY
UP
R61W PSY
UP
R61Z PSY
UP
R700 PSY
UP

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

Document Information

Modified date:
28 December 2021

Tips

PK92022: A "root element is required" error occurs when a gateway LoggingInterceptor is being used.

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

R61A PSY

R61H PSY

R61I PSY

R61P PSY

R61S PSY

R61W PSY

R61Z PSY

R700 PSY

Document Information

Share your feedback

Need support?