Author: JirkaH Date: 2010-02-28 21:48:53 +0100 (Sun, 28 Feb 2010) New Revision: 1948 Modified: others/dokumentace/technicalGuide/architecture/0architecture.tex others/dokumentace/technicalGuide/architecture/4webapp.tex others/dokumentace/technicalGuide/architecture/7communication.tex others/dokumentace/technicalGuide/architecture/8deployment.tex others/dokumentace/technicalGuide/architecture/9tools.tex Log: ELVYS --> Elvys Modified: others/dokumentace/technicalGuide/architecture/0architecture.tex =================================================================== --- others/dokumentace/technicalGuide/architecture/0architecture.tex 2010-02-28 20:46:45 UTC (rev 1947) +++ others/dokumentace/technicalGuide/architecture/0architecture.tex 2010-02-28 20:48:53 UTC (rev 1948) @@ -66,7 +66,7 @@ \begin{titlepage} \begin{center} -{\LARGE Elektronický vývěskový systém ELVYS} \\ +{\LARGE Elektronický vývěskový systém Elvys} \\ {\Large Architektura} \\ \vspace{\fill} Modified: others/dokumentace/technicalGuide/architecture/4webapp.tex =================================================================== --- others/dokumentace/technicalGuide/architecture/4webapp.tex 2010-02-28 20:46:45 UTC (rev 1947) +++ others/dokumentace/technicalGuide/architecture/4webapp.tex 2010-02-28 20:48:53 UTC (rev 1948) @@ -1,4 +1,4 @@ -\chapter{Architektura webové strany řešení ELVYS}\label{webapp} +\chapter{Architektura webové strany řešení Elvys}\label{webapp} %asi jeste nejake kecy @@ -9,20 +9,20 @@ %%%%%%%%%%%%%%%%%%%%%%%%%% \section{Architektura webové části} -Webová část řešení sestává ze 2 hlavních projektů, které obsahují, či využívají další části.\textit{Obrázek \ref{webapp_img_components}} ukazuje vztah projektů vyvíjených v rámci řešení ELVYS. +Webová část řešení sestává ze 2 hlavních projektů, které obsahují, či využívají další části.\textit{Obrázek \ref{webapp_img_components}} ukazuje vztah projektů vyvíjených v rámci řešení Elvys. \begin{figure} \label{webapp_img_components} \begin{center} \includegraphics[width=0.95\textwidth]{imgs/component_model.png} \end{center} - \caption{Schéma projektů řešení ELVYS} + \caption{Schéma projektů řešení Elvys} \end{figure} \subsection{Projekt webServer2}\label{webapp_architecture_webServer2} WebServer2 je stěžejní částí webové strany řešení. Je to webová aplikace umožňující uživatelům provádět veškeré činnosti spojené s agendou plánování dokumentů, - správy společností, uživatelů, zobrazování reportů a všech dalších věcí, které by měl systém ELVYS umět podle \textit{dokumentu analýzy}. \\ + správy společností, uživatelů, zobrazování reportů a všech dalších věcí, které by měl systém Elvys umět podle \textit{dokumentu analýzy}. \\ Ke své práci využívá i \subsubsection{rychlost} @@ -43,7 +43,7 @@ Při změně XSD souboru je nutné znovu vygenerovat třídy pomocí ANT skriptu [DOPLNIT] \subsubsection{Technologie Java Servlet} - K vytváření bodů vzdáleně přístupných přes HTTP protokol je v systému ELVYS použita technologie Java Servlet. Tato technologie + K vytváření bodů vzdáleně přístupných přes HTTP protokol je v systému Elvys použita technologie Java Servlet. Tato technologie umožňuje namapování java třídy implementující určité rozhraní na nějaké URL. Java třída poté na daném URL poslouchá a zpracovává HTTP požadavky.\\ Pomocí této technologie jsou vytvořeny všechny přístupové body do aplikace \textbf{dispatcher}. @@ -65,14 +65,14 @@ \section{Databázový model a databáze} \subsection{Databáze} - Při diskuzi, který databázový stroj pro serverovou část řešení ELVYS zvolit, rozhodovali se autoři mezi následujícími: + Při diskuzi, který databázový stroj pro serverovou část řešení Elvys zvolit, rozhodovali se autoři mezi následujícími: \begin{itemize} \item textbf{Oracle Database 10g či 11g} \footnote{Oracle Database 11g, } TODO \item textbf{Microsoft SQL Server 2008}\footnote{Microsoft SQL Server 2008, \url{http://www.microsoft.com/sqlserver/2008/}} TODO \item textbf{PostgreSQL}\footnote{PostgreSQL, \url{http://www.postgresql.org/}} TODO \item textbf{MySQL 5.1, community edition}\footnote{MySQL, \url{http://dev.mysql.com/doc/refman/5.1/en/}} TODO \end{itemize} - Jako databázový stroj byl pro serverovou část řešení ELVYS zvolen MySQL server a to z důvodu, že s ním mají autoři bohaté + Jako databázový stroj byl pro serverovou část řešení Elvys zvolen MySQL server a to z důvodu, že s ním mají autoři bohaté zkušenosti, je relativně výkonná a spolehlivá. Pro vývoj je tato databáze plně postačující a díky použití Hibernate ORM nástroje (viz. dále) je možné s relativně malým úsilím přejít na jinou databázovou technologii v případě potřeby. @@ -135,7 +135,7 @@ %% libraries %%%%%%%%%%%%%%%%%%%%%%%%%% \section{Použité JAR knihovny} -Tato sekce obsahuje seznam knihoven (JAR souborů), které jsou použity pro vytvoření řešení ELVYS.\\ +Tato sekce obsahuje seznam knihoven (JAR souborů), které jsou použity pro vytvoření řešení Elvys.\\ \subsection{JAR knihovny sdílené knihovny elvysCommons } projekt elvysCommons používá pouze knihovny pro \subsection{JAR knihovny aplikace webServer2} Modified: others/dokumentace/technicalGuide/architecture/7communication.tex =================================================================== --- others/dokumentace/technicalGuide/architecture/7communication.tex 2010-02-28 20:46:45 UTC (rev 1947) +++ others/dokumentace/technicalGuide/architecture/7communication.tex 2010-02-28 20:48:53 UTC (rev 1948) @@ -1,5 +1,5 @@ \chapter{Popis rozhraní\label{communication}} -Tato kapitola obsahuje popis všech rozhraní nacházejících se v systému ELVYS. +Tato kapitola obsahuje popis všech rozhraní nacházejících se v systému Elvys. Každé z následujících rozhraní bude popsáno ve vlastní sekci v rámci této kapitoly. \begin{description} \item[Kapitola \ref{interface_web_and_kiosk} Rozhraní mezi webovou aplikací a kiosky (str. \pageref{interface_web_and_kiosk})] @@ -23,7 +23,7 @@ Podpora transakčního zpracování komunikace není potřebná. \item \textbf{Server Java, klient c++} Vzhledem k tomu, že server je napsán v jiném programovacím jazyce, než klient a tyto komunikační uzly můžou být provozovány na různých systémech, musí být komunikace nezávislá na jazyce i na platformě. - \item \textbf{Skryté rozhraní komunikace} Navrhované komunikační rozhraní bude skryté uvnitř systému ELVYS- nebude tedy + \item \textbf{Skryté rozhraní komunikace} Navrhované komunikační rozhraní bude skryté uvnitř systému Elvys- nebude tedy přístupné pro uživatele systému. Není tedy ani nutné toto rozhraní standardizovat. \item \textbf{Snadná, rozšiřitelná implementace} V neposlední řadě musí být komunikace rychle naimplementována a rozšíření komunikačního rozhraní nesmí být příliš pracné. @@ -35,7 +35,7 @@ výhod. Jeho způsob komunikace (vzdálené volání procedur) ovšem není vzhledem k požadavkům uvedeným výše příliš vhodný a jeho použití pro tak jednoduchou komunikaci je příliš složité a robustní. \item \textbf{Message-oriented middleware} \\ - Použití middlewaru pracujícího na principu přenosu zpráv (např. ActiveMQ\footnote{ActiveMQ, \url{http://activemq.apache.org/}}) by bylo pro systém ELVYS vhodnější, + Použití middlewaru pracujícího na principu přenosu zpráv (např. ActiveMQ\footnote{ActiveMQ, \url{http://activemq.apache.org/}}) by bylo pro systém Elvys vhodnější, bohužel složitost realizace takového řešení by byla příliš velká. \item \textbf{Proprietární řešení pomocí TCP/UDP}\\ Implementace vlastního komunikačního protokolu postaveného na TCP/UDP zcela neodpovídá požadavkům kladeným na @@ -74,7 +74,7 @@ \subsection{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í + 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ů @@ -228,22 +228,22 @@ \section{Rozhraní pro práci s informačními kiosky}\label{interface_kiosk} popsána v \textit{kapitole \ref{client_interface} (str. \pageref{client_interface})} \section{Rozhraní v budoucnosti}\label{interface_kiosk} -Vzhledem k tomu, že aplikační logika serverové části řešení ELVYS je znovupoužitelná +Vzhledem k tomu, že aplikační logika serverové části řešení Elvys je znovupoužitelná (obsažena v projektu \textbf{elvysCommons}, který je vložen do projektů \textbf{dispatcher} a \textbf{webServer2}), je na snadě Více informací o projektu \textbf{elvysCommons} je možno získat v \textit{kapitole \ref{webapp_architecture_elvysCommons} (str. \pageref{webapp_architecture_elvysCommons})} \subsection{WS-API} Možnost do budoucnosti, která se přímo nabízí je vytvoření aplikačního rozhraní pro přístup k částem aplikace pomocí -Web Services (zkráceně WS-API). Toto API by mohlo být použito pro spolupráci systému ELVYS s jinými systémy. +Web Services (zkráceně WS-API). Toto API by mohlo být použito pro spolupráci systému Elvys s jinými systémy. Takovýmito systémy by mohly být například internetové stránky městských úřadů obsahující zveřejněné dokumenty. Takováto spolupráce by mohla jistě umožnit i jednoduché automatické plánování dokumentů. -Realizace tohoto rozhraní by byla jistě časově náročnou operací a nebyla zamýšlena jako součást základní implementace řešení ELVYS. +Realizace tohoto rozhraní by byla jistě časově náročnou operací a nebyla zamýšlena jako součást základní implementace řešení Elvys. \subsection{FTP nahrávání dokumentů} \label{communication_future_FTP} Další možností, kde lze využít znovupoužitelnou aplikační logiku je nahrávání dokumentů pomocí FTP serveru. Tyto soubory by 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 toto 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 Modified: others/dokumentace/technicalGuide/architecture/8deployment.tex =================================================================== --- others/dokumentace/technicalGuide/architecture/8deployment.tex 2010-02-28 20:46:45 UTC (rev 1947) +++ others/dokumentace/technicalGuide/architecture/8deployment.tex 2010-02-28 20:48:53 UTC (rev 1948) @@ -10,7 +10,7 @@ \begin{center} \includegraphics[width=0.95\textwidth]{imgs/Deployment.png} \end{center} - \caption{Schéma nasazení řešení ELVYS} + \caption{Schéma nasazení řešení Elvys} \label{img.deployment_img_big} \end{figure} @@ -28,7 +28,7 @@ \end{itemize} \subsection{Vývojové/integrační/produkční prostředí}\label{deployment_environments} - Systém ELVYS byl v průběhu vývoje provozován na více typech prostředí. \\ + Systém Elvys byl v průběhu vývoje provozován na více typech prostředí. \\ TODO napsat o continuous integration, produkční prostředí pro kiosek u zákazníka,.. \subsubsection{Vývojové prostředí} \subsubsection{Integrační prostředí} Modified: others/dokumentace/technicalGuide/architecture/9tools.tex =================================================================== --- others/dokumentace/technicalGuide/architecture/9tools.tex 2010-02-28 20:46:45 UTC (rev 1947) +++ others/dokumentace/technicalGuide/architecture/9tools.tex 2010-02-28 20:48:53 UTC (rev 1948) @@ -1,5 +1,5 @@ \chapter{Nástroje použité při vývoji} -V této sekci je uveden seznam nástrojů použitých při práci na projektu ELVYS. +V této sekci je uveden seznam nástrojů použitých při práci na projektu Elvys. % svn, trac, hudson....