Skip to content

HTTP messages sent to ORACC server

Raquel Alegre edited this page Jun 8, 2016 · 5 revisions

Nammu communicates with the ORACC server via both HTTP POST and HTTP GET:

  • POST is used when we need to attach an ATF and send a SOAP Envelope (e.g. for requesting a lemmatisation of an ATF file).
  • GET is used to check if the server is done processing the ATF file.

The overall format of an HTTP POST request is:

HTTP POST headers (Host, Content-Length, Content-Type, ...)
--==boundary==
HTTP POST Body with its own headers, including the SOAP Envelope and an id pointing to the part 
of the message that'll contain the payload (the encoded zipped ATF file)
-==boundary==
Encoded zipped ATF file and some headers.
-==bounday==--

Looking at the steps described in the section [SOAP Asynch Communication Steps](SOAP Asynch Communication Steps), these would be the correspondant HTTP messages sent:

  1. HTTP POST containing the encoded ATF file as well as a SOAP Envelope describing what command we want to run and what project if belongs to.
MIME-Version: 1.0
Content-ID: <SOAP-ENV:Envelope>
Content-Transfer-Encoding: binary
Content-Type: application/xop+xml; charset="utf-8"; type="application/soap+xml"

<?xml version="1.0" encoding="UTF-8"?>
           <SOAP-ENV:Envelope
               xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"
               xmlns:SOAP-ENC="http://www.w3.org/2003/05/soap-encoding"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:xop="http://www.w3.org/2004/08/xop/include"
               xmlns:xmime5="http://www.w3.org/2005/05/xmlmime"
               xmlns:osc-data="http://oracc.org/wsdl/ows.xsd"
               xmlns:osc-meth="http://oracc.org/wsdl/ows.wsdl">
               <SOAP-ENV:Body>
                   <osc-meth:Request>
                       <osc-data:keys>
                           <osc-data:key>atf</osc-data:key>
                           <osc-data:key>cams/gkab</osc-data:key>
                           <osc-data:key>00atf/belsunu.atf</osc-data:key>
                       </osc-data:keys>
                       <osc-data:data>
                           <osc-data:item xmime5:contentType="*/*">
                               <xop:Include href="cid:request_zip"/>
                           </osc-data:item>
                       </osc-data:data>
                   </osc-meth:Request>
               </SOAP-ENV:Body>
           </SOAP-ENV:Envelope>
--==========boundary========
Content-Type: */*
MIME-Version: 1.0
Content-ID: <request_zip>
Content-Transfer-Encoding: binary

PxvÇHñI¹Úo00atf/belsunu.atf�T_OãF�f?Å�@�ìæ¥�P� (±ÐqAT�OZÇK¼�³�Ö»Ü!à¡èt_¡R� ¯´�ç6OýðI:»I�ÞÝC-ËÞ�Ù�ýÍÌofù¤T*ã
                                                                                                          ?Àþî¬o®Ais�,�eö3ë«ôé(ÿv0¤Y¤ê´) Ã¡óÁÉU=ÉuÎ@
E£�)ÒÈ¢3&sFHÙº½Ên©ê¼öºpÁ¿ò�ÐÞ{¼þ½Çë�P1                                                                                                               ÞÏböB2¢*!
ÔIy<»ÊÚ�X�Ja�¢5EmeR�Þ>¬º�,AÎÅ e u�[B*xåÅè*¼�¯6J�³ç;�[ýx}í
                                 ��34�Y
                                       gTòLç Tåp�IP,W0Ör�å,'¤ê._9ÍÎ�P)}A�
                                                                         Z
                                                                          aË­���VgrS�®7¹A�¯
ßÚ­>ï�êp¤-Ía´3,Ï�p×'�"S¬>~Ae�ñ0�pÝ]Ø®�v`Û"Û�rÚ=[§»7Ë´;-�ÀîÞäæâ�KGrg¨¯®fH�¸x�ª'Xm�RÔ¬ìú¶F¦rOñ¬Rù÷/CD¬ÐÏFi&áñ��'w�}t7]�~��ï°Äm�1t-�ðÞy�X¾ïM%�»0wæi½áÉÃý�:è2Ù×ò<Üý,�_Ï�Åó���c�.GTidÉÿ³%dñz~hQylo�ßÎÔÃýï4�¨2®»Tæ_8öÒT+ì�]I£)B¾w�¥f>À	\¶zn«w	�mÃýëWÏ¿4²e+;ðÚ^sÙ~/¡Õk
                                                                                                       íùx¬¡`9g�ÅÆÙ
                                                                                                                   �®�÷äk¯0Q Xä7ÄY�Ri�T$¤!Ù´ç�`¶GÈ5JR�§TñLÀ�J�¦,�ëéèy8-~ÂÎ��êÚSßC¡�	�ÀIqmÚò��*µwåwèÝÐp	�·U�¿çK];^ö;¼§9�FwM�¾Mp� Ë5kx¤�UoÕ«¥�~Ã2X©©§kºå-nºY6=S®<�hêþ�áMxn�åð�§)D̲Ö5�Ý×c®�´�x£1J�M@öâ~&·9²=lêAÑ!³ú±ä¢ÏVrH¨�]K*¦�ð4�"ú/�ùN²�É>ÞtÌ�ÎåÌ{Bq�å�È]$Ô¬)¬³�#³-á¿��M´A¾T�ºä_PxvÇHñI¹Úo�00atf/belsunu.atfPK?
--==========boundary========--
           <SOAP-ENV:Envelope
               xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"
               xmlns:SOAP-ENC="http://www.w3.org/2003/05/soap-encoding"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:xop="http://www.w3.org/2004/08/xop/include"
               xmlns:xmime5="http://www.w3.org/2005/05/xmlmime"
               xmlns:osc-data="http://oracc.org/wsdl/ows.xsd"
               xmlns:osc-meth="http://oracc.org/wsdl/ows.wsdl">
               <SOAP-ENV:Body>
                   <osc-meth:Response>
                       <osc-data:keys>
                           <osc-data:key>9eju0U</osc-data:key>
                       </osc-data:keys>

                   </osc-meth:Response>
               </SOAP-ENV:Body>
           </SOAP-ENV:Envelope>

Clone this wiki locally