Beehive Sample: Controls Life Cycle and Resource Events
Introduction

This sample demonstrates several Beehive controls framework features:

The custom service provider can be found in the service package of this sample. A custom service provider must implement the java.beans.beancontext.BeanContextServiceProvider provider interface. The service.EventRecorderServiceProvider class is the service provider for this sample and gets added to the ControlContainerContext in the page flow controller's onCreate() method.

The service returned by the EventRecorderServiceProvider is the EventRecorderService. This service provides a mechanism for all controls within the ControlContainerContext to log events with the service. Controls may access the service by using the @Context annotation in their implementation.

. . @Context private EventRecorderService myService; . .

See the controls.OuterControlImpl and controls.InnerControlImpl classes for examples of how to access the EventRecorderService.

This sample uses the EventRecorderService to record controls life cycle and resource events generated by the controls framework. Two scenarios are included:

This is an interactive sample. A page flow is used to allow the user to invoke either of these scenarios in any order and any number of times. After a scenario is invoked the list of events is displayed by the page flow. To reset the state of the page flow and the event list use the Reset link.

Running the Samples on Tomcat 5

The following explains how to run this sample on Tomcat 5. The sample will run on other web containers, but we have chosen Tomcat 5 for convenience.

To Set up the Environment

Before proceeding, complete all of the necessary and optional steps in the following topic: Beehive Installation and Setup

Open a command shell and confirm that you have set following variables:

  • ANT_HOME
  • JAVA_HOME
  • CATALINA_HOME

Also ensure that the following elements are on your PATH:

  • ANT_HOME/bin
  • JAVA_HOME/bin
To Copy the Application to a Project Folder (Optional Step)

To keep your Beehive distribution directory pristine, you should copy the <BeehiveRoot>/samples/control-lifecycle folder to another location before proceeding.

<BeehiveRoot> refers to the top-level directory of your Beehive installation. A typical value for <BeehiveRoot> would be /apache/apache-beehive-1.0.2.

The following instructions assume that you have copied the folder controls-lifecycle into the directory /beehive_projects, resulting in the following directory structure.

/ beehive_projects controls-lifecycle Strictly speaking, you do not need to copy the controls-lifecycle directory to another location. If you wish to leave the controls-lifecycle directory in place, in the instructions below you must replace occurrences of the path element /beehive_projects with this path element: <BeehiveRoot>/samples.

For example, to build the sample, run the following Ant command:

   ant -f <BeehiveRoot>/samples/controls-lifecycle/build.xml clean build war

To delete the sample's build directory, run the clean target:

   ant -f <BeehiveRoot>/samples/controls-lifecycle/src/WEB-INF/build.xml clean
Edit the <code>build.properties</code> File

In this section you will edit the build.properties file--the file that sets the build-related properties for your web application.

Open the file /beehive_projects/netui-samples/WEB-INF/src/build.properties in a text editor.

Edit the file so that the beehive.home property points to the top-level folder of your beehive installation. For example, if your beehive installation resides at /apache/apache-beehive-1.0.2, then your build.properties file would appear as follows.

beehive.home=/apache/apache-beehive-1.0.2 servlet-api.jar=${os.CATALINA_HOME}/common/lib/servlet-api.jar jsp-api.jar=${os.CATALINA_HOME}/common/lib/jsp-api.jar context.path=controls-lifecycle Windows users must use forwardslashes (/) not backslashes (\) in the build.properties file.
To Compile the Controls Life Cycle Sample

To compile the controls-lifecycle sample, enter the following Ant command:

ant -f /beehive_projects/controls-lifecycle/build.xml clean build war Copy and Paste version: ant -f /beehive_projects/controls-lifecycle/build.xml clean build war
To Start Tomcat

To start Tomcat, run the following command:

%CATALINA_HOME%\bin\startup.bat

Or, on non-Windows systems,

$CATALINA_HOME/bin/startup.sh
To Deploy to Tomcat

To deploy the samples, copy the WAR file to Tomcat's webapps directory.

On Windows:

copy C:\beehive_projects\netui-samples.war %CATALINA_HOME%\webapps /Y On Windows, there are file-locking issues that Tomcat versions 5.5.x and above are sensitive to. In particular, any web application that uses Struts will fail to redeploy if you copy in a new .war file as described here. The Commons Digester team is adding a workaround for the issue (see this bug), but in the meantime, you can work around it with the antiResourceLocking option in Tomcat. Just add a file called context.xml in a directory called META-INF inside the web application directory before building (so it will end up as META-INF/context.xml in your controls_tutorial.war):

    <?xml version="1.0" encoding="UTF-8"?>
    <Context antiResourceLocking="true">
    </Context>

Everywhere else:

cp /beehive_projects/controls-lifecycle.war $CATALINA_HOME/webapps
Running

To start the sample visit the following link in a browser:

http://localhost:8080/controls-lifecycle