Skip to Content

Changes for page Web Services-Problems

Last modified by Francis Labrie on 2007/10/15 16:21
From version 7.1
edited by Francis Labrie
on 2007/10/09 13:16
Change comment: Layout and content table.
To version 5.1
edited by smmccraw
on 2007/07/08 09:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Web Services-Problems
1 +Programming__WebObjects-Web Services-Problems
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.flabrie
1 +XWiki.smmccraw
Content
... ... @@ -1,60 +1,70 @@
1 -|= Contents
2 -| {{section}}
3 -# [#Problems]
4 -## [#DirectToWebService can't return a WSDL with secure HTTPS references in it]
5 -## [#SOAP serializers and deserializers registered with {{WOWebServiceRegistrar}} class doesn't appear in the WSDL schema]
6 -## [#DirectToWebService can't return a WSDL with custom namespace and definitions name in it]
7 -## [#WOWebServiceClient class can't connect to a server that requires an authentication]
8 -## [#Web Services can't return a WSDL with secure HTTPS references specifying port other than the default 443]
9 -{{/section}}
1 += Problems =
10 10  
11 -= Problems =
12 -
13 13  This section describes some problems and bugs that sometimes occur when using //WebObjects Web Services//.
14 14  
15 -== DirectToWebService can't return a WSDL with secure HTTPS references in it ==
5 +== DirectToWebService can't return a WSDL with secure HTTPS references in it ==
16 16  
17 -**Authors:** Francis Labrie
18 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
19 -**Bug reference:** [[rdar://3546304]]
7 + **Authors:** Francis Labrie
20 20  
21 -=== Problem: ===
9 + **Affected products:** //WebObjects// 5.2.x, 5.3.x
22 22  
23 -A //DirectToWebService// defined Web Services doesn't return correct WSDL document, even if the correct procedure (see [[Secure Web Services]]) is followed. So only classes oriented Web Services manually registered with the ##com.webobjects.appserver.WOWebServiceRegistrar## class seems to generate a correct WSDL.
11 + **Bug reference:** rdar:~/~/3546304
24 24  
25 -=== Solution: ===
13 +=== Problem: ===
26 26  
27 -Darel Lee from Apple told me that right now, the dynamic WSDL generation is not exposed to developers so there currently isn't a clean solution to perform this. One workaround is to hardcode rules (of ##com.webobjects.directtoweb.Assignment## type) with the ##serviceLocationURL## key for each operation that you want to use secure HTTPS references. For instance:
15 +A //DirectToWebService// defined Web Services doesn't return correct WSDL document, even if the correct procedure (see Secure Web Services) is followed. So only classes oriented Web Services manually registered with the {{code}}com.webobjects.appserver.WOWebServiceRegistrar{{/code}} class seems to generate a correct WSDL.
28 28  
17 +=== Solution: ===
18 +
19 +Darel Lee from Apple told me that right now, the dynamic WSDL generation is not exposed to developers so there currently isn't a clean solution to perform this. One workaround is to hardcode rules (of {{code}}com.webobjects.directtoweb.Assignment{{/code}} type) with the {{code}}serviceLocationURL{{/code}} key for each operation that you want to use secure HTTPS references. For instance:
20 +
21 +{{panel}}
22 +
23 + {code}
24 +
25 +{{/panel}}
26 +
27 +((operationName="anOperation") and (serviceName="Service")) ->
28 +
29 +{{panel}}
30 +
31 + serviceLocationURL="https://host.net/cgi-bin/Service.woa/ws/Service"
32 +
33 +{{/panel}}
34 +
29 29  {{code}}
30 30  
31 -((operationName="anOperation") and (serviceName="Service")) ->
32 - serviceLocationURL="https://host.net/cgi-bin/Service.woa/ws/Service"
33 33  
38 +If you need all operation to be called using the secure protocol, you can also define a more generic rule like this one:
39 +
40 +
34 34  {{/code}}
35 35  
36 -If you need all operation to be called using the secure protocol, you can also define a more generic rule like this one:
43 +(serviceName="Service") ->
44 + serviceLocationURL="https:~/~/host.net/cgi-bin/Service.woa/ws/Service"
37 37  
38 38  {{code}}
39 39  
40 -(serviceName="Service") ->
41 - serviceLocationURL="https://host.net/cgi-bin/Service.woa/ws/Service"
42 42  
49 +h2. SOAP serializers and deserializers registered with
43 43  {{/code}}
44 44  
45 -== SOAP serializers and deserializers registered with ##WOWebServiceRegistrar## class doesn't appear in the WSDL schema ==
52 +WOWebServiceRegistrar{{code}} class doesn't appear in the WSDL schema
53 + *Authors:* Francis Labrie
46 46  
47 -**Authors:** Francis Labrie
48 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
49 -**Bug reference:** [[rdar://3546330]]
55 + *Affected products:* _WebObjects_ 5.2.x, 5.3.x
50 50  
51 -=== Problem: ===
57 + *Bug reference:* rdar://3546330
52 52  
53 -Custom SOAP serializers and deserializers registered to Web Services with ##com.webobjects.appserver.WOWebServiceRegistrar## class are never added to the types / schema definition of the WSDL. The only type definitions shown are the following:
54 54  
55 -{{code}}
60 +h3. Problem:
61 +Custom SOAP serializers and deserializers registered to Web Services with {{/code}}com.webobjects.appserver.WOWebServiceRegistrar{{code}} class are never added to the types / schema definition of the WSDL. The only type definitions shown are the following:
56 56  
57 -<types>
63 +{{/code}}
64 +
65 +{{panel}}
66 +
67 + <types>
58 58   <schema targetNamespace="http://lang.java/" xmlns:soapenc=
59 59   "http://schemas.xmlsoap.org/soap/encoding/" xmlns=
60 60   "http://www.w3.org/2001/XMLSchema">
... ... @@ -70,7 +70,7 @@
70 70   </complexContent>
71 71   </complexType>
72 72   <element name="ArrayOf_xsd_any" nillable="true" type=
73 - "lang:ArrayOf_xsd_any"/>
83 + "lang:ArrayOf_xsd_any"/>
74 74   </schema>
75 75   <schema targetNamespace="http://www.apple.com/webobjects/
76 76   webservices/soap/" xmlns:soapenc="http://schemas.xmlsoap.org/
... ... @@ -79,7 +79,7 @@
79 79   <element name="entityName" type="xsd:string"/>
80 80   <element name="primaryKeys" type="lang:ArrayOf_xsd_any"/>
81 81   </complexType>
82 - <element name="EOGlobalID" type="tns:EOGlobalID"/>
92 + <element name="EOGlobalID" type="tns:EOGlobalID"/>
83 83   <complexType name="EOEnterpriseObject">
84 84   <element name="entityName" type="xsd:string"/>
85 85   <element name="globalID" type="webobjects:EOGlobalID"/>
... ... @@ -88,102 +88,90 @@
88 88   </schema>
89 89   </types>
90 90  
91 -{{/code}}
101 +{{/panel}}
92 92  
93 -=== Solution: ===
94 -
95 -You must know that all complexe data types referred in operations will be added to the WSDL types definition. But if a complexe type makes references to others complexe types, you should make sure you add proper calls in the ##writeSchema(Types)## method of the class serializer. For example:
96 -
97 97  {{code}}
98 98  
99 -public boolean writeSchema(Types types)
100 -throws Exception {
101 - ...
102 - // Add type for Foo
103 - types.writeType(Foo.class, _FooQName);
104 - ...
105 105  
106 - return true;
107 -}
106 +h3. Solution:
107 +I don't know any dynamic workaround right now... But a static and complete WSDL can be shared through a direct action. It's not very handy though...
108 108  
109 -{{/code}}
109 +h2. DirectToWebService can't return a WSDL with custom namespace and definitions name in it
110 + *Authors:* Francis Labrie
110 110  
111 -Unfortunately, I don't know a dynamic workaround for all possible cases right now. At least a static and complete WSDL can be shared through a direct action, but it's not very handy though...
112 + *Affected products:* _WebObjects_ 5.2.x, 5.3.x
112 112  
113 -== DirectToWebService can't return a WSDL with custom namespace and definitions name in it ==
114 + *Bug reference:*
114 114  
115 -**Authors:** Francis Labrie
116 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
117 -**Bug reference:**
118 118  
119 -=== Problem: ===
117 +h3. Problem:
118 +A _DirectToWebService_ defined Web Services can't return a WSDL with custom values for properties like namespaces and definitions name. Worse, the generated namespace can even contains WebObjects application instance number or the wrong hostname.
120 120  
121 -A //DirectToWebService// defined Web Services can't return a WSDL with custom values for properties like namespaces and definitions name. Worse, the generated namespace can even contains WebObjects application instance number or the wrong hostname.
120 +h3. Solution:
121 +Base on a tips from Darel Lee, I've found in the
122 +{{/code}}
122 122  
123 -=== Solution: ===
124 +com.webobjects.webservices.generation.//private.WOWSDLTemplate{{code}} class some extras key definitions read from the user.d2wmodel DirectToWebService rule file. For instance:
124 124  
125 -Base on a tips from Darel Lee, I've found in the ##com.webobjects.webservices.generation.private.WOWSDLTemplate## class some extras key definitions read from the ##user.d2wmodel## //DirectToWebService// rule file. For instance:
126 +* *serviceLocationURL:* a key that allow the setting of the location URL for an operation. This is usefull if you need your WebServices to be reached using a secure HTTPS reference;
127 +* *WSDLDefinitionName:* a key that allow the definitions name change. So instead of having "ServiceNameDefinition", you can set this value;
128 +* *WSDLTargetNamespace:* a key that allow the namespace change. This is the most usefull: you can avoid dynamic generation depending on WebObjects HTTP Adaptor? with this.
126 126  
127 -* **serviceLocationURL:** a key that allow the setting of the location URL for an operation. This is usefull if you need your WebServices to be reached using a secure HTTPS reference;
128 -* **WSDLDefinitionName:** a key that allow the definitions name change. So instead of having "ServiceNameDefinition", you can set this value;
129 -* **WSDLTargetNamespace:** a key that allow the namespace change. This is the most usefull: you can avoid dynamic generation depending on WebObjects HTTP Adaptor with this.
130 -
131 131  Here is an example of rule definition changing the above values:
132 132  
132 +{{/code}}
133 +(serviceName="Service") ->
134 + WSDLTargetNamespace="https:~/~/host.net/cgi-bin/Service.woa/ws/Service"
135 +(serviceName="Service") ->
136 + WSDLDefinitionName="AnotherDefinition"
137 +((operationName="anOperation") and (serviceName="Service")) ->
138 + serviceLocationURL="https:~/~/host.net/cgi-bin/Service.woa/ws/Service"//
139 +
133 133  {{code}}
134 134  
135 -(se(serviceName="Service") ->
136 - WSDLTargetNamespace="https://host.net/cgi-bin/Service.woa/ws/Service"
137 -(serviceName="Service") ->
138 - WSDLDefinitionName="AnotherDefinition"
139 -((operationName="anOperation") and (serviceName="Service")) ->
140 - serviceLocationURL="https://host.net/cgi-bin/Service.woa/ws/Service"
142 +h2. WOWebServiceClient class can't connect to a server that requires an authentication (WO 5.2.x, Bug ID 3568441)
143 + *Authors:* Francis Labrie
141 141  
142 -{{/code}}
145 + *Affected products:* _WebObjects_ 5.2.x, 5.3.x
143 143  
144 -== WOWebServiceClient class can't connect to a server that requires an authentication ==
147 + *Bug reference:* rdar://3568441
145 145  
146 -**Authors:** Francis Labrie
147 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
148 -**Bug reference:** [[rdar://3568441]]
149 149  
150 -=== Problem: ===
150 +h3. Problem:
151 +The
152 +{{/code}}
151 151  
152 -The ##com.webobjects.webservices.client.WOWebServiceClient## class can't connect to a server that requires a Basic HTTP Authentication despite the fact this class offers a way to register a security delegate (see ##setSecurityDelegateForServiceNamed(Object, String)## instance method).
154 +com.webobjects.webservices.client.WOWebServiceClient{{code}} class can't connect to a server that requires a Basic HTTP Authentication despite the fact this class offers a way to register a security delegate (see {{/code}}setSecurityDelegateForServiceNamed(Object, String){{code}} instance method).
153 153  
154 -Normally, the ##processClientRequest(MessageContext)## delegate method (see ##com.webobjects.webservices.support.WOSecurityDelegateinterface## documentation) would allow an easy way to set a username and a password to the message context. But there is a problem related to the design of the class: to register a security delegate, the ##WOWebServiceClient## class has to fetch the Web Services Definition Language (WSDL) XML document. But to get access to this WSDL, an authentication header must be set. This is the classic chicken and egg problem...
156 +Normally, the {{/code}}processClientRequest(MessageContext){{code}} delegate method (see {{/code}}com.webobjects.webservices.support.WOSecurityDelegate{{code}} interface documentation) would allow an easy way to set a username and a password to the message context. But there is a problem related to the design of the class: to register a security delegate, the {{/code}}WOWebServiceClient{{code}} class has to fetch the Web Services Definition Language (WSDL) XML document. But to get access to this WSDL, an authentication header must be set. This is the classic chicken and egg problem...
155 155  
156 -=== Solution: ===
158 +h3. Solution:
159 +The best would be to add a default method to {{/code}}WOWebServiceClient{{code}} class to register a default security delegate that is not related to a service name before the class fetch the WSDL. But unfortunately, all key methods that would allow this kind of behavior change are privates, so subclassing is not a solution...
157 157  
158 -The best would be to add a default method to ##WOWebServiceClient## class to register a default security delegate that is not related to a service name before the class fetch the WSDL. But unfortunately, all key methods that would allow this kind of behavior change are privates, so subclassing is not a solution...
161 +But a workaround is still possible:
159 159  
160 -But a workaround is still possible:
163 +# Fetch the WSDL document yourself and store it to the local filesystem, using the java.net.URL instance and setting up the Basic HTTP Authentication header field of the {{/code}}java.net.URLConnection{{code}} yourself;
164 +# Instanciate another {{/code}}java.net.URL{{code}} class that refer to the local WSDL document file;
165 +# Instanciate the {{/code}}com.webobjects.webservices.client.WOWebServiceClient<>code> class using the file URL;
161 161  
162 -1. Fetch the WSDL document yourself and store it to the local filesystem, using the java.net.URL instance and setting up the Basic HTTP Authentication header field of the ##java.net.URLConnection## yourself;
163 -1. Instanciate another ##java.net.URL## class that refer to the local WSDL document file;
164 -1. Instanciate the ##com.webobjects.webservices.client.WOWebServiceClient## class using the file URL;
165 165  1. Set for each service a security delegate that will add the proper credential information for the Basic HTTP Authentication.
166 166  
167 167  That's it. It looks like a big hack, but it works...
168 168  
169 -== Web Services can't return a WSDL with secure HTTPS references specifying port other than the default 443 ==
171 +~=== Web Services can't return a WSDL with secure HTTPS references specifying port other than the default 443 ===
172 +~: '''Authors:''' Francis Labrie<br>
173 +~: '''Affected products:''' ''WebObjects'' 5.2.x, 5.3.x<br>
174 +~: '''Bug reference:''' rdar:~/~/4196417<br>
170 170  
171 -**Authors:** Francis Labrie
172 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
173 -**Bug reference:** [[rdar://4196417]]
174 -
175 -=== Problem: ===
176 -
176 +~==== Problem: ====
177 177  HTTPS protocol references can be published in Web Services WSDL. But unfortunately, WebObjects seems to ignore ports other than the default 443.
178 178  
179 -This problem is related to the bad way ##com.webobjects.appserver.WORequest## builds the URL prefix: if the protocol is secure and no port (i.e. 0) is set when calling the ##//completeURLPrefix(StringBuffer, boolean, int)//##// method, the port will always be 443. Unfortunately, Web Services ##com.webobjects.appserver.##//##private.WOWebService## class seems to call this method without setting the port number.
179 +This problem is related to the bad way <code>com.webobjects.appserver.WORequest{{code}} build the URL prefix: if the protocol is secure and no port (i.e. 0) is set when calling the {{/code}}//completeURLPrefix(StringBuffer,boolean,int){{code}} method, the port will always be 443. Unfortunately, Web Services {{/code}}com.webobjects.appserver.//private.WOWebService{{code}} class seems to call this method without setting the port number.
180 180  
181 -=== Solution: ===
181 +h3. Solution:
182 +To work around this bug, you can subclass the {{/code}}com.webobjects.appserver.WORequest{{code}} class like this:
182 182  
183 -To work around this bug, you can subclass the ##com.webobjects.appserver.WORequest## class like this:
184 -
185 -{{code}}
186 -
184 +{{/code}}
187 187  package com.smoguli.appserver;
188 188  
189 189  import com.webobjects.appserver.WORequest;
... ... @@ -190,51 +190,63 @@
190 190  import com.webobjects.foundation.NSData;
191 191  import com.webobjects.foundation.NSDictionary;
192 192  
193 -/**
191 +/
192 +
193 +{{panel}}
194 +
194 194   * This class provide fixed {@link com.webobjects.appserver.WORequest} methods.
195 195   * To use it, just overload the {@link com.webobjects.appserver.WOApplication.
196 - * createRequest(String,String,String,NSDictionary,NSData,NSDictionary)} method
197 + * createRequest(String,String,String,NSDictionary,NSData,NSDictionary)} method
197 197   * to instanciate this class instead.
198 198   *
199 - * @author Francis Labrie <francis.labrie at smoguli.com>
200 + * @author Francis Labrie <francis.labrie at smoguli.com>
200 200   */
202 +
203 +{{/panel}}
204 +
201 201  public class WOFixedRequest extends WORequest {
202 202  
203 - /**
204 - * @see com.webobjects.appserver.WORequest#WORequest(String,String,String,
205 - * NSDictionary,NSData,NSDictionary)
206 - */
207 - public WOFixedRequest(String method, String url, String httpVersion, NSDictionary headers, NSData content, NSDictionary info) {
208 - super(method, url, httpVersion, headers, content, info);
209 - } // WOFixedRequest
207 + /
210 210  
211 - /**
212 - * This method builds the URL prefix into the <code>urlPrefix</code> buffer
213 - * with the appropriate protocol (<code>http</code> or <code>https</code>)
214 - * and the right TCP port. But unlike the {@link com.webobjects.appserver.
215 - * WORequest#_completeURLPrefix(StringBuffer,boolean,int} method, it
216 - * supports secure HTTP protocol (<code>https</code>) with port other than
217 - * <code>443</code>, even if the <code>port</code> parameter is set
218 - * <code>0</code>.
219 - *
220 - * @param urlPrefix the buffer that receives the contructed URL.
221 - * @param isSecure a flag indicating if the protocol is secure.
222 - * @param port the port number.
223 - */
224 - public void _completeURLPrefix(StringBuffer urlPrefix, boolean isSecure, int port) {
225 - if(isSecure && (port == 0)) {
226 - String serverPort;
209 +* @see com.webobjects.appserver.WORequest#WORequest(String,String,String,
210 +* NSDictionary,NSData,NSDictionary)
211 + **/
212 + public WOFixedRequest(String method, String url, String httpVersion, NSDictionary headers, NSData content, NSDictionary info) {
213 + super(method, url, httpVersion, headers, content, info);
214 + } ~/~/ WOFixedRequest**
227 227  
228 - serverPort = _serverPort();
229 - if((serverPort != null) && !serverPort.equals("443")) {
230 - try {
231 - port = Integer.parseInt(serverPort);
232 - } catch(NumberFormatException exception) {} // catch
233 - } // if
234 - } // if
216 + /
235 235  
236 - super._completeURLPrefix(urlPrefix, isSecure, port);
237 - } // _completeURLPrefix
238 -} // WOFixedRequest
218 +* This method builds the URL prefix into the <code>urlPrefix</code> buffer
219 +* with the appropriate protocol (<code>http</code> or <code>https</code>)
220 +* and the right TCP port. But unlike the {@link com.webobjects.appserver.
221 +* WORequest#//completeURLPrefix(StringBuffer,boolean,int} method, it //
222 +* supports secure HTTP protocol (<code>https</code>) with port other than
223 +* <code>443</code>, even if the <code>port</code> parameter is set
224 +* <code>0</code>.
225 +
226 +* @param urlPrefix the buffer that receives the contructed URL.
227 +* @param isSecure a flag indicating if the protocol is secure.
228 +* @param port the port number.
229 + **/
230 + public void //completeURLPrefix(StringBuffer urlPrefix, boolean isSecure, int port) {
231 + if(isSecure && (port == 0)) {
232 + String serverPort;//**
239 239  
234 + serverPort = //serverPort();
235 + if((serverPort [[image:= null) &&]]serverPort.equals("443")) {
236 + try {
237 + port = Integer.parseInt(serverPort);
238 + } catch(NumberFormatException exception) {} ~/~/ catch
239 + } ~/~/ if
240 + } ~/~/ if//
241 +
242 + super.//completeURLPrefix(urlPrefix, isSecure, port);
243 + } ~/~/ //completeURLPrefix
244 +} ~/~/ WOFixedRequest
245 +
246 +{{code}}
247 +
248 +
249 +Category:WebObjects
240 240  {{/code}}