Changes for page Web Services-Controlling WSDL Service Location

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Web Services-Controlling WSDL Service Location
	1	+Programming__WebObjects-Web Services-Controlling WSDL Service Location

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.probert
	1	+XWiki.smmccraw

Content

...	...	@@ -1,10 +1,10 @@
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) 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	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	6
7		-...ects/FOO.woa/ws/FooService;jsessionid=abc.i1?wsdl
	7	+ ...ects/FOO.woa/ws/FooService<font color="red">;jsessionid=abc.i1</font>?wsdl
8	8
9	9	{{/panel}}
10	10
...	...	@@ -11,12 +11,13 @@
11	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.
12	12
13	13	{{code}}
14		-
15	15	...
16	16	<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}
20	20	</wsdl:service>
21	21	...
22	22
...	...	@@ -25,14 +25,15 @@
25	25	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.
26	26
27	27	{{code}}
28		-
29	29	...
30	30	<transport name="http">
	31	+{panel}
31	31	<requestFlow>
32	32	<handler type="HTTPActionHandler"/>
33	33	<handler type="URLMapper"/>
34	34	<handler type="java:nz.co.lindesay.common.webobjects.LEWOWebServicesWSDLLocationHandler"/>
35	35	</requestFlow>
	37	+{panel}
36	36	</transport>
37	37
38	38	{{/code}}
...	...	@@ -56,13 +56,17 @@
56	56	following conditions are met:
57	57
58	58	* Redistributions of source code must retain the above
	61	+{panel}
59	59	copyright notice, this list of conditions and the
60	60	following disclaimer.
	64	+{panel}
61	61
62	62	* Redistributions in binary form must reproduce the above
	67	+{panel}
63	63	copyright notice, this list of conditions and the
64	64	following disclaimer in the documentation and/or other
65	65	materials provided with the distribution.
	71	+{panel}
66	66
67	67	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
68	68	CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
...	...	@@ -88,11 +88,12 @@
88	88	import org.apache.axis.*;
89	89
90	90	/**
	97	+{panel}
91	91	* <P>This class is an AXIS request handler that is designed to
92	92	* manipulate the outbound WSDL that is generated for a
93	93	* request. The manipulation undertaken here is to modify the
94	94	* location of the actual service. The reason for doing this is
95		- * that if you have a web service deployed into a servlet
	102	+ * that if you have a web service deployed into a servlet
96	96	* container as a WO application, the session'ed URLs can look
97	97	* a bit like this.</P>
98	98	*
...	...	@@ -109,11 +109,12 @@
109	109	* handler list as the last item in the list. This should be the
110	110	* request flow in the HTTP transport section.</P>
111	111	*
112		- * <P><TT><handler type="java:nz.co.lindesay.common.webobjects.LEWOWebServicesWSDLLocationHandler"/></TT></P>
	119	+ * <P><TT>&lt;handler type="java:nz.co.lindesay.common.webobjects.LEWOWebServicesWSDLLocationHandler"/&gt;</TT></P>
113	113	*
114	114	* <P>This should also work with the "<I>wotaskd</I>" deployment
115	115	* style as well.</P>
116	116	*/
	124	+{panel}
117	117
118	118	public class LEWOWebServicesWSDLLocationHandler extends org.apache.axis.handlers.BasicHandler
119	119	{
...	...	@@ -120,87 +120,91 @@
120	120
121	121	// --------------------------------------------------------------
122	122
123		- public LEWOWebServicesWSDLLocationHandler() { super(); }
	131	+ public LEWOWebServicesWSDLLocationHandler() { super(); }
124	124
125	125	// --------------------------------------------------------------
126	126
127	127	/**
	136	+{panel}
128	128	* <P>This is the AXIS hook where we can manipulate the outbound
129	129	* WSDL.</P>
130	130	*/
	140	+{panel}
131	131
132		- public void generateWSDL(MessageContext msgContext) throws AxisFault
133		- {
134		- WOContext context = WOWebServiceUtilities.currentWOContext();
135		- WORequest request = context.request();
136		- String host = LEWOHelper.getExternalHostnameFromInboundRequest(request);
137		- int port = LEWOHelper.getExternalPortFromInboundRequest(request);
138		- int appi = request.applicationNumber();
139		-
140		- if((null==host)||(0==host.length()))
141		- throw new IllegalStateException("the host cannot be determined from the inbound request.");
142		-
143		- if(context.hasSession())
144		- context.session();
145		-
146		- StringBuffer sb = new StringBuffer();
147		-
148		- sb.append("http://");
149		- sb.append(host);
150		-
151		- if(-1!=port)
152		- {
153		- sb.append(":");
154		- sb.append(Integer.toString(port));
155		- }
156		-
157		- String path = context.urlWithRequestHandlerKey(
158		- request.requestHandlerKey(),
159		- request.requestHandlerPath(),
160		- null);
161		-
	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	+
162	162	// Unless the context has a session, we can't get it to come back
163	163	// to a specific instance, but in the case of a 'wotaskd' deploy,
164	164	// there is no way to specify the session for a WSDL request, so
165	165	// 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+"'");
166	166
167		- if((-1!=appi)&&(!context.hasSession()))
168		- {
169		- String webServiceRequestHandlerKey = WOApplication.application().webServiceRequestHandlerKey();
170		- String startPath = request.adaptorPrefix()+"/"+request.applicationName()+".woa"; // ''/cgi-bin/WebObjects/Foo.woa''
	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	+ }
171	171
172		- if(!path.startsWith(startPath))
173		- throw new IllegalStateException("The path '"+path+"' should have started with '"+startPath+"'");
174		-
175		- if(path.startsWith(startPath+"/"+webServiceRequestHandlerKey))
176		- {
177		- StringBuffer pathSB = new StringBuffer();
178		-
179		- pathSB.append(startPath);
180		- pathSB.append("/");
181		- pathSB.append(Integer.toString(appi));
182		- pathSB.append(path.substring(startPath.length()));
183		-
184		- path = pathSB.toString();
185		- }
186		- }
187		-
188		- sb.append(path);
189		-
190		- msgContext.setProperty(MessageContext.WSDLGEN_SERV_LOC_URL,sb.toString());
191		- }
192		-
193	193	// --------------------------------------------------------------
194	194
195	195	/**
	206	+{panel}
196	196	* <P>Basically there is nothing to do here because we are not
197	197	* interested in messing with the request/response cycle - rather
198	198	* we want only to manipulate the WSDL.</P>
199	199	*/
	211	+{panel}
200	200
201		- public void invoke(MessageContext msgContext) throws AxisFault
202		- {
203		- }
	213	+ public void invoke(MessageContext msgContext) throws AxisFault
	214	+ {
	215	+ }
204	204
205	205	// --------------------------------------------------------------
206	206