Author: JirkaH Date: 2010-02-10 09:38:08 +0100 (Wed, 10 Feb 2010) New Revision: 1696 Modified: others/dokumentace/technicalGuide/architecture/7communication.tex Log: communication extended Modified: others/dokumentace/technicalGuide/architecture/7communication.tex =================================================================== --- others/dokumentace/technicalGuide/architecture/7communication.tex 2010-02-10 01:11:23 UTC (rev 1695) +++ others/dokumentace/technicalGuide/architecture/7communication.tex 2010-02-10 08:38:08 UTC (rev 1696) @@ -72,52 +72,81 @@ \subsection{Posílání XML dat přes HTTP} \subsection{VPN} - Serverová část i kiosky jsou propojeny pomocí VPN\footnote{virtual private network (VPN), \url{http://www.vpnc.org/}} - a v rámci této virtuální sítě spolu komunikují pomocí zabezpečeného Blowfish spojení. - Více informací o VPN v řešení ELVYS je možno nalézt v \textit{kapitole \ref{management} (\pageref{management})}. Nastavení - VPN je potom uvedeno v \textit{kapitole \ref{deployment_VPN} (\pageref{deployment_VPN})}. + Serverová část i kiosky jsou propojeny pomocí VPN\footnote{virtual private network (VPN)} + a v rámci této virtuální sítě spolu komunikují pomocí zabezpečeného spojení algoritmem Blowfish. + Více informací o VPN v řešení ELVYS je možno nalézt v \textit{kapitole \ref{security} (\pageref{security})}. Nastavení + VPN je potom uvedeno v \textit{kapitole \ref{deployment_VPN} (\pageref{deployment_VPN})}. \\ + + Všechny metody komunikace s kiosky poslouchají jen na IP adresách z privátní virtuální sítě, takto je tedy zabráněno zneužití přípojných bodů + webové aplikace. \subsection{Komunikační metody} V této části textu je uveden seznam metod, neboli HTTP přístupových bodů, které je možno na straně serveru kontaktovat. Všechny přijímají - pouze HTTP POST požadavky, HTTP GET přístupová metoda pro žádný není naimplemnetována. - - TODO tato sekce - + pouze HTTP POST požadavky, HTTP GET přístupová metoda pro žádný není naimplementována. Každé z metod je vyhrazena svá URL. + \begin{description} - \item[Upload obrázku obrazovky kiosku] TODO \\ - Tato metoda slouží k uplaodu obrázku obrazovky kiosku na server. Obrázek je poslán.... - \begin{description} - \item[parametry] - - \item[useragent] screenshot<elvysID> - \item[odpověď] - + \item[Nahrávání snímku obrazovky kiosku) + Tato metoda slouží k nahrání obrázku obrazovky kiosku na server. Snímek obrazovky je z kiosku pravidelně odesílán z důvodu zpětné vazby s uživatelem. + \begin{description} + \item[useragent] - slouží k identifikaci kiosku. Formát: screenshot<elvysID> + \item[data] - obrázek ve formátu PNG + \item[odpověď] - Kód 200 v případě úspěchu, 500 v případě problému, žádné data se neposílají. \end{description} + + \item[Nahrávání statistik z kiosku) + Tato metoda slouží k nahrání statistik provozu kiosku na server. + + XSD popis posílaných dat je k nalezení v \textit{příloze \ref{appendix_statisticsXML}} + \begin{description} + \item[useragent] - slouží k identifikaci kiosku. Formát: Statistic<elvysID> + \item[data] - XML soubor obsahující informace o událostech na kiosku. + \item[odpověď] - Kód 200 v případě úspěšného nahrání na server, 500 v případě problémů. Žádná data se neodesílají. + \end{description} - \item[Generování appConfig] TODO \\ + \item[Generování appConfig] + AppConfig slouží k nastavení klientské aplikace. Tím, že se část konfigurace posílá ze serveru, je např. možné přemigrovat webServer2 na jiný fyzický server - starý server + začne v nastavení posílat adresu nového serveru místo svojí. + XSD popis generovaných dat je k nalezení v \textit{příloze \ref{appendix_appConfig}} + \begin{description} + \item[useragent] - slouží k identifikaci kiosku. Formát: <elvysID> + \item[data] - žádné + \item[odpověď] - Kód 200 v případě úspěchu, 500 v případě problému, jako data se pošle XML (\verb!text/xml;charset=utf-8!) s appConfig. + \end{description} - - \item[Generování categoryConfig] TODO \\ - Tato metoda slouží k vygenerování categoryConfig konfiguračního souboru pro klienta... - \textbf{Detailní popis vygenerované zprávy:}\\ - categoryConfig obsahuje informace o .. + \item[Generování categoryConfig] + Tato metoda slouží k vygenerování categoryConfig konfiguračního souboru pro klienta. Ten obsahuje výčet všech kategorií spolu s jejich pořadím, + popisem rozložení dokumentů na obrazovce pro každý layout. Soubor neobsahuje informace o naplánovaných dokumentech. XSD popis generovaných dat je k nalezení v \textit{příloze \ref{appendix_categoryConfig}} + \begin{description} + \item[useragent] - slouží k identifikaci kiosku. Formát: <elvysID> + \item[data] - žádné + \item[odpověď] - Kód 200 v případě úspěchu, 500 v případě problému, jako data se pošle XML (\verb!text/xml;charset=utf-8!) obsahující categoryConfig. + \end{description} - - \item[Generování documentConfig] TODO \\ + \item[Generování documentConfig] + Tato metoda slouží k vygenerování documentConfig konfiguračního souboru pro klienta. Ten obsahuje informace o všech panelech a dokumentech, které jsou naplánované + na jednotlivých pozicích panelů. + XSD popis generovaných dat je k nalezení v \textit{příloze \ref{appendix_documentConfig}} + \begin{description} + \item[useragent] - slouží k identifikaci kiosku. Formát: <elvysID> + \item[data] - žádné + \item[odpověď] - Kód 200 v případě úspěchu, 500 v případě problému, jako data se pošle XML (\verb!text/xml;charset=utf-8!) obsahující documentConfig. + \end{description} - \item[Generování filecacheConfig] TODO \\ - XSD popis generovaných dat je k nalezení v \textit{příloze \ref{appendix_filecacheConfig}} - - - \item[Generování layoutConfig] TODO \\ - XSD popis generovaných dat je k nalezení v \textit{příloze \ref{appendix_layoutConfig}} - - - - - + \item[Generování fileCacheConfig] + Tato metoda slouží k vygenerování fileCacheConfig konfiguračního souboru pro klienta. Ten obsahuje seznam všech datových souborů, které mají být zobrazeny v následujících 24 hodinách. To + kioskům umožňuje stažení dokumentů s předstihem. + + XSD popis generovaných dat je k nalezení v \textit{příloze \ref{appendix_filecacheConfig}} + \begin{description} + \item[useragent] - slouží k identifikaci kiosku. Formát: <elvysID> + \item[data] - žádné + \item[odpověď] - Kód 200 v případě úspěchu, 500 v případě problému, jako data se pošle XML (\verb!text/xml;charset=utf-8!) obsahující fileCacheConfig. + \end{description} + \end{description} \section{Rozhraní mezi webovou aplikací a LayoutDesignerem}\label{interface_web_and_LD} @@ -208,4 +237,4 @@ na straně serveru mohla automaticky zpracovávat obslužná aplikace. Tím by se urychlilo a zpříjemnilo nahrávání většího množství dokumentů na server. -Ani tohle zlepšení nebylo plánováno do základní verze řešení ELVYS. \ No newline at end of file +Ani toto zlepšení nebylo plánováno do základní verze řešení ELVYS. \ No newline at end of file