Changes for page Web Services-Web Service Provider
Last modified by Pascal Robert on 2007/09/03 19:49
From version 3.1
edited by Pascal Robert
on 2007/09/03 19:49
on 2007/09/03 19:49
Change comment:
There is no comment for this version
To version 2.1
edited by smmccraw
on 2007/07/08 09:46
on 2007/07/08 09:46
Change comment:
There is no comment for this version
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -Web Services-Web Service Provider 1 +Programming__WebObjects-Web Services-Web Service Provider - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. probert1 +XWiki.smmccraw - Content
-
... ... @@ -1,6 +1,6 @@ 1 1 WebObjects supports Web Services both as a producer and a consumer, and it actually works quite well once you figure out how to get things properly configured. Hopefully this walkthrough can jumpstart that process for you. 2 2 3 -= Setting up a WO Web Services Project = 3 += Setting up a WO Web Services Project = 4 4 5 5 Here are the basic steps for setting up a Web Services producer with WebObjects and Eclipse/WOLips: 6 6 ... ... @@ -17,32 +17,32 @@ 17 17 1. Create a class to hold your web service methods. The methods do not need to be static and can both take complex types as parameters and return complex types as return values. For now, just return primitive types and/or String. 18 18 1. Edit your Application class and add WOWebServiceRegistrar.registerWebService("PublishedNameOfYourWebService", NameOfTheClassYouJustMade.class, true); 19 19 20 -That's it. Now when you start your app, you can request [[http://yourserver.com/cgi-bin/WebObjects/YourApp.woa/ws/PublishedNameOfYourWebService?wsdl]]and it will return the autogenerated WSDL document that you can use with any number of web service clients to interact with your server.20 +That's it. Now when you start your app, you can request http:~/~/yourserver.com/cgi-bin/WebObjects/YourApp.woa/ws/PublishedNameOfYourWebService?wsdl and it will return the autogenerated WSDL document that you can use with any number of web service clients to interact with your server. 21 21 22 -= Complex Types with WO Web Services = 22 += Complex Types with WO Web Services = 23 23 24 -So now the issue of complex types. Returning complex types is fine, but you have to register the serializer and deserializer classes for each complex type you reference. If you do not, the server will attempt to serialize your object using the ArraySerializer (you'll see this exception on the server), and the client will complain about a nonsensical error with SYSTEMID (gotta love terrible error handling). The fix for this is for each of your complex types, call the following method in your Application constructor: 24 +So now the issue of complex types. Returning complex types is fine, but you have to register the serializer and deserializer classes for each complex type you reference. If you do not, the server will attempt to serialize your object using the ArraySerializer (you'll see this exception on the server), and the client will complain about a nonsensical error with SYSTEMID (gotta love terrible error handling!). The fix for this is for each of your complex types, call the following method in your Application constructor: 25 25 26 26 {{panel}} 27 27 28 -WOWebServiceRegistrar.registerFactoriesForClassWithQName(new BeanSerializerFactory(_class, \_qName), new BeanDeserializerFactory(_class,\_qName),\_class,\_qName);28 + WOWebServiceRegistrar.registerFactoriesForClassWithQName(new BeanSerializerFactory(_class, _qName), new BeanDeserializerFactory(_class, _qName), _class, _qName); 29 29 30 30 {{/panel}} 31 31 32 -where class is the Class object that represents your complex type, and qName is the QName (fully qualified name) of the class as it appears in your WSDL document. For instance, if you created a complex return type named Person and it is in the com.yourserver.service package, class would be com.yourserver.service.Person.class and qName would be new QName("http:~/~/service.yourserver.com", "Person"). Notice that the namespace is the inverse of your package name. You will need to call this method for each of the parameters and return types your reference. 32 +where //class is the Class object that represents your complex type, and //qName is the QName (fully qualified name) of the class as it appears in your WSDL document. For instance, if you created a complex return type named Person and it is in the com.yourserver.service package, //class would be com.yourserver.service.Person.class and //qName would be new QName("http:~/~/service.yourserver.com", "Person"). Notice that the namespace is the inverse of your package name. You will need to call this method for each of the parameters and return types your reference. 33 33 34 -For the record, I have no idea why you have to do this step manually - The WSDL was autogenerated, and thus it KNOWS the classes and their QName WSDL mappings, but I was not able to get things to work properly without this step. If anyone knows why this is, or a way around it, please update this article. 34 +For the record, I have no idea why you have to do this step manually ~-~- The WSDL was autogenerated, and thus it KNOWS the classes and their QName WSDL mappings, but I was not able to get things to work properly without this step. If anyone knows why this is, or a way around it, please update this article. 35 35 36 36 With these registrations, you should now be able to communicate with WO using any standard Web Service client (Axis, .NET, etc). 37 37 38 -= Sessions and WO Web Services = 38 += Sessions and WO Web Services = 39 39 40 40 You may have noticed in your Web Service methods that you have no WOContext, WORequest, WOSession, and friends passed in. Do not fret. The WebServiceRequestHandler takes care to hook you up in this department using Axis's MessageContext class. You can use the following code to get to your WOSession: 41 41 42 42 {{panel}} 43 43 44 -WOContext context = (WOContext)MessageContext.getCurrentContext().getProperty("com.webobjects.appserver.WOContext"); 45 -WOSession session = context.session(); 44 + WOContext context = (WOContext)MessageContext.getCurrentContext().getProperty("com.webobjects.appserver.WOContext"); 45 + WOSession session = context.session(); 46 46 47 47 {{/panel}} 48 48 ... ... @@ -50,7 +50,7 @@ 50 50 51 51 {{panel}} 52 52 53 -WOSession session = WOWebServiceUtilities.currentWOContext().session(); 53 + WOSession session = WOWebServiceUtilities.currentWOContext().session(); 54 54 55 55 {{/panel}} 56 56 ... ... @@ -62,306 +62,319 @@ 62 62 * "Authorization" = contains the Authorization header, in the event that you need to process things like Kerberos/SPNEGO, etc. 63 63 * "remoteaddr" = contains the request's remote address 64 64 65 -= Consuming with Axis in Java = 65 += Consuming with Axis in Java = 66 66 67 -If you are using Axis to consume a WO Web Service, be advised that there is an outstanding bug (open since circa 2003, no less) that axis by default does not support passing more than one cookie to the server. WO sends both woinst AND wosid, so you lose your session ID from the client on the return trip to the server. This can be fixed by applying the patch from [[http://issues.apache.org/jira/browse/AXIS-1059]]to your client's axis.jar. Axis 1.1 has been archived at Apache, but you can download the source from[[http://archive.apache.org/dist/ws/axis/1_1/]]. The patch does not perfectly apply. There are two rejected hunks, but it should be very obvious how to fix the rejects (the patch has two System.out.printlns that it claims were in the original source that were not). After fixing that, you can setStoreSessionIdInCookies(true) on your server's WOSession and setMaintainSessions(true) on your client's ServiceLocator and you'll be good to go.67 +If you are using Axis to consume a WO Web Service, be advised that there is an outstanding bug (open since circa 2003, no less) that axis by default does not support passing more than one cookie to the server. WO sends both woinst AND wosid, so you lose your session ID from the client on the return trip to the server. This can be fixed by applying the patch from http:~/~/issues.apache.org/jira/browse/AXIS-1059 to your client's axis.jar. Axis 1.1 has been archived at Apache, but you can download the source from http:~/~/archive.apache.org/dist/ws/axis/1_1/ . The patch does not perfectly apply. There are two rejected hunks, but it should be very obvious how to fix the rejects (the patch has two System.out.printlns that it claims were in the original source that were not). After fixing that, you can setStoreSessionIdInCookies(true) on your server's WOSession and setMaintainSessions(true) on your client's ServiceLocator and you'll be good to go. 68 68 69 69 This Axis bug appears to be fixed in recent versions of Axis, including version 1.4. Trying to upgrade the version of Axis in your WO Web Services server is not likely to be a happy experience (and likely neither will be upgrading Axis in a Direct To Web Services client - though I haven't tried this). However, it does seem to be possible to use a later version of the Axis jars on the classpath of a WebObjects application that intends to use classes generated by WSDL2Java to connect to a remote Web Services server - assuming that there are no WebObjects classes included in the WSDL. It is important in this case that you use matching version of WSDL2Java. 70 70 71 -= Consuming with WebServicesCore.framework = 71 += Consuming with WebServicesCore.framework = 72 72 73 73 There are several complications when it comes to using WebServicesCore with WebObjects, all of which stem from the WSMakeStubs generated code. Upon using the code generated by WSMakeStubs, you will run into the following issues that need to be fixed in its code: 74 74 75 -= WSMakeStubs = 75 += WSMakeStubs = 76 76 77 77 Apple provides a program called WSMakeStubs that is similar to WSDL2Java in Axis, except that it sucks. It will, however, at least give you a starting point for building your web service client code, and with the changes outlined below, you can end up with decent client APIs. 78 78 79 79 Running WSMakeStubs is very simple: 80 80 81 -/Developer/Tools/WSMakeStubs x ObjC name NameOfServiceClass url [[http://yourserver.com/cgi-bin/WebObjects/YourWOA.woa/ws/YourService?wsdl]]81 +/Developer/Tools/WSMakeStubs --x ObjC --name NameOfServiceClass --url http:~/~/yourserver.com/cgi-bin/WebObjects/YourWOA.woa/ws/YourService?wsdl-- 82 82 83 -This will produce Objective-C code that you can use to call your web service. As opposed to Axis, WSMakeStubs produces stateless code for your service (i.e. no session tracking or cookie support - only static methods for each method of your web service). All of the methods appear at the end of NameOfServiceClass.m that you will need to call. WSMakeStubs also produces WSGeneratedObj.m, which contains the lower level web service core calls. 83 +This will produce Objective-C code that you can use to call your web service. As opposed to Axis, WSMakeStubs produces stateless code for your service (i.e. no session tracking or cookie support ~-~- only static methods for each method of your web service). All of the methods appear at the end of NameOfServiceClass.m that you will need to call. WSMakeStubs also produces WSGeneratedObj.m, which contains the lower level web service core calls. 84 84 85 -= Service Methods Without Return Values = 85 += Service Methods Without Return Values = 86 86 87 -Another bug in WSMakeStubs is related to methods that don't have return values. For void methods, the methods are never actually CALLED by WSMakeStubs. If you look at the code for the returnValue method, you will see that it never calls [[ WO:super getResultDictionary]]. The problem with this is that [[WO:super getResultDictionary]] is the code that actually executes the web service method. Simply change the definition for your void method to be:87 +Another bug in WSMakeStubs is related to methods that don't have return values. For void methods, the methods are never actually CALLED by WSMakeStubs. If you look at the code for the returnValue method, you will see that it never calls [[super getResultDictionary]]. The problem with this is that [[super getResultDictionary]] is the code that actually executes the web service method. Simply change the definition for your void method to be: 88 88 89 -{{ code}}89 +{{panel}} 90 90 91 - - (id) resultValue { 92 - return [self getResultDictionary]; 93 - } 91 + - (id) resultValue { 92 + return [self getResultDictionary]; 93 + } 94 94 95 +{{/panel}} 95 95 96 -{{/code}} 97 - 98 98 And everything will work as planned. 99 99 100 -= Bugs and Changes to WSGeneratedObj = 99 += Bugs and Changes to WSGeneratedObj = 101 101 102 102 WSGeneratedObj is MOSTLY bug free. However, there there are a couple changes required to fix a memory leak it generates (from cocoadev.com): 103 103 104 104 At the end of getResultDictionary, add: 105 105 106 -{{ code}}105 +{{panel}} 107 107 108 - if (fRef) { // new code 109 - WSMethodInvocationSetCallBack(fRef, NULL, NULL); // new code 110 - } // new code 111 - return fResult; // original code 107 + if (fRef) { // new code 108 + WSMethodInvocationSetCallBack(fRef, NULL, NULL); // new code 109 + } // new code 110 + return fResult; // original code 112 112 113 -{{/ code}}112 +{{/panel}} 114 114 114 + 115 115 which now reveals that the NSURL that is used is double-freed, fixable by removing one line from createInvocationRef: 116 116 117 -{{ code}}117 +{{panel}} 118 118 119 - NSURL* url = [NSURL URLWithString :endpoint];120 - if (url == NULL) { 121 - [self handleError :@"NSURL URLWithString failed in createInvocationRef" errorString:NULL errorDomain:kCFStreamErrorDomainMacOSStatus errorNumber:paramErr];122 - } else { 123 - ref = WSMethodInvocationCreate((CFURLRef) url, (CFStringRef)methodName, (CFStringRef) protocol); 124 - // [url release]; remove this line 125 - .... 119 + NSURL* url = [NSURL URLWithString. endpoint]; 120 + if (url == NULL) { 121 + [self handleError. at"NSURL URLWithString failed in createInvocationRef" errorString.NULL errorDomain.kCFStreamErrorDomainMacOSStatus errorNumber.paramErr]; 122 + } else { 123 + ref = WSMethodInvocationCreate((CFURLRef) url, (CFStringRef)methodName, (CFStringRef) protocol); 124 + // [url release]; remove this line 125 + .... 126 126 127 -{{/ code}}127 +{{/panel}} 128 128 129 129 Another change I like to make in the generated is to remove the hard-coded service URLs and pass them in from the code that calls the service (much like Axis does). This should be a fairly straightforward change, but I wanted to make a note about doing it. It will be fairly common that you want to talk to a development server and a production server using the same code, and as a result, you will want that variable to be parameterized. 130 130 131 -= Passing a Complex Type to WO = 131 += Passing a Complex Type to WO = 132 132 133 -WSMakeStubs provides no direct support for passing complex types around - All you get is an NSDictionary, and all you can send back is an NSDictionary, with no instructions as to what exactly is IN these dictionaries. 133 +WSMakeStubs provides no direct support for passing complex types around ~-~- All you get is an NSDictionary, and all you can send back is an NSDictionary, with no instructions as to what exactly is IN these dictionaries. 134 134 135 135 To send a complex type back to WO, you have to set the following keys in your dictionary: 136 136 137 -{{ code}}137 +{{panel}} 138 138 139 - [dictionary setObject :@"http://extranet.mdtask.mdimension.com" forKey:(NSString *)kWSRecordNamespaceURI];140 - [dictionary setObject :@"WSCompany" forKey:(NSString *)kWSRecordType];139 + [dictionary setObject.at"http.--extranet.mdtask.mdimension.com" forKey.(NSString *)kWSRecordNamespaceURI]; 140 + [dictionary setObject.at"WSCompany" forKey.(NSString *)kWSRecordType]; 141 141 142 -{{/ code}}142 +{{/panel}} 143 143 144 144 Where kWSRecordNamespaceURI's value is the XML namespace of the type of the complex object you are passing, and kWSRecordType's value is the name of the type. On the WO side, the namespace will be the reverse of the type's class name, and the record type will be the name of the class. For instance, in the example above, the actual class on the server was named com.mdimension.mdtask.extranet.WSCompany . 145 145 146 146 The rest of the dictionary contains attribute=>value mappings. For instance, WSCompany in the example above has a "name" attribute, so the dictionary would also contains a "name" key that maps to the corresponding value. 147 147 148 -When sending NSDictionary instances from Cocoa, the WO will fire the WOGlobalIDDeserializer and it will not properly parse the nsdictionary or nsarray, it appears that there is no default deserializer on the WO side for those classes. 148 +When sending NSDictionary instances from Cocoa, the WO will fire the WOGlobalIDDeserializer and it will not properly parse the nsdictionary or nsarray, it appears that there is no default deserializer on the WO side for those classes. 149 149 150 150 One solution is to add 151 151 152 -{{ code}}152 +{{panel}} 153 153 154 -@implementation NSObject (NSObject_WOXML) 154 + @implementation NSObject (NSObject_WOXML) 155 155 156 -- (NSString*)xmlPlist { 157 - NSString* error; 158 - NSData* data = [NSPropertyListSerialization dataFromPropertyList:self 159 - format:NSPropertyListXMLFormat_v1_0 160 - errorDescription:&error]; 161 - return [[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding] autorelease]; 162 -} 156 +{{/panel}} 163 163 164 - @end158 + 165 165 166 -{{ /code}}160 +{{panel}} 167 167 168 -on the cocoa side, than call it when compiling the arguments for the WSMethodInvocationRef 169 -Than on the WO side use NSPropertyListSerialization.propertyListFromString(xmlPlist) to recreate the object. 162 + - (NSString*)xmlPlist { 163 + NSString* error; 164 + NSData* data = [NSPropertyListSerialization dataFromPropertyList:self 165 + format:NSPropertyListXMLFormat_v1_0 166 + errorDescription:&error]; 167 + return [((NSString alloc] initWithData:data encoding:NSUTF8StringEncoding] autorelease]; 168 + } 170 170 171 - = Return Values from WO =170 +{{/panel}} 172 172 173 - Oneof the other problems WSMakeStubs has is that it doesn't produce a valid identifier for retrieving a WO web service return value. In the generated code, you will see something like172 + 174 174 175 -{{ code}}174 +{{panel}} 176 176 177 - - (id) resultValue { 178 - return [[super getResultDictionary] objectForKey: @"getBillableCompaniesReturn"]; 179 - } 176 + @end 180 180 178 +{{/panel}} 181 181 182 - {{/code}}180 +on the cocoa side, than call it when compiling the arguments for the WSMethodInvocationRef 183 183 184 -ho wever,theactualreturnvaluenamerequires itsnamspaceto beincluded.Thefixed version oftheroutinelooks like:182 +Than on the WO side use NSPropertyListSerialization.propertyListFromString(xmlPlist) to recreate the object. 185 185 186 - {{code}}184 += Return Values from WO = 187 187 188 - - (id) resultValue { 189 - return [[super getResultDictionary] objectForKey: @"ns1:getBillableCompaniesReturn"]; 190 - } 186 +One of the other problems WSMakeStubs has is that it doesn't produce a valid identifier for retrieving a WO web service return value. In the generated code, you will see something like 191 191 192 -{{ /code}}188 +{{panel}} 193 193 194 -Notice the key starts with "ns1:". This value should match the value that appears in your WSDL. 190 + - (id) resultValue { 191 + return [(super getResultDictionary] objectForKey: @"getBillableCompaniesReturn"]; 192 + } 195 195 196 - = Example Type Wrappers =194 +{{/panel}} 197 197 198 - Here's an example type wrapper I use based on the WSCompanyexample above.Inthestaticmethods thatWSMakeStubs createsthat wrapmy webservicemethods, I simply initWithDictionary thistype with the resultdictionary fromthe webserviceandreturnaninstanceof WSCompany rather than thedictionary.WhenI send oneof theseobjects back, I simply send[[WO:wsCompany dictionary]]in thewrapper method.196 +however, the actual return value name requires its namspace to be included. The fixed version of the routine looks like: 199 199 200 -{{ code}}198 +{{panel}} 201 201 202 - @interfaceWSCompany:NSObject {203 - NSMutableDictionary*myDictionary;204 - } 200 + - (id) resultValue { 201 + return [(super getResultDictionary] objectForKey: @"ns1:getBillableCompaniesReturn"]; 202 + } 205 205 206 - -(id)initWithDictionary:(NSDictionary *)_dictionary; 207 - -(NSDictionary *)dictionary; 208 - -(NSString *)name; 209 - -(NSString *)companyID; 210 - @end 204 +{{/panel}} 211 211 212 - {{/code}}206 +Notice the key starts with "ns1:". This value should match the value that appears in your WSDL. 213 213 214 - {{code}}208 += Example Type Wrappers = 215 215 216 - @implementation WSCompany210 +Here's an example type wrapper I use based on the WSCompany example above. In the static methods that WSMakeStubs creates that wrap my web service methods, I simply initWithDictionary this type with the result dictionary from the web service and return an instance of WSCompany rather than the dictionary. When I send one of these objects back, I simply send [[wsCompany dictionary]] in the wrapper method. 217 217 218 - -(id)initWithDictionary:(NSDictionary *)_dictionary { 219 - self = [super init]; 220 - myDictionary = [[_dictionary mutableCopy] retain]; 221 - [myDictionary setObject:@"http://extranet.mdtask.mdimension.com" forKey:(NSString *)kWSRecordNamespaceURI]; 222 - [myDictionary setObject:@"WSCompany" forKey:(NSString *)kWSRecordType]; 223 - return self; 224 - } 212 +{{panel}} 225 225 226 - -(void)dealloc { 227 - [myDictionary release]; 228 - [super dealloc]; 229 - } 214 + @interface WSCompany : NSObject { 215 + NSMutableDictionary *myDictionary; 216 + } 217 + 218 + -(id)initWithDictionary:(NSDictionary *)_dictionary; 219 + -(NSDictionary *)dictionary; 220 + -(NSString *)name; 221 + -(NSString *)companyID; 222 + @end 230 230 231 - -(NSDictionary *)dictionary { 232 - return myDictionary; 233 - } 224 +{{/panel}} 234 234 235 - -(NSString *)name { 236 - return [myDictionary objectForKey:@"name"]; 237 - } 226 + @implementation WSCompany 238 238 239 - -(NSString *)companyID { 240 - return [myDictionary objectForKey:@"companyID"]; 241 - } 242 - @end 228 +{{panel}} 243 243 244 -{{/code}} 230 + 231 + -(id)initWithDictionary:(NSDictionary *)_dictionary { 232 + self = [super init]; 233 + myDictionary = [(_dictionary mutableCopy] retain]; 234 + [myDictionary setObject.at"http.--extranet.mdtask.mdimension.com" forKey.(NSString *)kWSRecordNamespaceURI]; 235 + [myDictionary setObject.at"WSCompany" forKey.(NSString *)kWSRecordType]; 236 + return self; 237 + } 238 + 239 + -(void)dealloc { 240 + [myDictionary release]; 241 + [super dealloc]; 242 + } 243 + 244 + -(NSDictionary *)dictionary { 245 + return myDictionary; 246 + } 247 + 248 + -(NSString *)name { 249 + return [myDictionary objectForKey.at"name"]; 250 + } 251 + 252 + -(NSString *)companyID { 253 + return [myDictionary objectForKey.at"companyID"]; 254 + } 255 + @end 245 245 246 - = Fault Handling =257 +{{/panel}} 247 247 248 - WSMakeStubsdoesn't handle the faultproperly but it's in the dictionary. InresultForInvocation: I added a fewlinestocheck for and return the fault259 += Fault Handling = 249 249 250 - {{code}}261 +WSMakeStubs doesn't handle the fault properly but it's in the dictionary. In __resultForInvocation: I added a few lines to check for and return the fault__ 251 251 252 - + (id) resultForInvocation:(WSGeneratedObj*)invocation; { 253 - result = [[invocation resultValue] retain]; 254 - // Added check if a fault occured and return the fault string if so 255 - if([invocation isComplete]) { 256 - if([invocation isFault]) { 257 - result = [[invocation getResultDictionary] valueForKey:@"/FaultString"]; 258 - } 259 - } 260 - // 261 - [invocation release]; 262 - return result; 263 - } 263 +{{panel}} 264 264 265 + + (id) resultForInvocation:(WSGeneratedObj*)invocation; { 266 + result = [(invocation resultValue] retain]; 267 + // Added check if a fault occured and return the fault string if so 268 + if([invocation isComplete]) { 269 + if([invocation isFault]) { 270 + result = [(invocation getResultDictionary] valueForKey:@"/FaultString"]; 271 + } 272 + } 273 + // 274 + [invocation release]; 275 + return result; 276 + } 265 265 266 -{{/ code}}278 +{{/panel}} 267 267 268 -= Stateful Services = 280 += Stateful Services = 269 269 270 270 Below is the necessary code to enable cookie support and stateful session with the files generated by WSMakeStubs. This code also includes changes so the base web services URL is supplied in the init method and allows specifying a timeout value (which I defaulted to 30 seconds). To WSGeneratedObj.h, add three new member variables: 271 271 272 -{{ code}}284 +{{panel}} 273 273 274 - @interface WSGeneratedObj : NSObject { 275 - WSMethodInvocationRef fRef; 276 - NSDictionary* fResult; 277 - NSDictionary* fCookies; 278 - NSString fURLString; 279 - int fTimeout; 286 + @interface WSGeneratedObj : NSObject { 287 + WSMethodInvocationRef fRef; 288 + NSDictionary* fResult; 289 + NSDictionary* fCookies; 290 + NSString fURLString; 291 + int fTimeout; 292 + 293 + id fAsyncTarget; 294 + SEL fAsyncSelector; 295 + }; 280 280 281 - id fAsyncTarget; 282 - SEL fAsyncSelector; 283 - }; 297 +{{/panel}} 284 284 285 -{{/code}} 286 - 287 287 Here are the new methods to add to WSGeneratedObject.m: 288 288 289 -{{ code}}301 +{{panel}} 290 290 291 - -- (id) initWithWebServicesURLString:(NSString*)urlString 292 - { 293 - if (self = [super init]) { 294 - fURLString = [urlString copy]; 295 - } 296 - return self; 297 - } 303 + - (id) initWithWebServicesURLString:(NSString*)urlString 304 + { 305 + if (self = [super init]) { 306 + fURLString = [urlString copy]; 307 + } 308 + return self; 309 + } 310 + 311 + - (NSString*) getWebServicesURLString { return fURLString; } 312 + 313 + - (NSURL*) getWebServicesURL { return [NSURL URLWithString. (self getWebServicesURLString]]; } 314 + 315 + - (NSArray*) getReturnedCookies 316 + { 317 + NSDictionary *results = [self getResultDictionary]; 318 + if (nil == results) 319 + return nil; 320 + CFHTTPMessageRef msgRef = (CFHTTPMessageRef)[results objectForKey. (id)kWSHTTPResponseMessage]; 321 + NSDictionary *headers = (NSDictionary*)CFHTTPMessageCopyAllHeaderFields(msgRef); 322 + [headers autorelease]; 323 + //parse the cookies 324 + NSArray *cookies = [NSHTTPCookie cookiesWithResponseHeaderFields. headers forURL. (self getWebServicesURL]]; 325 + return cookies; 326 + } 327 + 328 + - (void) setCookies:(NSArray*)cookies 329 + { 330 + [fCookies release]; 331 + fCookies = [(NSHTTPCookie requestHeaderFieldsWithCookies. cookies] retain]; 332 + WSMethodInvocationSetProperty([self getRef], kWSHTTPExtraHeaders, fCookies); 333 + } 298 298 299 - - (NSString*) getWebServicesURLString{returnfURLString;}335 +{{/panel}} 300 300 301 - -(NSURL*)getWebServicesURL{ return[NSURL URLWithString: [selfgetWebServicesURLString]]; }337 +* (int)timeoutValue { return fTimeout; } 302 302 303 - - (NSArray*) getReturnedCookies 304 - { 305 - NSDictionary *results = [self getResultDictionary]; 306 - if (nil == results) 307 - return nil; 308 - CFHTTPMessageRef msgRef = (CFHTTPMessageRef)[results objectForKey: (id)kWSHTTPResponseMessage]; 309 - NSDictionary *headers = (NSDictionary*)CFHTTPMessageCopyAllHeaderFields(msgRef); 310 - [headers autorelease]; 311 - //parse the cookies 312 - NSArray *cookies = [NSHTTPCookie cookiesWithResponseHeaderFields: headers forURL: [self getWebServicesURL]]; 313 - return cookies; 314 - } 339 +{{panel}} 315 315 316 - - (void) setCookies:(NSArray*)cookies 317 - { 318 - [fCookies release]; 319 - fCookies = [[NSHTTPCookie requestHeaderFieldsWithCookies: cookies] retain]; 320 - WSMethodInvocationSetProperty([self getRef], kWSHTTPExtraHeaders, fCookies); 321 - } 341 + - (void)setTimeout:(int)t 342 + { 343 + if (t >= 0 && t < 600) 344 + fTimeout = 30; 345 + } 322 322 323 -{{/ code}}347 +{{/panel}} 324 324 325 - {{code}}349 +You will need to modify --dealloc to release fCookies and fURLString. Below is my modified version getCreateInvocationRef. It is modified to get the URL using the new accessor methods above, to get the method name from the class name (which makes a lot more sense than hard--coding it to the class name in every subclass), and to set the timeout. After that is a generic resultValues method so that your generated subclasses can have their --resultValues and --getCreateInvocationRef methods removed—the only methods they require are for setting parameters. There is also a commented out line that you can uncomment to have debug information included in the results dictionary. This is very helpful when trying to debug the transfer of complex objects. 326 326 327 - - (int)timeoutValue { return fTimeout; } 328 - - (void)setTimeout:(int)t 329 - { 330 - if (t >= 0 && t < 600) 331 - fTimeout = 30; 332 - } 351 +{{panel}} 333 333 353 + - (WSMethodInvocationRef) genCreateInvocationRef 354 + { 355 + WSMethodInvocationRef invRef = [self createInvocationRef 356 + /*endpoint*/: [self getWebServicesURLString] 357 + methodName: NSStringFromClass([self class]) 358 + protocol: (NSString*) kWSSOAP2001Protocol 359 + style: (NSString*) kWSSOAPStyleRPC 360 + soapAction: @"" 361 + methodNamespace: @"http://DefaultNamespace"]; 362 + //set a time-out value 363 + if (fTimeout > 0) { 364 + WSMethodInvocationSetProperty(invRef, kWSMethodInvocationTimeoutValue, (CFTypeRef)[NSNumber numberWithInt. fTimeout]); 365 + // WSMethodInvocationSetProperty(invRef, kWSDebugIncomingBody, (CFTypeRef)kCFBooleanTrue); 366 + } 367 + return invRef; 368 + } 369 + 370 + - (id) resultValue 371 + { 372 + NSString *key = [NSString stringWithFormat%3a at"ns1%3a%atReturn", NSStringFromClass((self class])]; 373 + return [(self getResultDictionary] objectForKey: key]; 374 + } 334 334 335 -{{/ code}}376 +{{/panel}} 336 336 337 -You will need to modify dealloc to release fCookies and fURLString. Below is my modified version getCreateInvocationRef. It is modified to get the URL using the new accessor methods above, to get the method name from the class name (which makes a lot more sense than hard-coding it to the class name in every subclass), and to set the timeout. After that is a generic resultValues method so that your generated subclasses can have their resultValues and getCreateInvocationRef methods removed~-~--the only methods they require are for setting parameters. There is also a commented out line that you can uncomment to have debug information included in the results dictionary. This is very helpful when trying to debug the transfer of complex objects. 338 - 339 -{{code}} 340 - 341 -- (WSMethodInvocationRef) genCreateInvocationRef 342 - { 343 - WSMethodInvocationRef invRef = [self createInvocationRef 344 - /*endpoint*/: [self getWebServicesURLString] 345 - methodName: NSStringFromClass([self class]) 346 - protocol: (NSString*) kWSSOAP2001Protocol 347 - style: (NSString*) kWSSOAPStyleRPC 348 - soapAction: @"" 349 - methodNamespace: @"http://DefaultNamespace"]; 350 - //set a time-out value 351 - if (fTimeout > 0) { 352 - WSMethodInvocationSetProperty(invRef, kWSMethodInvocationTimeoutValue, (CFTypeRef)[NSNumber numberWithInt: fTimeout]); 353 - // WSMethodInvocationSetProperty(invRef, kWSDebugIncomingBody, (CFTypeRef)kCFBooleanTrue); 354 - } 355 - return invRef; 356 - } 357 - 358 - - (id) resultValue 359 - { 360 - NSString *key = [NSString stringWithFormat: @"ns1:%@Return", NSStringFromClass([self class])]; 361 - return [[self getResultDictionary] objectForKey: key]; 362 - } 363 - 364 - 365 -{{/code}} 366 - 367 367 To use stateful services, call getReturnedCookies after the first request and store the cookie dictionary. Then call setCookies: with that dictionary on all of your subsequent web services calls. Depending on the cookies you use, you might want to save a new copy of the cookies dictionary after each request. 379 + 380 +Category:WebObjects