ApplicationAssembler


1   /*
2    * Copyright (C) 2003  Christian Cryder [christianc@granitepeaks.com]
3    *
4    * This library is free software; you can redistribute it and/or
5    * modify it under the terms of the GNU Lesser General Public
6    * License as published by the Free Software Foundation; either
7    * version 2.1 of the License, or (at your option) any later version.
8    *
9    * This library is distributed in the hope that it will be useful,
10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12   * Lesser General Public License for more details.
13   *
14   * You should have received a copy of the GNU Lesser General Public
15   * License along with this library; if not, write to the Free Software
16   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17   *
18   * $Id: ApplicationAssembler.java,v 1.7 2004/02/01 05:16:27 christianc Exp $
19   */
20  package org.enhydra.barracuda.core.event;
21  
22  import javax.servlet.*;
23  import javax.servlet.http.*;
24  
25  /**
26   * <p>This interface defines an ApplicationAssembler. This whole concept
27   * is still pretty experimental. Basically, the idea is that whatever 
28   * implements this interface gets passed a reference to the EventGateway,
29   * an XML File name, and a SAX parser class...given this information, the 
30   * implementor is free to assemble an event hierarchy, register listeners, 
31   * etc.
32   *
33   * <p>The only implementation right now is found in org.enhydra.barracuda.
34   * experimental.assembler.DefaultApplicationAssembler (and this should truly 
35   * be viewed as experimental)
36   *
37   * <p>Look at the source in ApplicationGateway to see how the assembler
38   * is invoked when the servlet is intialized.
39   */
40  public interface ApplicationAssembler {
41      
42      /**
43       * Assemble the system, given the root EventGateway and the
44       * XML assembly decriptor name. The default parser will be 
45       * used.
46       *
47       * @param irootGateway the root EventGateway
48       * @param iservletConfig the ServletConfig object
49       * @param iassemblySourceFile the XML assembly descriptor
50       */
51      public void assemble(EventGateway irootGateway, ServletConfig iservletConfig, String   iassemblySourceFile);
52      
53      /**
54       * Assemble the system, given the root EventGateway, an
55       * XML assembly decriptor name, and a specific SAX parser
56       * class.
57       *
58       * @param irootGateway the root EventGateway
59       * @param iservletConfig the ServletConfig object
60       * @param iassemblySourceFile the XML assembly descriptor
61       * @param iparserClass the SAX parser class
62       */
63      public void assemble(EventGateway irootGateway, ServletConfig iservletConfig, String   iassemblySourceFile, String   iparserClass);
64  }
65
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags