DAS Company web application Sample

This stand-alone sample demonstrates the SDO RDB Data Access Service in the context of a simple web application

The application starts with a database of Companies and their related Departments.Through the web page interface, a user can:

1. Display all Companies in the database
2. Display all Companies and related Departments
3. Add a new Department to a Company
4. Delete all Departments from a Company
5. Change the names of Departments in a Company

This simple application covers all CRUD operations as well as some relationship manipulation (adding a Department associates that Department with the Company).The sample runs on Tomcat 6.0 and employs a Derby database (default) accessed via a DataSource.

Running the sample

There are two options for running this sample:

1. Run from Tomcat configured by the build
2. Deploying the Company-webapp WAR into a Tomcat you configure yourself

Running from Tomcat configured by the build

You need to download the Tuscany RDB DAS source distribution and run maven build to use this option. When you build using maven from the source root {SRC_ROOT} directory, the sample war file is created under {SRC_ROOT}/samples/company-webapp/target. This sample application is deployed to an instance of Tomcat as part of our automated sample testing. For this, follow readme.htm instructions from {SRC_ROOT}/samples/testing/tomcat. This will in-effect run the htmlunit tests on the sample. The sample deployed on Tomcat instance will be ready this way and you can just point your browser to http://localhost:8080/sample-company-webapp/ to test further.

Deploying the Company-webapp WAR into a Tomcat you configured yourself

Alternatively, you can deploy the sample to your own configured Tomcat installation by following the instructions below.These instructions assume that you have either 1) downloaded the Tuscany binary distribution or 2) Downloaded the Tuscany source and run maven build.See the following link for more details steps on how to build DAS Sample applications http://incubator.apache.org/tuscany/das-java-developer-guide.html.

• Download and install the most recent stable version of Tomcat 5.5 or Tomcat 6. You can find it here: http://tomcat.apache.org/download-60.cgi
• Download the most recent official release of Derby from here: http://db.apache.org/derby/index.html. The only file you'll need from this download is derby(version).jar
• Stop Tomcat
• Copy derby(version).jar (from the derby distribution) to {Tomcat_Home}/common/lib (for Tomcat 5.5) or to {Tomcat_Home}/lib (for Tomcat 6) - e.g. derby-10.2.2.0.jar.
• Add the sample war file to {Tomcat_Home}/webapps
  • sample-company-webapp.war
• Define a DataSource by adding a datasource definition to {Tomcat_Home}/conf/server.xml.
  • Find the end-of-section marker and add the following lines just above it:

          <!-- Global Datasource for Derby dastest database -->
          <Resource name="jdbc/dastest"
                    type="javax.sql.DataSource" auth="Container"
                    description="Derby database for DAS Company sample"
                    maxActive="100" maxIdle="30" maxWait="10000"
                    username="" password=""
                    driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
                    url="jdbc:derby:{absolute path}Databases/dastest;create=true"/>
          

  Requirement: You must include the absolute path to the Databases directory in the above url attribute.
  Fore example: <url="jdbc:derby:c:\apache-tomcat-6.0.13\Databases/ajaxdastest;create=true"/>
  
  As the new utility, dbConfig is embedded in this sample war, the Derby database "dastest" will get created with required tables and data when the web application gets loaded for the first time in tomcat.
  
  
• Start tomcat and point your browser to: http://localhost:8080/sample-company-webapp/

• Download and install the most recent stable version of Tomcat 5.5 or Tomcat 6. You can find it here: http://tomcat.apache.org/download-60.cgi
• Download the most recent official release of MySQL driver, e.g. mysql-connector-java-5.0.4.jar
• Stop Tomcat
• Copy mysql(version).jar (from the MySQL distribution) to {Tomcat_Home}/common/lib (for Tomcat 5.5) or to {Tomcat_Home}/lib (for Tomcat 6) - e.g. mysql-connector-java-5.0.4.jar.
• Add the sample war file to {Tomcat_Home}/webapps
  • sample-company-webapp.war
• Define a DataSource by adding a datasource definition to {Tomcat_Home}/conf/server.xml.
  • Find the end-of-section marker and add the following lines just above it:

          <!-- Global Datasource for MySQL dastest database -->
          <Resource name="jdbc/dastest"
                    type="javax.sql.DataSource" auth="Container"
                    description="MySQL database for DAS Company sample"
                    maxActive="100" maxIdle="30" maxWait="10000"
                    username="dastest" password="dastest"
                    driverClassName="com.mysql.jdbc.Driver"
                    url="jdbc:mysql://localhost/dastest?createDatabaseIfNotExist=true"/>
          

  Requirement:MySQL service should be up with configured port open for TCPIP communication.
  
  
  As the new utility, dbConfig is embedded in this sample war, the MySQL database "dastest" will get created with required tables and data when the web application gets loaded for the first time in tomcat. Please note that, in the binary distribution, WEB-INF/classes/CompanyWebDBConfig.xml has SQL Table creation syntax for Derby. To make it compatible to MySQL, simply replace GENERATED ALWAYS AS IDENTITY with AUTO_INCREMENT for all table creation statements. (For this unjar the .war, change CompanyWebDBConfig.xml and jar the .war back with changed CompanyWebDBConfig.xml)
  
  
• Start tomcat and point your browser to: http://localhost:8080/sample-advanced-webapp/

Sample Architecture

This is a simple, single-page, web application.The main components of this application are:

• The RDB Data Access Service (DAS)
• SDO
• CompanyClient.java
• Company.jsp

The CompanyClient uses the DAS directly and provides high-level services to the jsp such as:

public final List getCompanies()

This is a good place to look for how you might use the DAS in your own application.

The Company.jsp responds to client interaction by invoking services of the CompanyClient.It receives data from the CompanyClient as SDO data graphs and manipulates SDOs directly to display data.

The DAS accepts directives (commands) from the CompanyClient and reads and writes to the derby database instance appropriately.