This section describes all application components, technologies and structure

Transcription

1 RBX Global : Application overview This page last changed on Mar 25, 2009 by jperez. Application overview The EduCloud SIMS is a software application for educational establishments to manage student data. The EduCloud SIMS project is a data warehouse system with a comprehensive service oriented architecture for enterprise integration. The EduCloud system can be used to aggregate the student, teacher, and school data from a variety of input systems into a single data warehousing solution. One benefit in this system is the ability to accelerate the development of learning management systems, learning content management systems, and school portals. However many large educational groups such as states or small countries may elect to use the system as the primary repository of information that can be consumed by other applications such as a variety of LMS, School Portal, and performance reporting systems. This section describes all application components, technologies and structure + Architecture, Application layers, Technology stack + Source control + Project structure + Build process + Application configuration + Application model + Continuous Integration Architecture EduCloud SIMS application is 100% purely Java (1.5) it is built on top of the Spring Framework (2.5.*) integrating technologies like Hibernate, JPA, Cxf, Jsp, Dozer, Jaxb, Velocity, Slf4j. The application is designed as a multi-tier system, it follows the three-tier architecture of J2EE and all his benefits (simplicity, scalable, flexible, robust) Document generated by Confluence on Apr 01, :45 Page 1

2 EduCloud follows RBX Project Architecture Application layers EIS(Enterprise information system) layer This layer contains the application DAOs, it encapsulates the data from different application data sources and passes business entities to the middle tier. The applications uses Hibernate as ORM, Spring framework for datasource configuration, session factory and components declaration(annotations), all DAOs have their own interface and manage only one application entity. Application entities are annotated using JPA and some Hibernate annotations(this is minimal). Sims supports MySql by default. Middle Tier This layer contains all business logic, it services components use the EIS layer components(daos) to retrieve the application data from different data sources. The application uses Spring framework for component declaration and transaction management. All services have their own interfaces, the services shouldn't have any 3rd party technology dependencies other than Spring. Spring Security is used to handle service method invocation permissions(using AOP) Document generated by Confluence on Apr 01, :45 Page 2

3 User interface tier This is the presentation layer, it uses the Middle tier components to retrieve the information that will be displayed to the user. The application is configured to use Spring MVC(annotated) and Jsp and tag libraries. Spring security is used to manage Url and interface components access. Web services tier There is other layer that uses the middle tier components to retrieve the information requested by 3rd party clients, it is also integrated to Spring framework, it uses Apache Cxf and Jaxrs API. Spring security is used to handle the permissions in this tier. Model entities are mapped to value objects annotated with JaxB Technology stack EduCloud Sims is build on top of the following technologies Database: MySQL 5 Document generated by Confluence on Apr 01, :45 Page 3

4 Java Stack: Most supported / Jrockit DAO framework: Hibernate / JPA Software AppServer: Tomcat 5.5 Buildtool: Maven Source Control: SVN: Subversion Development tools: IntelliJ IDEA / Eclipse Web Framework: Spring MVC/jsp Test Framework: Spring Test Framework / Maven Sunfire plugin Issues Tracking: JIRA Security Stack: Spring Security Job Scheduling: Quartz Rest Webservices: Jaxrs (Cxf) Object Mapper: Dozer Logging: Log4j, Slf4j Source control EduCloud uses subversion as source control management tool. Svnmerge tool is used for changes tracking Svn url : Project structure 1. Directory structure EduCloud Sims follows the default maven directory structure(more) Document generated by Confluence on Apr 01, :45 Page 4

5 2. Module structure sims-core, this will have all the application business classes(services, DAOs, support classes) sims-web, this will have all web resources and web classes(css, images, jsp, controllers) sims-webservices, this will have all web services classes and dependencies(jaxrs services, object mappers, value objects and others) sims-webservices-client, this will have the web services clients, this module has a dependency to the web services module 3. Package structure Package naming convention: EduCloud is using the following naming convention com.[client].[app] (ie. com.rbx.sims), we will be grouping classes by functional area or module com.[client].[app].[module] (ie. com.rbx.sims.classroom.*) Application package structure: project should follow this basic structure package description example Entities com.client.app.model This package will contain all application com.rbx.sims.model.classroom com.rbx.sims.model.customer Document generated by Confluence on Apr 01, :45 Page 5

6 entities Support com.client.app.support It will contains support classes that are reused in all the application, the interface(if necessary) and implementation will be placed here com.rbx.sims.support.messagingdaos DAOs API DAOs Impl Services API Services Impl com.client.app.module.daoit will contains all DAOs interfaces for the specific module/functionality com.client.app.module.dao.[technology] It will contains all the DAOs implementations for the specific module. The implementation classes will be group by technology com.client.app.module.service It will contains all Service interfaces for the specific module com.client.app.module.service.impl It will contains all Service implementations for the specific module com.rbx.sims.classroom.dao.classroom com.rbx.sims.security.dao.sessiondao com.rbx.sims.classroom.dao.hibernate com.rbx.sims.classroom.dao.jcr.jcrcla com.rbx.sims.classroom.service.servic com.rbx.sims.classroom.service.servic Web package structure: the application web module will looks like this package description example Controllers, Command, Validators, etc com.client.app.module It will contains all controllers/actions for the specific module com.rbx.sims.classroom.classroomcon Build process EduCloud uses maven 2 as build tool. The application has 4 modules configured with their corresponding pom files. Please refer to the development documentation to learn about how to build and install the application Application model TODO Continuous Integration Document generated by Confluence on Apr 01, :45 Page 6

7 Right now we are analyzing to incorporate Hudson as continuous integration server. Document generated by Confluence on Apr 01, :45 Page 7