$Id: $
The realMethods Framework - Professionally Serviced Open Source
===============================================================
The realMethods Framework is a project held at Source Forge. This project
is released under the LGPL, and you should review this license before using
the contents of this project:
http://www.gnu.org/copyleft/lgpl.html
If you wish to build or install the realMethods Framework, or deploy the Proof of Concept
application, download the Quick Start Guide at:
http;//www.realmethods.com/documentation.html
realMethods Framework 2.6 Release
====================================
Major Features Overview
-----------------------
This build contains a redesign to the Framework security service. It includes support for both JAAS and ACL based security, allowing you
to define multiple security managers within a single property file (security.properties). This property file should be located with your other Framework
related property files in order to be discovered and loaded on Framework startup. Importantly, you can remove the 3 security related properties from
your framework.properties file, and place them within a ACL based security manager definition in the security.properties file.
- To leverage JAAS, make sure you are using a mimimum JDK version of 1.4.
- Log4J has been updated from v1.2.4 to v1.2.8.
- A new hook interface has been added allowing you to implement a handler to process upon the creation of a new FrameworkCheckException.
- A new hook class is no longer created for each request made to the FrameworkHookFactory, but instead is cached upon the initial creation. This means
a hook implementation must be developed to be thread-safe sine it will be more than likely used concurrently during application execution.
Release Builds
--------------
Release Builds of realMethods Framework are created and released periodically, and
announced to the interested mailing lists. Within Source Forge, each release is created as
such under the package 'framework': https://sourceforge.net/project/showfiles.php?group_id=84447
Binary: http://prdownloads.sourceforge.net/realmethods/realmethods_Install_2_6.jar?download
Source: http://prdownloads.sourceforge.net/realmethods/realmethods_Framework_Source_2_6.zip?download
Bugs - as published at sourceforge.net
----
820638 empty() fails on a ConnectionPool that is already empty
820639 FrameworkBaseObjectFactory uses an unsynchronized Map
Updates - as published at sourceforge.net
------
820611 Security properties removed from framework.properties
820612 New property file security.properties
820615 UserSession.createSecurityManager deprecated
820616 UserSession.securityManager now IFrameworkSecurityManager
820618 Deprectate JSPSecurityManager, IJSPSecurityManager
820619 New security classes
820620 New method decls on IFrameworkSecurityManager
820622 FrameworkServletSecurityHelper uses the default sec. mgr
820624 Declared abstract FrameworkSecurityManager.applyUserAndRoles
820625 JSPTemplateTag.doStartTag() exception handler
820627 FrameworkHookFrameworkHookFactory caches hook classes
820628 HTTPRequestHandler.processAuthentication() pass through
820629 FrameworkCheckedException uses ICheckedExceptionThrownHook
820630 Added CheckedExceptionThrown to FrameworkEventType
820631 SecurityManagerTestService to framework junit test suite
820632 Upgraded from log4j-1.2.4.jar to log4j-1.2.8.jar
820634 Type specifc static log methods
820635 maxConnectionAttempts added to connectionpool.properties
820637 FrameworkBaseObject.enterErrorLogMsg is deprecated
Binary Content
--------------
The binary content contains the following
\build
Contains 2 subdirectories, each containing a Jakarta ANT build.xml file, to rebuild the framework or rebuild the Proof of Concept.
\db
This directory contains database vendor specific subdirectories, each containing vendor specific SQL script files. Use these files to provide data in order to successfully execute the Proof of Concept application.
db\oracle
db\sqlserver
db\sybase
db\db2
db\mysql
\docs
This directory contains documentation included with the Framework.
\home
This directory is what is referred to as the Framework home. It contains the license and property files necessary to configure and execute an instance of the Framework. Since a single machine can support multiple instances of the Framework, you can have as many different named Framework home directories as you wish, but normally one is all that is necessary.
In order to execute a Framework-based application, during program execution, you must include the following java -D parameter when running your program or application server: -DFRAMEWORK_HOME=%FRAMEWORK_HOME% where %FRAMEWORK_HOME% is an environment variable representing the home directory.
home directory contents:
=========================
framework.properties - Contains the properties required to configure a Framework instance.
connectionpool.properties - Use this file to specify the names and types of resource connections required of your application.
task.properties - Use this file to specify the names of Tasks to be made available to your application via JMS.
log.properties - Use this file to configure the Framework Default Log Handler and to add additional application log handlers.
security.properties - Use this file to define one or more Framework Security Managers.
log4j.xml - This file contains Apache Log4J configuration parameters used for both internal Framework logging, as well as any user defined Framework Log Handler configured to use Log4J.
\javadoc\framework - This directory contains the javadocs for the Framework.
\javadoc\proofofconcept - This directory contains the javadocs for the Framework's Proof of Concept.
\lib - This directory contains the necessary archive files to generate, modify, and deploy Framework-based application, as well as deploy the Proof of Concept. Consult your application server vendor's documentation concerning the deployment of Servlets and EJBs.
frameworkproofofconcept.ear : contents
frameworkproofofconcept.war
frameworkproofofconcept.jar
frameworkproofofconcept.war : contents
JSP, html, XML, tag library, jar files, and image files required to deploy the Proof of Concept
frameworkproofofoncept.jar : contents
Proof of Concept Java .class files
frameworkproofofconcept_was.ear (Websphere Users only) : contents
frameworkproofofconcept.war
frameworkproofofconcept_was.jar - contains Websphere 4.x rmic pre-compiled classes
frameworkproofofconcept_was.jar (Websphere Users only) : contents
Wesphere 4.x rmic pre-compiled EJB related files
realmethodsframework.jar : contents
all realMethods Framework classes.
rmlicense.jar - license validation algorithms required to execute the Framework.
rmthirdparty.jar - contain realMethods provided vendor specific solutions that integrate with or extend Framework capabilities.
3rd party jar files
===================
Servlet servlet.jar - (version 3.2.3)
IBM
MQ mq.jar - (version 5.2)
mqbind.jar - (version 5.2)
JMX
jmxri.jar - (version 1.2)
jmxtools.jar (version 1.2)
Weblogic EJBGEN
ejbgen.jar - (version 2.1.2)
Apache
log4j-1.2.8.jar - (version 1.2.8)
i18n.jar - (version 1.1)
struts.jar - (version 1.0.2)
soap.jar - (version 2.3.1)
xercesImpl.jar - (version 2.2.0)
xml-apis.jar - (version 2.2.0)
xalan.jar - (version 2.4.0)
\model
This directory contains the following files:
poc.mdl - Rational Rose file containing a set of class and sequence diagrams for the Proof of Concept
poc.xml - UML 1.3 compliant XML file representation of the Proof of Concept object model
realmethodsframework.mdl - Rational Rose file containing a set of class and sequence diagrams for the Framework.
\source
This directory contains all the source code to the Proof of Concept. This source code was initially generated using the AIB, and then modified to suite the more specific requirements of the application. Among other files, it contains all Java and JSP files. These files should be used as a matter of reference concerning your application design and implementation when using the Framework.
If you need the source code to the framework itself visit:
http://www.realmethods.com/downloads.html
