PK82730: THE HTTP_REQUEST_HEADERS PROPERTY IS NOT BEING HONORED WHEN SETTING A COOKIE.

Fixes are available

APAR status

Closed as program error.

Error description

The HTTP_REQUEST_HEADERS property is not being honored when
setting a cookie.

The JAX-WS API provides a mechanism for client applications to
set and retrieve transport headers.  The client application is
supposed to set the cookie value on the Map provided by the
MessageContext.HTTP_REQUEST_HEADERS property.   The JAX-WS
engine does not seem to be honoring this property.

In addition, if the cookie value does not contain any
attributes, the JAX-WS engine may fail.  For example, if the
cookie value is simply "cookieTest=myCookie", the follow error
may appear in the log files:

org.apache.axis2.AxisFault: null; nested exception is:
        java.lang.StringIndexOutOfBoundsException
        at
org.apache.axis2.AxisFault.makeFault(AxisFault.java:385)
        at
com.ibm.ws.websvcs.transport.http.SOAPOverHTTPSender.prepareHttp
RequestHeaders(SOAPOverHTTPSender.java:2083)
        at
com.ibm.ws.websvcs.transport.http.SOAPOverHTTPSender.sendSOAPReq
uest(SOAPOverHTTPSender.java:510)
        at
com.ibm.ws.websvcs.transport.http.SOAPOverHTTPSender.send(SOAPOv
erHTTPSe
nder.java:395) ...

Local fix

```
N/A
```

Problem summary

****************************************************************
* USERS AFFECTED:  IBM WebSphere Application Server users of   *
*                  web services and maintain session.          *
****************************************************************
* PROBLEM DESCRIPTION: The web service may fail if the         *
*                      cookie value does not contain           *
*                      attributes.                             *
****************************************************************
* RECOMMENDATION:  Apply the fixpack containing this APAR and  *
*                  APAR PK91543                                *
****************************************************************
The JAX-WS API provides a mechanism for client applications to
set and retrieve transport headers.  The client application is
supposed to set the cookie value on the Map provided by the
MessageContext.HTTP_REQUEST_HEADERS property.  Here is an
example that indicates how to set a cookie for the JAX-WS
programming model.

The following sample code demonstrates how a client
application may set the cookie value
"testCookie=myCookie;PATH=myPath":

  BindingProvider proxy = ...
  String cookieValue = "testCookie=myCookie;PATH=myPath";

  // Access the request context properties from the proxy
  Map<String, Object> reqCtx =
       getRequestContext(proxy);

  // Enable sessions
  reqCtx.put(BindingProvider.SESSION_MAINTAIN_PROPERTY,true);


  // Get the request http transport headers map
  Map<String,List<String>> headersMap =
    (Map<String,List<String>>)
      reqCtx.get(MessageContext.HTTP_REQUEST_HEADERS);

  if (headersMap == null) {
    reqHttpHeader = new Hashtable<String,List<String>>();
  }

  // Set the cookie value
  List<String> cookies = (List<String>)
    headersMap.get("Cookie");
  if (cookies == null) {
    cookies = new ArrayList<String>();
  }
  cookies.add(cookieValue);
  headersMap.put("Cookie",
                 cookies);

  // Put the headers map on the context
  reqCtx.put(MessageContext.HTTP_REQUEST_HEADERS,
             headersMap);

The problem is that a customer may set a cookie that does not
have attributes (example:"cookieTest=myCookie").  In such
cases, an error may appear in the log file.  Here is an
example error for the JAX-WS programming model:

org.apache.axis2.AxisFault: null; nested exception is:
        java.lang.StringIndexOutOfBoundsException
        at
org.apache.axis2.AxisFault.makeFault(AxisFault.java:385)
        at
com.ibm.ws.websvcs.transport.http.SOAPOverHTTPSender.prepareHttp
RequestHeaders(SOAPOverHTTPSender.java:2083)
        at
com.ibm.ws.websvcs.transport.http.SOAPOverHTTPSender.sendSOAPReq
uest(SOAPOverHTTPSender.java:510)
        at
com.ibm.ws.websvcs.transport.http.SOAPOverHTTPSender.send(SOAPOv
erHTTPSe
nder.java:395)
        at

Problem conclusion

The StringIndexOutOfBoundsException error is caused by
incorrect parsing code in the WebSphere Application Server Web
Services utility code.   The utility code is referred to as
the "Cookie Manager" code and it is responsible for parsing
and storing cookies.   The parsing code is corrected to ensure
that cookies without attributes are properly parsed.

This APAR fix should be applied with the APAR fix for PK91543
if the JAX-WS programming model is being used.

The fix for this APAR is currently targeted for inclusion in
fix packs 6.0.2.39, 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
PK82730
Reported component name
WEBSERVIC FEATU
Reported component ID
5724J0850
Reported release
60I
Status
CLOSED PER
PE
NoPE
HIPER
NoHIPER
Special Attention
NoSpecatt
Submitted date
2009-03-17
Closed date
2009-07-17
Last modified date
2009-07-17

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

PK91543

Fix information

Fixed component name
WEBSPHERE APP S
Fixed component ID
5724J0800

Applicable component levels

R60A PSY
UP
R60H PSY
UP
R60I PSY
UP
R60P PSY
UP
R60S PSY
UP
R60W PSY
UP
R60Z PSY
UP
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.0","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
28 December 2021

Tips

PK82730: THE HTTP_REQUEST_HEADERS PROPERTY IS NOT BEING HONORED WHEN SETTING A COOKIE.

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

R60A PSY

R60H PSY

R60I PSY

R60P PSY

R60S PSY

R60W PSY

R60Z PSY

R61A PSY

R61H PSY

R61I PSY

R61P PSY

R61S PSY

R61W PSY

R61Z PSY

R700 PSY

Document Information

Share your feedback

Need support?