src/wsdlparser/WsdlInvoker.h

00001 /* 
00002  * wsdlpull - A C++ parser  for WSDL  (Web services description language)
00003  * Copyright (C) 2005-2007 Vivek Krishna
00004  *
00005  * This library is free software; you can redistribute it and/or
00006  * modify it under the terms of the GNU Library General Public
00007  * License as published by the Free Software Foundation; either
00008  * version 2 of the License, or (at your option) any later version.
00009  *
00010  * This library is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013  * Library General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU Library General Public
00016  * License along with this library; if not, write to the Free
00017  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00018  */
00019 
00020 //An api to examine and invoke the web service in a protocol independent fashion
00021 
00022 #ifndef _WSDLINVOKERH
00023 #define _WSDLINVOKERH
00024 
00025 #include "xmlpull/XmlSerializer.h"
00026 #include "wsdlparser/WsdlParser.h"
00027 #include "wsdlparser/Soap.h"
00028 #include "xmlpull/wsdlpull_export.h"
00029 
00030 
00031 namespace WsdlPull{
00032 
00033  struct Parameter
00034  {
00035    Parameter(Schema::Type ,std::string,int m,int x,const SchemaParser* s,
00036              const std::vector<std::string>& parents);
00037    Schema::Type type_;
00038    std::string tag_;
00039    unsigned int min_;
00040    unsigned int max_;
00041    int n_;
00042    std::vector<std::string> data_;
00043    //bool str_;
00044    const SchemaParser* sParser_;
00045    std::vector<std::string> parents_;
00046 
00047  };
00048 
00049 class WSDLPULL_EXPORT WsdlInvoker
00050 {
00051  public:
00052   /** @name Constructors and Destructors */
00053   //@{
00054   /**
00055    * The default constructor for WsdlInvoker
00056    * @param wsdl url
00057    * @param stream for logging errors
00058    */
00059   WsdlInvoker(const std::string &url);
00060   WsdlInvoker(const std::string &url, const std::string &schemaPath);
00061   WsdlInvoker();
00062   ~WsdlInvoker();
00063   //@}
00064 
00065   /** @name WSDL Inspection*/
00066   //@{
00067   bool setWSDLUri(const std::string &url);
00068   /** getOperations
00069    *  @param reference to vector<string>
00070    *  @brief return names of operations (only for the SOAP binding portType)
00071    *  @return int ,number of operations
00072    */
00073 
00074   // allready parsed wsdl
00075   bool init(WsdlParser* parser);
00076 
00077   int getOperations(std::vector<std::string> & operations);
00078   std::string getOpDocumentation(const std::string & n);
00079   std::string getDocumentation();
00080   /** setOperation
00081    *  @param operation name to invoke
00082    *  @brief set the operation to invoke
00083    *  @return bool ,true if successful
00084    */
00085   bool setOperation(const std::string & operation,
00086                     WsdlPull::MessageType mType = WsdlPull::Input);
00087   /** getServiceEndPoint
00088    *  returns the url to be invoked for the operation
00089    */
00090   std::string getServiceEndPoint(const std::string & opname) ;
00091   //@}
00092 
00093 
00094   /** @name Simple Invocation usage*/
00095   //@{ 
00096   
00097   /** setValue
00098    *  @brief sets the param value for an operation by name of the parameter
00099    *  @param name of the operation's parameter
00100    *  @param string/void*  representation of the parameter
00101    *  @return true if successful,false if the values didnt match or occurrence constraint failed
00102    *  example invoker.setInputValue("symbol","ABC") or 
00103    *  int zip = 94018; invoker.setInputValue("zip",(void*)(&zip));
00104    *  Note that "symbol" or "zip" above can be a message part or a constituent particle in a complex type
00105    *  The API takes care of it.
00106    */
00107   bool setValue(const std::string & param,void* val);
00108   bool setValue(const std::string & param,void** values,unsigned int occur);
00109   bool setValue(const std::string & param,std::string val);
00110   bool setValue(const std::string & param,std::vector<std::string> values);//multiple occurrences
00111   bool setValue(const std::vector<std::string> & parents,void* val);
00112   /** invoke
00113    *  invoke the web service operation
00114    @param timeout set the timeout for the request in seconds
00115    *  @return true if successful,false otherwise
00116    */
00117   bool invoke(long timeout = 0);
00118   /** getValue
00119    *  return the value of the output whose name is 'param'
00120    *  @param type is set by reference to enable type casting in client code
00121    *  @return pointer to the value .0 if there is no simple type or part name 
00122    *  whose name is 'param' in  the web service output.
00123    *  example  float * val = (int*) invoker.getOutput("Result",t);//stock quotes
00124    *  t would be Schema::FLOAT
00125    */
00126   void* getValue(const std::string & param,Schema::Type & t); 
00127   
00128   //@} 
00129   
00130   /** @name A more complex but  powerful usage*/
00131   //@{ 
00132   
00133   /** getNextInput
00134    *  Calling this method repeatedly informs the caller
00135    *   of the input types the web service operation expects.
00136    *   Each call returns a unique id which must be used while setting the
00137    *   value using setInputValue.This method exposes only atomic types.Even if 
00138    *   a web service needs a complex type,the api exposes only the constituent
00139    *   particles.The only exception is when a complex content model needs multiple
00140    *   occurrences which is still a TODO
00141    *  @param ref:param name  Name of the param
00142    *  @param ref:Schema::Type ,the schema type 
00143    *  @param ref: minimum and maximum (occurrences)
00144    *  @param ref:parents, parent list of type hierarchy for this parameter.
00145    *  @return unique id of this parameter
00146    */
00147   int getNextInput(std::string & param ,Schema::Type & type,int & minimum,int & maximum);
00148   int getNextInput(std::string & param ,Schema::Type & type,int & minimum,int & maximum,
00149                    std::vector<std::string>& parents);
00150   /**
00151    * getNextHeaderInput
00152    * Similar to the previous method except that it gets the SOAP headers if any
00153    * Set methods are same as for regular inputs
00154    */
00155   int getNextHeaderInput(std::string & param ,Schema::Type & type,int & minimum,int & maximum);
00156   int getNextHeaderInput(std::string & param ,Schema::Type & type,int & minimum,int & maximum,
00157                          std::vector<std::string>& parents);
00158   /**
00159    * returns the number of input headers you may need to set
00160    */
00161   int nInputHeaders()const;
00162   
00163   /** setInputValue
00164    *  sets the param value for an operation
00165    *         only simple types can be set.
00166    *  @param id return by getNextInput()
00167    *  @param void ** pointer to array of pointers to the the values
00168    *  @return true if successful,false if the values didnt match or occurrence constraint failed
00169    */
00170   bool setInputValue(const int param,void* val);
00171   bool setInputValue(const int id,void** values,unsigned int occur);
00172 
00173   /** setInputValue
00174    *  sets the param value for an operation
00175    *         only simple types can be set.
00176    *  @param id return by getNextInput()
00177    *  @param string representation of the parameter
00178    *  @return true if successful,false if the values didnt match or occurrence constraint failed
00179    */
00180   bool setInputValue(const int param,std::string val);
00181   bool setInputValue(const int param,std::vector<std::string> values);//multiple occurrences
00182 
00183   /** getNextOutput
00184    *  get the part/elem name and type container
00185    * @return false when we finished iterating through all outputs
00186    *         after which it rewinds and you can start again
00187    */
00188   bool getNextOutput(std::string  & name,TypeContainer * & tc);
00189   
00190   /** getOutput
00191    *   return the type container which stores the output
00192    *   for the output part/elem name
00193    */
00194   TypeContainer* getOutput(const std::string  & name);
00195   
00196   /** getNextHeaderOutput
00197    *  get the type container which stores the SOAP header
00198    * @return false when we finished iterating through all outputs
00199    *         after which it rewinds and you can start again
00200    */
00201    bool getNextHeaderOutput(std::string & name,TypeContainer*& tc);
00202 
00203   //@} 
00204    // change location of the service
00205   void setLocation(const std::string  & url);
00206   // set credentials for the service
00207   void setCredentials(const std::string & user, const std::string & pass);
00208   //ouput the soap message without invoking the service
00209   std::string getSoapMessage();
00210 
00211   void setProxy(const std::string & host,int  port=80);
00212   //enable logging
00213   void setVerbose(bool f);
00214   // prints the output along with typenames like
00215   // name:value.
00216   //if false only value is printed
00217   void printTypeNames(bool f);
00218   //get the error message
00219   std::string errors();
00220   //if this returns false something went wrong
00221   bool status()const;
00222 
00223 
00224  private:
00225   //private stuff 
00226 
00227   //creaate xml request
00228   void serialize();
00229   void serializeType(Schema::Type typeId,
00230                      const std::string &tag,
00231                      const SchemaParser * sParser,
00232                      int minimum,
00233                      int maximum,
00234                      std::vector<std::string> parents,
00235                      const std::string nsp="",
00236                      bool isRoot = false);
00237 
00238   void serializeParam(int n,const std::string & tag,
00239                       const SchemaParser * sParser,
00240                       const std::string nsp="",
00241                       bool isRoot = false);
00242   void serializeContentModel(ContentModel *cm,
00243                              const SchemaParser *sParser,
00244                              std::vector<std::string> parents);
00245   /** create xml request 
00246     and do the http post request via curl
00247     @param timeout in seconds default 0 -> no timeout
00248     **/
00249   void post(long timeout=0, std::string username="", std::string passwd="");
00250   void processResults();
00251   void processFault(XmlPullParser* xpp);
00252   void processHeader(XmlPullParser *xpp);
00253   void processBody(const Message* m,XmlPullParser* xpp);
00254   void parseWsdl(const std::string & url, const std::string & schemaPath = "");
00255   void serializeHeader();
00256   bool isSoapArray (const ComplexType * ct,const SchemaParser * sParser);
00257   //reset state information
00258   void reset();
00259   void getOperationDetails(const Operation* op);
00260   std::string getPrefix(const std::string& nsp);
00261 
00262   WsdlParser * wParser_;
00263   WsdlParser * ourParser_;
00264   XmlSerializer * xmlStream_;
00265   Soap* soap_;
00266   bool soapheaders_;
00267   int hPartId_;
00268   std::string hnsp_;
00269   std::ostringstream * soapstr_;
00270   std::ostringstream logger_;
00271   bool status_;
00272   bool serializeMode_;
00273   bool verbose_;
00274   bool dontPost_;
00275   int oHeaders_;
00276   std::map<std::string,const Operation*> opMap_;
00277   const Operation* op_;
00278   Soap::Encoding use_;//literal or encoded
00279   std::string encodingStyle_; // this is usually the soap encoding style
00280   Soap::Style style_;//rpc or doc
00281   std::string nsp_; // namespace for the operation
00282   std::string location_;
00283   std::string username_,password_,host_;
00284   int port_;
00285   std::string action_;//SOAPAction header
00286   std::vector<Parameter> elems_;//the simple types
00287   size_t n_;//a counter to iterate through the element params
00288   int iHeaders_; //number of soap header inputs
00289   std::vector<std::pair<std::string,TypeContainer*> > outputs_;
00290   WsdlPull::MessageType messageType_;
00291 
00292   std::vector<std::string> prefixes_;
00293 
00294 };
00295 
00296 inline
00297 Parameter::Parameter(Schema::Type t,std::string n,int m,int x,const SchemaParser* s,
00298                      const std::vector<std::string>& parents)
00299   :type_(t),
00300      tag_(n),
00301      min_(m),
00302      max_(x),
00303      n_(0),
00304      sParser_(s),
00305      parents_(parents)
00306      
00307 {
00308 }
00309 
00310 inline
00311 std::string 
00312 WsdlInvoker::errors()
00313 {
00314   return logger_.str();
00315 }
00316 
00317 inline
00318 bool
00319 WsdlInvoker::setWSDLUri(const std::string &url)
00320 {
00321   parseWsdl(url);
00322   return status_;
00323 }
00324 
00325 inline
00326 bool
00327 WsdlInvoker::status()const
00328 {
00329   return status_;
00330 }
00331 
00332 inline 
00333 void
00334 WsdlInvoker::setLocation(const std::string  & url)
00335 {
00336   location_ = url;
00337 }
00338 
00339 inline
00340 void
00341 WsdlInvoker::setVerbose(bool f)
00342 {
00343   verbose_ = f;
00344 }
00345 
00346 inline
00347 int
00348 WsdlInvoker::nInputHeaders()const
00349 {
00350   return iHeaders_;
00351 }
00352 
00353 
00354 }
00355 #endif

Generated on Sat May 3 16:29:00 2008 for wsdlpull by  doxygen 1.4.6