Author: dimuthul
Date: Mon Jan 21 01:26:23 2008
New Revision: 12574
Log:
Adding docs to the distribution.
Modified:
trunk/commons/usermanager/build.xml
trunk/commons/usermanager/distribution/README
Modified: trunk/commons/usermanager/build.xml
==============================================================================
--- trunk/commons/usermanager/build.xml (original)
+++ trunk/commons/usermanager/build.xml Mon Jan 21 01:26:23 2008
@@ -1,7 +1,7 @@
<project default="app">
<property name="dir.tmp" value="tmp" />
- <property name="um.version" value="0.1" />
+ <property name="um.version" value="SNAPSHOT" />
<target name="clean">
<delete dir="${dir.tmp}" />
</target>
@@ -9,12 +9,20 @@
<target name="app" depends="clean">
<mkdir dir="${dir.tmp}" />
<mkdir dir="${dir.tmp}/resources"/>
- <copy file="modules/core/target/usermanager-core-${um.version}.jar"
todir="${dir.tmp}"/>
- <copy
file="modules/verification/target/user-verification-${um.version}.war"
todir="${dir.tmp}"/>
+ <mkdir dir="${dir.tmp}/documentation"/>
+ <mkdir dir="${dir.tmp}/lib"/>
+ <copy file="modules/core/target/usermanager-core-${um.version}.jar"
todir="${dir.tmp}/lib"/>
+ <copy
file="modules/configs/target/usermanager-configs-${um.version}.jar"
todir="${dir.tmp}/lib"/>
+ <copy
file="modules/annotation-configs/target/usermanager-config-annotation-${um.version}.jar"
todir="${dir.tmp}/lib"/>
+ <copy
file="modules/verification/target/user-verification-${um.version}.jar"
todir="${dir.tmp}/lib"/>
<copy file="distribution/LICENCE" todir="${dir.tmp}"/>
<copy file="distribution/README" todir="${dir.tmp}"/>
- <copy file="modules/core/src/main/resources/create_db.sql"
todir="${dir.tmp}/resources"/>
- <copy file="modules/core/src/main/resources/user.default.sql"
todir="${dir.tmp}/resources"/>
+ <copy
file="modules/core/src/main/java/org/wso2/usermanager/readwrite/create_db.sql"
todir="${dir.tmp}/resources"/>
+ <copy todir="${dir.tmp}/documentation">
+ <fileset dir="modules/docs">
+ <include name="**"/>
+ </fileset>
+ </copy>
<zip destfile="wso2usermanager-${um.version}.zip" basedir="${dir.tmp}"/>
</target>
Modified: trunk/commons/usermanager/distribution/README
==============================================================================
--- trunk/commons/usermanager/distribution/README (original)
+++ trunk/commons/usermanager/distribution/README Mon Jan 21 01:26:23 2008
@@ -1,74 +1,10 @@
-WSO2 User Manager 0.1
-=====================
+WSO2 User Manager SNAPSHOT
+==========================
-Welcome to the User Manager 0.1 release
-WSO2 UserManager is a library that will let the developers handle user
authentication and authorization in applications in a homogeneous manner.
-Different projects require user management at various levels. User Manager is
designed to cater for needs in different projects.
-
-Features of User Manager 0.1
-============================
-
-* User Management usig "org.wso2.usermanager.readwrite.DefaultRealm".
- 1) Add/edit/delete users
- 2) Add/edit/delete rolels
- 3) Manage users and roles
- 4) Manage user and role authorizations
-
-* Plugin to Existing databases
- 1) org.wso2.usermanager.custom.jdbc.JDBCRealm - This can connect to
existing RDBMS user stores via a JDBC driver and authenticate users. It can
retrieve user properties from the users table. This is tested using MySQL and
Derby database drivers.
- 2) org.wso2.usermanager.custom.ldap.LDAPRealm - This can connect to
existing LDAP server and authenticate users and retrieve user attributes. This
is tested using open ldap.
- 3) org.wso2.usermanager.custom.acegi.AcegiRealm - Can perform
authentication provided the bean mapping for AuthenticationProvider.
-
-* A web app to perform user verification using Emails
- This consist of 3 jsp files and a single class. Extract the webapp and
integrate register.jsp, signon.jsp and validate.jsp to your application. Add
the WEB-INF/lib files and classes directory to your war file or classpath. And
it should simply work.
-
-Limitations
-===========
-
-* The current implementations of the DefaultRealm does not check for user's
roles when giving authorization. For example "isUserAuthorized" will return
true only if User permission is set. This will be fixed in the next release.
-
-* Current Acegi Realm only supports AuthenticationProviders with
"org.acegisecurity.providers.UsernamePasswordAuthenticationToken"
-
-Distribution Directory Structure
-================================
-
- WSO2 UserManager
- |-- usermanager-core-0.1.jar <file>
- |-- user-verification-0.1.war <file>
- |-- resources<folder>
- |-- LICENSE <file>
- |-- README <file>
-
-
-
-Usage
-=====
-
-Using the Default realm
-
-1) create the database by running resources/create_db.sql
-
-2) Add the following jars to your classpath.
- -commons-logging-1.1.jar
- -log4j-1.2.13.jar
- -usermanager-core-0.1.jar
- -your jdbc driver
-
-
-3) Using the default realm with derby EmbeddedDriver is given below. Please
set the resources/user.default.sql file as the sql file.
-
- DefaultRealm realm = new DefaultRealm();
- DefaultRealmConfig config =
(DefaultRealmConfig)realm.getRealmConfiguration();
- config.setSqlFile("user.default.sql"); //user.default.sql file inside
the resources directory of the distribution
-
config.setConnectionURL("jdbc:derby:/home/muthulee/temp/test/UserDatabase");
- config.setDriverName("org.apache.derby.jdbc.EmbeddedDriver");
- realm.init(config);
- realm.addUser("Alice", "myPass");
-
- boolean isAuthenticated = realm.authenticate("Alice", "myPass");
- if(isAuthenticated){
- System.out.println("Success");
- }
+Welcome to the User Manager SNAPSHOT
+lib - Contains libraries
+documentation - All documentation including the release notes
+resources - Scripts to create the database
---------------------------------------------------------------------------
Copyright WSO2 Inc 2007.
_______________________________________________
Commons-dev mailing list
[email protected]
http://wso2.org/cgi-bin/mailman/listinfo/commons-dev
