Skip to Content
Last modified by Pascal Robert on 2007/09/03 19:24
From version 2.1
edited by smmccraw
on 2007/07/08 10:35
Change comment: There is no comment for this version
To version 4.1
edited by Pascal Robert
on 2007/09/03 19:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Programming__WebObjects-Web Services-Controlling WSDL Service Location
1 +Web Services-Controlling WSDL Service Location
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.smmccraw
1 +XWiki.probert
Content
... ... @@ -1,40 +1,36 @@
1 -This documentation was written by Andrew Lindesay (http:~/~/www.lindesay.co.nz) in 2006 as part of supported code in the LEWOStuff framework, but this material has been transcribed here. It was written around the time of WebObjects 5.2 and 5.3 on the 1.4 JVM.
1 +This documentation was written by Andrew Lindesay ([[http:~~/~~/www.lindesay.co.nz>>url:http://www.lindesay.co.nz||shape="rect"]]) in 2006 as part of supported code in the LEWOStuff framework, but this material has been transcribed here. It was written around the time of WebObjects 5.2 and 5.3 on the 1.4 JVM.
2 2  
3 -AXIS provides a number of handlers for ultimately executing the WS. This generally works in the WebObjects environment out of the box. However, in the case of a servlet deployment, the URLs are manipulated by the servlet container so they look something like this.
3 +AXIS provides a number of handlers for ultimately executing the WS. This generally works in the WebObjects environment out of the box. However, in the case of a servlet deployment, the URLs are manipulated by the servlet container so they look something like this.
4 4  
5 5  {{panel}}
6 -
7 - ...ects/FOO.woa/ws/FooService<font color="red">;jsessionid=abc.i1</font>?wsdl
8 -
6 +...ects/FOO.woa/ws/FooService;jsessionid=abc.i1?wsdl
9 9  {{/panel}}
10 10  
11 -If a client starts a session on a WS invocation then you want all subsequent requests to return to this same servlet container (Here we assume a redundant deployment where there are a number of servlet containers.) where the session resides. However the servlet-container's HTTP adaptor typically only knows this by looking at the modified URL. Unfortunately, the default WSDL generated by AXIS would have a section like this.
9 +If a client starts a session on a WS invocation then you want all subsequent requests to return to this same servlet container (Here we assume a redundant deployment where there are a number of servlet containers.) where the session resides. However the servlet-container's HTTP adaptor typically only knows this by looking at the modified URL. Unfortunately, the default WSDL generated by AXIS would have a section like this.
12 12  
13 13  {{code}}
12 +
14 14  ...
15 15  <wsdl:service name="FooService">
16 -{panel}
17 17   <wsdl:port name="FooService" binding="impl:FooService SoapBinding">
18 18   <wsdlsoap:address location="http://foo.co.nz/FOO/WebObjects/FOO.woa/ws/FooService"/>
19 19   </wsdl:port>
20 -{panel}
21 21  </wsdl:service>
22 22  ...
23 23  
24 24  {{/code}}
25 25  
26 -A WSDL like this does not contain the modified URL caused by the context having a session in the location for the service. The example handler //LEWOWebServicesWSDLLocationHandler// below which is supplied in LEWOStuff will correct the location supplied in the WSDL to contain the session information. To install this handler for use in WebObjects, locate the //server.wsdd// file within your project and modify the following section so that it appears as follows.
23 +A WSDL like this does not contain the modified URL caused by the context having a session in the location for the service. The example handler //LEWOWebServicesWSDLLocationHandler// below which is supplied in LEWOStuff will correct the location supplied in the WSDL to contain the session information. To install this handler for use in WebObjects, locate the //server.wsdd// file within your project and modify the following section so that it appears as follows.
27 27  
28 28  {{code}}
26 +
29 29  ...
30 30  <transport name="http">
31 -{panel}
32 32   <requestFlow>
33 33   <handler type="HTTPActionHandler"/>
34 34   <handler type="URLMapper"/>
35 35   <handler type="java:nz.co.lindesay.common.webobjects.LEWOWebServicesWSDLLocationHandler"/>
36 36   </requestFlow>
37 -{panel}
38 38  </transport>
39 39  
40 40  {{/code}}
... ... @@ -58,17 +58,13 @@
58 58  following conditions are met:
59 59  
60 60  * Redistributions of source code must retain the above
61 -{panel}
62 62   copyright notice, this list of conditions and the
63 63   following disclaimer.
64 -{panel}
65 65  
66 66  * Redistributions in binary form must reproduce the above
67 -{panel}
68 68   copyright notice, this list of conditions and the
69 69   following disclaimer in the documentation and/or other
70 70   materials provided with the distribution.
71 -{panel}
72 72  
73 73  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
74 74  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
... ... @@ -94,12 +94,11 @@
94 94  import org.apache.axis.*;
95 95  
96 96  /**
97 -{panel}
98 98   * <P>This class is an AXIS request handler that is designed to
99 99   * manipulate the outbound WSDL that is generated for a
100 100   * request. The manipulation undertaken here is to modify the
101 101   * location of the actual service. The reason for doing this is
102 - * that if you have a web service deployed into a servlet
93 + * that if you have a web service deployed into a servlet
103 103   * container as a WO application, the session'ed URLs can look
104 104   * a bit like this.</P>
105 105   *
... ... @@ -116,12 +116,11 @@
116 116   * handler list as the last item in the list. This should be the
117 117   * request flow in the HTTP transport section.</P>
118 118   *
119 - * <P><TT>&lt;handler type="java:nz.co.lindesay.common.webobjects.LEWOWebServicesWSDLLocationHandler"/&gt;</TT></P>
110 + * <P><TT><handler type="java:nz.co.lindesay.common.webobjects.LEWOWebServicesWSDLLocationHandler"/></TT></P>
120 120   *
121 121   * <P>This should also work with the "<I>wotaskd</I>" deployment
122 122   * style as well.</P>
123 123   */
124 -{panel}
125 125  
126 126  public class LEWOWebServicesWSDLLocationHandler extends org.apache.axis.handlers.BasicHandler
127 127  {
... ... @@ -128,91 +128,87 @@
128 128  
129 129  // --------------------------------------------------------------
130 130  
131 - public LEWOWebServicesWSDLLocationHandler() { super(); }
121 + public LEWOWebServicesWSDLLocationHandler() { super(); }
132 132  
133 133  // --------------------------------------------------------------
134 134  
135 135  /**
136 -{panel}
137 137   * <P>This is the AXIS hook where we can manipulate the outbound
138 138   * WSDL.</P>
139 139   */
140 -{panel}
141 141  
142 - public void generateWSDL(MessageContext msgContext) throws AxisFault
143 - {
144 - WOContext context = WOWebServiceUtilities.currentWOContext();
145 - WORequest request = context.request();
146 - String host = LEWOHelper.getExternalHostnameFromInboundRequest(request);
147 - int port = LEWOHelper.getExternalPortFromInboundRequest(request);
148 - int appi = request.applicationNumber();
149 -
150 - if((null==host)||(0==host.length()))
151 - throw new IllegalStateException("the host cannot be determined from the inbound request.");
152 -
153 - if(context.hasSession())
154 - context.session();
155 -
156 - StringBuffer sb = new StringBuffer();
157 -
158 - sb.append("http://");
159 - sb.append(host);
160 -
161 - if(-1!=port)
162 - {
163 - sb.append(":");
164 - sb.append(Integer.toString(port));
165 - }
166 -
167 - String path = context.urlWithRequestHandlerKey(
168 - request.requestHandlerKey(),
169 - request.requestHandlerPath(),
170 - null);
171 -
130 + public void generateWSDL(MessageContext msgContext) throws AxisFault
131 + {
132 + WOContext context = WOWebServiceUtilities.currentWOContext();
133 + WORequest request = context.request();
134 + String host = LEWOHelper.getExternalHostnameFromInboundRequest(request);
135 + int port = LEWOHelper.getExternalPortFromInboundRequest(request);
136 + int appi = request.applicationNumber();
137 +
138 + if((null==host)||(0==host.length()))
139 + throw new IllegalStateException("the host cannot be determined from the inbound request.");
140 +
141 + if(context.hasSession())
142 + context.session();
143 +
144 + StringBuffer sb = new StringBuffer();
145 +
146 + sb.append("http://");
147 + sb.append(host);
148 +
149 + if(-1!=port)
150 + {
151 + sb.append(":");
152 + sb.append(Integer.toString(port));
153 + }
154 +
155 + String path = context.urlWithRequestHandlerKey(
156 + request.requestHandlerKey(),
157 + request.requestHandlerPath(),
158 + null);
159 +
172 172  // Unless the context has a session, we can't get it to come back
173 173  // to a specific instance, but in the case of a 'wotaskd' deploy,
174 174  // there is no way to specify the session for a WSDL request, so
175 175  // we'll do a nasty hack to make this work.
176 -
177 - if((-1!=appi)&&(!context.hasSession()))
178 - {
179 - String webServiceRequestHandlerKey = WOApplication.application().webServiceRequestHandlerKey();
180 - String startPath = request.adaptorPrefix()+"/"+request.applicationName()+".woa"; // ''/cgi-bin/WebObjects/Foo.woa''
181 -
182 - if(!path.startsWith(startPath))
183 - throw new IllegalStateException("The path '"+path+"' should have started with '"+startPath+"'");
184 184  
185 - if(path.startsWith(startPath+"/"+webServiceRequestHandlerKey))
186 - {
187 - StringBuffer pathSB = new StringBuffer();
188 -
189 - pathSB.append(startPath);
190 - pathSB.append("/");
191 - pathSB.append(Integer.toString(appi));
192 - pathSB.append(path.substring(startPath.length()));
193 -
194 - path = pathSB.toString();
195 - }
196 - }
197 -
198 - sb.append(path);
199 -
200 - msgContext.setProperty(MessageContext.WSDLGEN_SERV_LOC_URL,sb.toString());
201 - }
165 + if((-1!=appi)&&(!context.hasSession()))
166 + {
167 + String webServiceRequestHandlerKey = WOApplication.application().webServiceRequestHandlerKey();
168 + String startPath = request.adaptorPrefix()+"/"+request.applicationName()+".woa"; // ''/cgi-bin/WebObjects/Foo.woa''
202 202  
170 + if(!path.startsWith(startPath))
171 + throw new IllegalStateException("The path '"+path+"' should have started with '"+startPath+"'");
172 +
173 + if(path.startsWith(startPath+"/"+webServiceRequestHandlerKey))
174 + {
175 + StringBuffer pathSB = new StringBuffer();
176 +
177 + pathSB.append(startPath);
178 + pathSB.append("/");
179 + pathSB.append(Integer.toString(appi));
180 + pathSB.append(path.substring(startPath.length()));
181 +
182 + path = pathSB.toString();
183 + }
184 + }
185 +
186 + sb.append(path);
187 +
188 + msgContext.setProperty(MessageContext.WSDLGEN_SERV_LOC_URL,sb.toString());
189 + }
190 +
203 203  // --------------------------------------------------------------
204 204  
205 205  /**
206 -{panel}
207 207   * <P>Basically there is nothing to do here because we are not
208 208   * interested in messing with the request/response cycle - rather
209 209   * we want only to manipulate the WSDL.</P>
210 210   */
211 -{panel}
212 212  
213 - public void invoke(MessageContext msgContext) throws AxisFault
214 - {
215 - }
199 + public void invoke(MessageContext msgContext) throws AxisFault
200 + {
201 + }
216 216  
217 217  // --------------------------------------------------------------
218 218