home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _615d46d837bbd617d835dec7e675a77e < prev    next >
Text File  |  2000-03-23  |  6KB  |  144 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>PPM::SOAPClient - SOAP client for PPM repository</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> PPM::SOAPClient - SOAP client for PPM repository</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#methods">METHODS</A></LI>
  26.     <LI><A HREF="#author">AUTHOR</A></LI>
  27.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>PPM::SOAPClient - SOAP client for PPM repository</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.   use PPM::SOAPClient;
  47.   ...
  48.   my $client = new PPM::SOAPClient;
  49.   my @results = $client->search( 'sarathy' );</PRE>
  50. <P>
  51. <HR>
  52. <H1><A NAME="description">DESCRIPTION</A></H1>
  53. <P><CODE>PPM::SOAPClient</CODE> implements a SOAP client to be used to access a PPM
  54. repository through a SOAP interface.  All of the functionality for making
  55. and parsing the SOAP request is handled internally; simply access the
  56. provided methods and you'll be returned a data structure containing the
  57. actual response.</P>
  58. <P>
  59. <HR>
  60. <H1><A NAME="methods">METHODS</A></H1>
  61. <DL>
  62. <DT><STRONG><A NAME="item_new">new ($server)</A></STRONG><BR>
  63. <DD>
  64. Instantiates a new SOAP client, specifying the server that will be used for
  65. all later connections. '<CODE>$server</CODE>' should be provided as the URL to the
  66. SOAP server that we're going to connect to and make queries against.
  67. <P>Note, that this method accepts both ``http://'' and ``soap://'' server URLs
  68. exactly the same way (we treat '<CODE>soap://</CODE>' URLs as standard HTTP URLs).</P>
  69. <P></P>
  70. <DT><STRONG><A NAME="item_version">version ()</A></STRONG><BR>
  71. <DD>
  72. Gets the version number of the SOAP server that we're connected to. If
  73. we're unable to contact the server or its offline, this method returns
  74. '<A HREF="../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A>'.
  75. <P></P>
  76. <DT><STRONG><A NAME="item_searchAbstract">searchAbstract ($search)</A></STRONG><BR>
  77. <DD>
  78. Searches within the '<CODE>ABSTRACT</CODE>' field within all of the packages held in
  79. the repository on the server. The value '<CODE>$search</CODE>' may be a regex that
  80. will be used to match against the abstracts. If no value for '<CODE>$search</CODE>'
  81. is provided, the server treats the search to be for '<CODE>.*</CODE>' (everything).
  82. <P></P>
  83. <DT><STRONG><A NAME="item_searchAuthor">searchAuthor ($search)</A></STRONG><BR>
  84. <DD>
  85. Searches within the '<CODE>AUTHOR</CODE>' field within all of the packages held in
  86. the repository on the server. The value '<CODE>$search</CODE>' may be a regex that
  87. will be used to match against the authors. If no value of '<CODE>$search</CODE>' is
  88. provided, the server treats the search to be for '<CODE>.*</CODE>' (everything).
  89. <P></P>
  90. <DT><STRONG><A NAME="item_searchTitle">searchTitle ($search)</A></STRONG><BR>
  91. <DD>
  92. Searches within the '<CODE>title</CODE>' field within all of the packages held in the
  93. repository on the server. The value '<CODE>$search</CODE>' may be a regex that will
  94. be used to match against the titles. If no value of '<CODE>$search</CODE>' is
  95. provided, the server treats the search to be for '<CODE>.*</CODE>' (everything).
  96. <P></P>
  97. <DT><STRONG><A NAME="item_search">search ($search)</A></STRONG><BR>
  98. <DD>
  99. Searches through all of the fields within all of the packages held in the
  100. repository on the server. The value '<CODE>$search</CODE>' may be a regex that will
  101. be used to match against the field values. If no value of '<CODE>$search</CODE>' is
  102. provided, the server treats the search to be for '<CODE>.*</CODE>' (everything).
  103. <P></P>
  104. <DT><STRONG><A NAME="item_packages">packages ()</A></STRONG><BR>
  105. <DD>
  106. Generates a list of all of the packages currently available in the
  107. repository. The value returned to the caller is a list containing the names
  108. of all of the packages in the repository.
  109. <P></P>
  110. <DT><STRONG><A NAME="item_fetch_ppd">fetch_ppd ($pkg)</A></STRONG><BR>
  111. <DD>
  112. Fetches the PPD associated with a given package. The full contents of the
  113. PPD are returned to the caller in XML format as a scalar value.
  114. <P></P>
  115. <DT><STRONG><A NAME="item_fetch_summary">fetch_summary ()</A></STRONG><BR>
  116. <DD>
  117. Fetches the full summary of all of the packages held in the repository. The
  118. full contents of the summary are returned to the caller in XML format as a
  119. scalar value.
  120. <P></P>
  121. <DT><STRONG><A NAME="item__makeSOAPRequest">_makeSOAPRequest ($method, $search)</A></STRONG><BR>
  122. <DD>
  123. <STRONG>INTERNAL METHOD.</STRONG> Makes the SOAP request to the server, doing the bulk of
  124. the actual work for us.
  125. <P></P></DL>
  126. <P>
  127. <HR>
  128. <H1><A NAME="author">AUTHOR</A></H1>
  129. <P>Graham TerMarsch (<A HREF="mailto:gtermars@home.com">gtermars@home.com</A>)</P>
  130. <P>
  131. <HR>
  132. <H1><A NAME="see also">SEE ALSO</A></H1>
  133. <P><A HREF="../../../site/lib/PPM/SOAPServer.html">the PPM::SOAPServer manpage</A>,
  134. <A HREF="../../../site/lib/SOAP.html">the SOAP manpage</A>.</P>
  135. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  136. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  137. <STRONG><P CLASS=block> PPM::SOAPClient - SOAP client for PPM repository</P></STRONG>
  138. </TD></TR>
  139. </TABLE>
  140.  
  141. </BODY>
  142.  
  143. </HTML>
  144.