*** This is an initial draft proposal for a subproject request. I am submitting this now to see if there is any interest in this project. ***
------------------------------------------------------------------------ Satyr Project Documentation: http://209.164.108.27/satyr/docs/index.html Version 1.0 ------------------------------------------------------------------------ Introduction ------------- Satyr is an open source framework for developing web-based applications. It is implemented using standards such as servlets, beans and JSP. It also uses Xalan/Xerces for it's XPATH/XML requirements along with Jakarta's Tomcat as the servlet container. Rationale ---------- Code reuse is an important part of any application. What is needed is a web framework that allows developers to build isolated components, and allow them to be easily integrated into applications without the need of source code changes. The Satyr framework is built on this ideal of component. The component engine, Cerberus, is a framework for the building and application of reusable components. The framework allow components to be described through various descriptors. These descriptors define what components are available, what they can do, and how to combine them into a working system. Scope ------ A component is a group of classes that interact to provide a particular service in an application. Components are described independently of each other using definition descriptors. The descriptor defines the interface that other components may use for interaction. Components interact through message passing. Messaging enables loosely coupled communication between components. Neither the sender nor the receiver need to know anything about the other. They need only to know what message format and destination to use. One or more components may be combined into a composite. This allows the encapsulation of components into a more coarse grained component. The attributes of the composite are available to each of the components within the composite. By decomposing a system into components communicating through messages, the system becomes more modular and reusable. Once a component has been developed, that same component can be reused many times in the same application, and can also easily be moved into other web applications without any source changes. Satyr uses an XML DOM to store/receive all web available data (FORM data, view information, etc) By doing this, we allow the JSP pages to do XPATH queries (optional) to extract the data back into the JSP page itself for visual representation. Optionally, you can extract the part of the DOM that you want to use, and translate it using XSL instead of using JSP tags themselves. Current Developers ------------------- Currently Satyr has 3 developers, however we are all from the same location. Knowing that this is normally reflected as a warning sign, I would like to mention that we are fully willing to take on other developers/committers onto this project and intend to conform to the guidelines stated by Jakarta for managing a project. Developers: Scott Milne, Trevor Milne, David Rioux Current State -------------- To this date, Satyr has been used on several internal projects for the company I work for. The company does not pay us to develop this framework. It was done during our spare time with the intention of being an open source project from the beginning. Although Satyr does not currently have a community, we feel that it has great potential for obtaining one in a short period of time due to it's concept of reusable components. Satyr is currently in a stable state. We consider it to be of version 1.0 quality and ready for public release. Further Information ------------------- Anyone that is interested in more details on Satyr can browse our current online documentation http://209.164.108.27/satyr/docs/index.html The above documentation describes the core of Satyr in detail. Conclusion ----------- We strongly feel that this framework would be a successful addition to The Jakarta Project. Any comments/questions are welcome. Thank You Scott Milne -- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
