Skip to Content

Changes for page Web Services-Problems

Last modified by Francis Labrie on 2007/10/15 16:21
From version 6.1
edited by Francis Labrie
on 2007/09/26 11:17
Change comment: Updates and layout fixes
To version 9.1
edited by Francis Labrie
on 2007/10/15 16:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,3 +1,17 @@
1 +|=(((
2 +Contents
3 +)))
4 +|(((
5 +{{section}}
6 +1. [[#Problems>>doc:||anchor="Problems"]]
7 +11. [[#DirectToWebService can't return a WSDL with secure HTTPS references in it>>doc:||anchor="DirectToWebService can't return a WSDL with secure HTTPS references in it"]]
8 +11. [[#SOAP serializers and deserializers registered with ~~{~~{WOWebServiceRegistrar}} class doesn't appear in the WSDL schema>>doc:||anchor="SOAP serializers and deserializers registered with {{WOWebServiceRegistrar}} class doesn't appear in the WSDL schema"]]
9 +11. [[#DirectToWebService can't return a WSDL with custom namespace and definitions name in it>>doc:||anchor="DirectToWebService can't return a WSDL with custom namespace and definitions name in it"]]
10 +11. [[#WOWebServiceClient class can't connect to a server that requires an authentication>>doc:||anchor="WOWebServiceClient class can't connect to a server that requires an authentication"]]
11 +11. [[#Web Services can't return a WSDL with secure HTTPS references specifying port other than the default 443>>doc:||anchor="Web Services can't return a WSDL with secure HTTPS references specifying port other than the default 443"]]
12 +{{/section}}
13 +)))
14 +
1 1  = Problems =
2 2  
3 3  This section describes some problems and bugs that sometimes occur when using //WebObjects Web Services//.
... ... @@ -5,16 +5,16 @@
5 5  == DirectToWebService can't return a WSDL with secure HTTPS references in it ==
6 6  
7 7  **Authors:** Francis Labrie
8 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
9 -**Bug reference:** [[rdar://3546304]]
22 + **Affected products:** //WebObjects// 5.2.x, 5.3.x
23 + **Bug reference:** [[rdar:~~/~~/3546304>>url:rdar://3546304||shape="rect"]]
10 10  
11 11  === Problem: ===
12 12  
13 -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.
27 +A //DirectToWebService// defined Web Services doesn't return correct WSDL document, even if the correct procedure (see [[doc:WO.Secure Web Services]]) is followed. So only classes oriented Web Services manually registered with the {{code language="none"}}com.webobjects.appserver.WOWebServiceRegistrar{{/code}} class seems to generate a correct WSDL.
14 14  
15 15  === Solution: ===
16 16  
17 -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:
31 +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 language="none"}}com.webobjects.directtoweb.Assignment{{/code}} type) with the {{code language="none"}}serviceLocationURL{{/code}} key for each operation that you want to use secure HTTPS references. For instance:
18 18  
19 19  {{code}}
20 20  
... ... @@ -32,15 +32,15 @@
32 32  
33 33  {{/code}}
34 34  
35 -=== SOAP serializers and deserializers registered with ##WOWebServiceRegistrar## class doesn't appear in the WSDL schema ===
49 +== SOAP serializers and deserializers registered with {{code language="none"}}WOWebServiceRegistrar{{/code}} class doesn't appear in the WSDL schema ==
36 36  
37 37  **Authors:** Francis Labrie
38 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
39 -**Bug reference:** [[rdar://3546330]]
52 + **Affected products:** //WebObjects// 5.2.x, 5.3.x
53 + **Bug reference:** [[rdar:~~/~~/3546330>>url:rdar://3546330||shape="rect"]]
40 40  
41 -==== Problem: ====
55 +=== Problem: ===
42 42  
43 -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:
57 +Custom SOAP serializers and deserializers registered to Web Services with {{code language="none"}}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:
44 44  
45 45  {{code}}
46 46  
... ... @@ -80,9 +80,9 @@
80 80  
81 81  {{/code}}
82 82  
83 -==== Solution: ====
97 +=== Solution: ===
84 84  
85 -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:
99 +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 {{code language="none"}}writeSchema(Types){{/code}} method of the class serializer. For example:
86 86  
87 87  {{code}}
88 88  
... ... @@ -90,7 +90,7 @@
90 90  throws Exception {
91 91   ...
92 92   // Add type for Foo
93 - types.writeType(Foo.class, _FooQName);
107 + String prefixedName = types.writeType(Foo.class, _FooQName);
94 94   ...
95 95  
96 96   return true;
... ... @@ -100,19 +100,19 @@
100 100  
101 101  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...
102 102  
103 -=== DirectToWebService can't return a WSDL with custom namespace and definitions name in it ===
117 +== DirectToWebService can't return a WSDL with custom namespace and definitions name in it ==
104 104  
105 105  **Authors:** Francis Labrie
106 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
107 -**Bug reference:**
120 + **Affected products:** //WebObjects// 5.2.x, 5.3.x
121 + **Bug reference:**
108 108  
109 -==== Problem: ====
123 +=== Problem: ===
110 110  
111 111  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.
112 112  
113 -==== Solution: ====
127 +=== Solution: ===
114 114  
115 -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:
129 +Base on a tips from Darel Lee, I've found in the {{code language="none"}}com.webobjects.webservices.generation._private.WOWSDLTemplate{{/code}} class some extras key definitions read from the {{code language="none"}}user.d2wmodel{{/code}} //DirectToWebService// rule file. For instance:
116 116  
117 117  * **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;
118 118  * **WSDLDefinitionName:** a key that allow the definitions name change. So instead of having "ServiceNameDefinition", you can set this value;
... ... @@ -131,46 +131,46 @@
131 131  
132 132  {{/code}}
133 133  
134 -=== WOWebServiceClient class can't connect to a server that requires an authentication (WO 5.2.x, Bug ID 3568441) ===
148 +== WOWebServiceClient class can't connect to a server that requires an authentication ==
135 135  
136 136  **Authors:** Francis Labrie
137 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
138 -**Bug reference:** [[rdar://3568441]]
151 + **Affected products:** //WebObjects// 5.2.x, 5.3.x
152 + **Bug reference:** [[rdar:~~/~~/3568441>>url:rdar://3568441||shape="rect"]]
139 139  
140 -==== Problem: ====
154 +=== Problem: ===
141 141  
142 -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).
156 +The {{code language="none"}}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 language="none"}}setSecurityDelegateForServiceNamed(Object, String){{/code}} instance method).
143 143  
144 -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...
158 +Normally, the {{code language="none"}}processClientRequest(MessageContext){{/code}} delegate method (see {{code language="none"}}com.webobjects.webservices.support.WOSecurityDelegateinterface{{/code}} 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 language="none"}}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...
145 145  
146 -==== Solution: ====
160 +=== Solution: ===
147 147  
148 -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...
162 +The best would be to add a default method to {{code language="none"}}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...
149 149  
150 150  But a workaround is still possible:
151 151  
152 -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;
153 -1. Instanciate another ##java.net.URL## class that refer to the local WSDL document file;
154 -1. Instanciate the ##com.webobjects.webservices.client.WOWebServiceClient## class using the file URL;
166 +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 {{code language="none"}}java.net.URLConnection{{/code}} yourself;
167 +1. Instanciate another {{code language="none"}}java.net.URL{{/code}} class that refer to the local WSDL document file;
168 +1. Instanciate the {{code language="none"}}com.webobjects.webservices.client.WOWebServiceClient{{/code}} class using the file URL;
155 155  1. Set for each service a security delegate that will add the proper credential information for the Basic HTTP Authentication.
156 156  
157 157  That's it. It looks like a big hack, but it works...
158 158  
159 -=== Web Services can't return a WSDL with secure HTTPS references specifying port other than the default 443 ===
173 +== Web Services can't return a WSDL with secure HTTPS references specifying port other than the default 443 ==
160 160  
161 161  **Authors:** Francis Labrie
162 -**Affected products:** //WebObjects// 5.2.x, 5.3.x
163 -**Bug reference:** [[rdar://4196417]]
176 + **Affected products:** //WebObjects// 5.2.x, 5.3.x
177 + **Bug reference:** [[rdar:~~/~~/4196417>>url:rdar://4196417||shape="rect"]]
164 164  
165 -==== Problem: ====
179 +=== Problem: ===
166 166  
167 167  HTTPS protocol references can be published in Web Services WSDL. But unfortunately, WebObjects seems to ignore ports other than the default 443.
168 168  
169 -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.
183 +This problem is related to the bad way {{code language="none"}}com.webobjects.appserver.WORequest{{/code}} builds the URL prefix: if the protocol is secure and no port (i.e. 0) is set when calling the {{code language="none"}}_completeURLPrefix(StringBuffer, boolean, int){{/code}} method, the port will always be 443. Unfortunately, Web Services {{code language="none"}}com.webobjects.appserver._private.WOWebService{{/code}} class seems to call this method without setting the port number.
170 170  
171 -==== Solution: ====
185 +=== Solution: ===
172 172  
173 -To work around this bug, you can subclass the ##com.webobjects.appserver.WORequest## class like this:
187 +To work around this bug, you can subclass the {{code language="none"}}com.webobjects.appserver.WORequest{{/code}} class like this:
174 174  
175 175  {{code}}
176 176