IBM Support

SI75914 - OSP-IWS JAVA RESERVED CHARACTER/KEYWORDS IN IDENTIFIERS

PTF Cover Letter


PTF ( Program Temporary Fixes ) Cover letter


Order this fix

Abstract

OSP-IWS JAVA RESERVED CHARACTER/KEYWORDS IN IDENTIFIERS


Pre/Co-Requisite PTF / Fix List

REQ  LICENSED           PTF/FIX  LEVEL

TYPE PROGRAM  RELEASE   NUMBER   MIN/MAX  OPTION
---- -------- --------- -------  -------  ------
PRE  5770SS1  V7R3M0    SI74702   NONE     0003
PRE  5770SS1  V7R3M0    SI74659   NONE     0003
PRE  5770SS1  V7R3M0    SI75101   NONE     0003
PRE  5770SS1  V7R3M0    SI71393   NONE     0003



NOTICE:
-------
Application of this PTF may disable or render ineffective programs that
use system memory addresses not generated by the IBM translator,
including programs that circumvent control technology designed to limit
interactive capacity to purchased levels.  This PTF may be a prerequisite
for future PTFs.  By applying this PTF you authorize and agree to the
foregoing.

This PTF is subject to the terms of the license agreement which
accompanied, or was contained in, the Program for which you are obtaining
the PTF.  You are not authorized to install or use the PTF except as part
of a Program for which you have a valid Proof of Entitlement.

SUBJECT TO ANY WARRANTIES WHICH CAN NOT BE EXCLUDED OR EXCEPT AS EXPLICITLY
AGREED TO IN THE APPLICABLE LICENSE AGREEMENT OR AN APPLICABLE SUPPORT
AGREEMENT, IBM MAKES NO WARRANTIES OR CONDITIONS EITHER EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OR CONDITIONS OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON INFRINGEMENT,
REGARDING THE PTF.

The applicable license agreement may have been provided to you in printed
form and/or may be viewed using the Work with Software Agreements (WRKSFWAGR)
CL command.





APAR Error Description / Circumvention

-----------------------------------------------
Customer created IWS 2.6 on IBM i V7R2.
He then compiled a RPG PGM with embedded pcml file and then
deploied it as REST service successfully using "used Allowed
input media types:" and "Returned output media types": *JSON The
problem is that he has a DS with a field name= $TYPE in the PCML
with 1208 as CCSID it becomes _TYPE and so running swagger he
found _TYPE instead of $TYPE.

it seems $ is a java reserved char.

CORRECTION FOR APAR SE75182 :
-----------------------------
Prior to version 2.6 of the IWS servers, if a field name in an
ILE program object contained characters not allowed in field
names in Java, the character was replaced with underscore.  In
addition, if the field name was in conflict with a Java
programming construct, the field name was pre-pended with
underscore.  Thus, in the payload you would see identifiers with
underscore.

This continued on in the 2.6 server.  However, in 2.6 there is a
mechanism to separate the payload identifier from the field name
used in Java.  In order to use this mechanism, "Detect field
lengths" option must be enabled.

Assuming "Detect field lengths" option is enabled, and for REST
services only, this mechanism will now be utilized in order to
preserve the original identifier used in the ILE program object.
However, it should be noted that if your REST service consumes
XML and the identifier contains characters such as '@' and '#',
the request will fail since XML identifiers must conform with
XML identifier rules:

(1) Element names must start with a letter or underscore
(2) Element names can contain letters, digits, hyphens, and
underscores

Thus, it will be up to you to ensure the XML name conventions
are followed.

For SOAP services, identifiers will continue to be as before
(characters such as '@' and '#' will be replaced with '_').

In order to pick up the changes in this PTF, a redeploy of the
web service will be necessary.

CIRCUMVENTION FOR APAR SE75182 :
--------------------------------
None.


Activation Instructions


None.




Special Instructions


End Web Administration servers. End integrated web services servers.

********************************************************************
THE FOLLOWING ARE SUPERSEDED SPECIAL INSTRUCTIONS. IF THE SUPERSEDED
PTF HAS ALREADY BEEN APPLIED AND ITS SPECIAL INSTRUCTION FOLLOWED,
IT IS NOT NECESSARY TO FOLLOW THAT SPECIAL INSTRUCTION AGAIN.
********************************************************************

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI75443 :
=================================================

End all integrated web services servers and HTTP Web Administration
servers.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI73872 :
=================================================

End Web Administration servers and integrated web services servers.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI73529 :
=================================================

End IWS servers and the HTTP administration server.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI73066 :
=================================================

End all IBM HTTP Web Administration servers.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI72299 :
=================================================

End IBM i Web Administration servers.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI72115 :
=================================================

End all integrated web services servers.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI69715 :
=================================================

End the HTTP Admin Servers.

After PTF applied, redeploy web service or generate client stub.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI69163 :
=================================================

End any integrated web services servers that are running.

In order to get the enhancements provided by this PTF, you will need to
ensure the RPG compiler PTF and this PTF is applied on the system, and
then redeploy the web service.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI69103 :
=================================================

End all integrated web services servers and the Web Administration
servers.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI68865 :
=================================================

End any integrated web services servers that are running.

In order to get the enhancements provided by this PTF, you will need to
redeploy the web service after applying the PTF.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI68746 :
=================================================

End all integrated web services servers in addition to the HTTP Web
Administration GUI.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI68580 :
=================================================

End all integrated web services server in addition to the HTTP Web
Administration GUI.

SPECIAL INSTRUCTIONS FOR SUPERSEDED PTF SI68148 :
=================================================

End all integrated web services servers.


End any integrated web services servers that are running.

In order to get the enhancements/fixes provided by this PTF, you will
need to
redeploy the web service after applying the PTF.

End any integrated web services servers that are running.

In order to get the enhancements provided by this PTF, you will need to
redeploy the web service after applying the PTF.

End all integrated web services servers.


End all integrated web services servers.


After applying PTF, redeploy the web service.

Regenerate the Swagger document after PTF has been applied. A redeploy
of web service may be necessary.

End all integrated web services servers.

To pick up the fix for DST problem, you will need to redeploy the web
service.

For the Swagger problem, you can go to the web service properties and
regenerate the Swagger document after the PTF is applied.

End all integrated web services servers.


End any integrated web services servers that are running.

In order to get the enhancements
provided by this PTF, you will
need to redeploy the web service
after applying the PTF.

End all integrated web services servers.

After applying PTF, redeploy the web service.

End any integrated web services servers that
are running.

You will need to regenerate any integrated Web
services client stubs in order to pick up the
fixes packaged as part of this PTF.

In general, it is recommended that you regenerate
any integrated Web services client stubs in order
to pick up the latest updates in the stub-generation
tools, wsdl2ws.sh and wsdl2rpg.sh, even if you have
not encountered any errors.


Default Instructions

THIS PTF CAN BE APPLIED IMMEDIATE OR DELAYED.



Supersedes

PTF/FIX NO(S).  APAR TITLE LINE
--------------  ------------------------------------------------------------
   SI75443      OSP-IWS Procedure authorization roles in SRVPGMs not being h
   SI74722      OSP-IWS - infrastructure maintenance
   SI73872      OSP-IWS  Internal improvements for future extensions
   SI73529      OSP IWS deployment unsuccessful due to compile failure
   SI73313      OSP-IWS INSTALL OF WEB SERVICE FAILED: CODE TOO LONG
   SI73313      OSP-IWS PROFILE OR IDENTITY TOKEN IS NOT VALID ERROR WITH DS
   SI73066      OSP-IWS install via script and property file not correct
   SI72299      OSP-IWS Allow payloads on REST errors
   SI72272      OSP-IWS SAVEWEBSERVICES RETURNS IWS00999E ERROR
   SI72152      OSP-IWS NULLPOINTEREXCEPTION WHEN  DEPLOYING SERVICE PROGRAM
   SI72115      OSP-IWS REDEPLOYING SERVICE FAILS, ALSO METHOD TAB IS EMPTY
   SI72047      OSP-IWS JSON error when generating swagger file
   SI72047      OSP-IWS INSTALLWEBSERVICE.SH SCRIPT FAILS WITH IWS00243E
   SI72047      OSP-IWS Qshell IWS scripts fail with LWIS00100E
   SI71612      OSP-IWS VARCHAR UTF8 INPUT DATA IS BEING TRUNCATED
   SI71495      OSP-IWS DEPLOY FAILURE CODE TOO LONG
   SI71163      OSP-IWS SQL API DEPLOY FAILS FOR XML DATA TYPE
   SI71124      OSP-IWS SQL API DEPLOY FAILS FOR GRAPHIC/VARGRAPHIC TYPES
   SI71089      OSP-IWS SQL warnings not being cleared
   SI70949      OSP-IWS SERVICE STATUS INCORRECT WHEN NON 7BIT ASCII IS USED
   SI69902      OSP-IWS Infrastructure changes for future enhancements
   SI69715      OSP-IWS NPE IS THROWN WHEN REDEPLOYING A WEB SERVICE WITH SP
   SI69715      OSP-IWS CLIENT RETURNS ARRAYINDEXOUTOFBOUNDS EXCEPTION
   SI69163      OSP-IWS TIMESTAMP WITH 0 FRACTIONAL SECONDS
   SI69103      OSP-IWS Miscellaneous fixes
   SI69103      OSP-IWS INPUT ARRAY LENGTH FOR OMITTED INPUT ARRAY NOT SET T
   SI68865      OSP-IWS SERVICE PROGRAM CONFLICTING PCML STRUCTS.
   SI68746      OSP-IWS Ability to change path to program object for web ser
   SI68746      OSP-IWS restoreWebServices.sh GENERATING INCORRECT INPUT WRA
   SI68746      OSP-IWS SOAPACTION and NAMESPACE QUALIFIED QShell script sup
   SI68602      OSP-IWS GUI not allowing date to be unwrapped
   SI68580      OSP-IWS WSDL to RPG MODULE CREATION FAILURE
   SI68499      OSP-IWS WEB ADMIN EXCEPTION ON IWS SERVERS
   SI68283      OSP-IWS transport APIs trace fixes and enhancements
   SI68148      OSP-IWS ADD USE PARAMETER NAME AS ELEMENT NAME IN INSTALLWEB
   SI68013      OSP-IWS VARCHAR 2 AND 4 BYTES INTEGERS LENGTHS BEHAVES DIFFE
   SI67975      OSP-IWS Allow UTC to be default for time/dateTime values wit
   SI67908      OSP-IWS Allow length fields to be packed, zoned in web servi
   SI67908      OSP IWS WSDL2RPG RNF5501 LARGE ELEMENT NAME
   SI67770      OSP-IWS Support xsd:time and correct problems in xsd:date an
   SI67770      OSP-IWS UPDATE INCLUDE FILE COMMENTS axiscTransportSetProper
   SI67720      OSP-IWS NUMBERFORMATEXCEPTION IN WEB SERVICE WHEN EMPTY NUME
   SI67591      OSP-IWS limiting connection pool max causes problems in web
   SI67401      OSP-IWS Migrate services from 1.3/1.5 servers to 2.6 correct
   SI67196      OSP-IWS  "value" NAMED FIELD RETURNS ALL ZEROS  FROM IWS WEB
   SI66624      OSP-IWS Integrated web services enhancements
   SI66624      OSP-IWS NPE WHEN USING NULL VALUE FOR INPUT STRUCTURE
   SI66452      OSP-IWS Miscellaneous fixes and enhancements
   SI66162      OSP-IWS server fixes
   SI65869      OSP-IWS Service getting ARRAYINDEXOUTOFBOUNDSEXCEPTION ERROR
   SI65446      OSP-IWS Swagger document definition identifier not correct
   SI65012      OSP-IWS WEB SERVICE FAILS AFTER DST CHANGE
   SI65012      OSP-IWS SWAGGER document contains _LENGTH fields
   SI65012      OSP-IWS "CANNOT FIND SYMBOL" ERROR ON INSTALLWEBSERVICE.SH
   SI64710      OSP-IWS Add support for remote web services in QShell commma
   SI64710      OSP-IWS  UNABLE TO DEPLOY REST SERVICE VIA INSTALLWEBSERVICE
   SI64602      OSP-IWS REST null values results in null pointer exception
   SI64442      OSP-IWS Enable 2-tier web services
   SI64442      OSP-IWS INCREASE PERFORMANCE OF SIMULTANEOUS WEB SERVICE REQ
   SI64300      OSP-IWS REQUEST PROBLEM WITH INPUT ARRAYS
   SI64300      OSP-IWS DEPLOY REST WEB SERVICE - JSON EXCEPTION THROWN
   SI63910      OSP-IWS Support SSL certificate not being in keystore in cli
   SI63759      OSP-IWS Support SSL over proxy in the client (IFS)
   SI63574      OSP-IWS SETTING CONTEXT ROOT TO FORWARD SLASH (/) MAKES SERV
   SI63574      OSP-IWS INSTALLWEBSERVICE WITH FIX SI63374 (SWAGGER SUPPORT)
   SI63374      OSP-IWS Add ability to control wrapper element identifier
   SI62767      OSP-IWS ALLOW 1.3/1.5 SERVERS TO ACCEPT EMPTY ELEMENTS FOR N
   SI62634      OSP-IWS Internal changes for future extensions
   SI62416      OSP-IWS INSTALLWEBSERVICE.SH SCRIPT DOES NOT ALLOW TARGETNAM
   SI62416      OSP-IWS CONSTANT INTEGERS BEING INITIALIZED TO STRINGS
   SI61496      OSP-IWS WSDL2RPG FAILS BECAUSE OF LARGE ELEMENT NAME
   SI61036      OSP-IWS Infrastructure updates for future extensions
   SI60808      OSP-IWS Client Axis.rpgleinc file updates
   SI60722      OSP-IWS UNABLE TO DEPLOY PROCEDURE THAT RETURNS AN INTEGER
   SI60722      OSP-IWS RESTOREWEBSERVICES.SH INCORRECTLY MODIFIES REST SERV
   SI60359      OSP-IWS Allow REMOTE_USER to be passed to web service as env
   SI60192      OSP-IWS BAD NUMERIC DATA IN SOAP REQUEST NOT DETECTED
   SI59962      OSP-IWS Nested arrays not being returned correctly by server
   SI59021      OSP-IWS New client APIs for REST requests (IFS updates)
   SI58649      OSP-IWS INSTALLWEBSERVICE.SH USING PCML REST ATTRIBUTES NOT
   SI58649      OSP-IWS CPF2103 MSG IS CAUSING WEB SERVICE FAILURE
   SI58649      OSP-IWS HOST SERVER CONNECTION NOT CLOSED AFTER EXCEPTION

Summary Information

System..............................i
Models..............................
Release.............................V7R3M0
Licensed Program...............5770SS1
APAR Fixed..........................View details for APAR SE75182
Superseded by:......................
Recompile...........................N
Library.............................QSYSDIR
MRI Feature ........................NONE
Cum Level...........................NONE


IBM i Support

IBM disclaims all warranties, whether express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. By furnishing this document, IBM grants no licenses to any related patents or copyrights. Copyright © 1996,1997,1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 IBM Corporation. Any trademarks and product or brand names referenced in this document are the property of their respective owners. Consult the Terms of use link for trademark information.

[{"Business Unit":{"code":"BU054","label":"Systems w\/TPS"},"Platform":[{"code":"PF012","label":"IBM i"}],"Version":"7.3","Product":{"code":"SG15V","label":"PTF Cover Letters - IBM i General"},"Component":"5770SS1","Edition":""},{"Business Unit":{"code":"BU054","label":"Systems w\/TPS"},"Platform":[{"code":"PF012","label":"IBM i"}],"Version":"7.3","Product":{"code":"SG16H","label":"PTF Cover Letters - IBM i 7.3"},"Component":"5770SS1","Edition":""}]

Document Information

Modified date:
18 April 2021