Author: dimuthul Date: Mon Jan 21 01:04:14 2008 New Revision: 12571 Log:
Addig documentation. Added: trunk/commons/usermanager/modules/docs/ trunk/commons/usermanager/modules/docs/configuration_manual.html trunk/commons/usermanager/modules/docs/index.html trunk/commons/usermanager/modules/docs/index_docs.html trunk/commons/usermanager/modules/docs/release_notes.html trunk/commons/usermanager/modules/docs/using_usermanager.html Added: trunk/commons/usermanager/modules/docs/configuration_manual.html ============================================================================== --- (empty file) +++ trunk/commons/usermanager/modules/docs/configuration_manual.html Mon Jan 21 01:04:14 2008 @@ -0,0 +1,68 @@ +<!-- + ~ Copyright 2005-2007 WSO2, Inc. (http://wso2.com) + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> +<html> +<title>UserManager - Configuration Manual</title> +<body> +<h1>WSO2 UserManager SNAPSHOT, Guide to using User Manager</h1> + +<p>[<a +href="">Download</a>] +| [<a href="index_docs.html">Documentation Home</a>] | [<a +href="release_notes.html">Release Note</a>]</p> +<p></p> +<p>Please read <a href="using_usermanager.html">Guide to UserManager</a> first. This document only contains the configuration bean parameters and their description.</p> +<p></p> +<strong>LDAP - org.wso2.usermanager.custom.ldap.LDAPRealmConfig</strong> +<p>Configuration object is org.wso2.usermanager.custom.ldap.LDAPRealmConfig. It requires the following parameters to be set.</p> +<table> + <tr><td>Parameter Name</td><td>Is Requried</td><td>Description</td></tr> + <tr><td>ConnectionUrl</td><td>Yes</td><td>LDAP connection url - e.g. ldap://localhost:389</td></tr> + <tr><td>ConnectionName</td><td>Yes</td><td>LDAP connection username. This must be a root user who can read attribute IDs</td></tr> + <tr><td>ConnectionPass</td><td>Yes</td><td>LDAP connection password.</td></tr> + <tr><td>UserPattern</td><td>Yes</td><td>User search pattern must be given - e.g. uid={0},ou=People,dc=wso2,dc=com </td></tr> + <tr><td>UserContextName</td><td>No. Required only when reading all users</td><td>Name of the context, where user objects are stored</td></tr> + <tr><td>AttributeIds</td><td>No. Required only when reading attributes</td><td>User Attribute IDs that will be read by the IdP. + Column names must be comma seperated - e.g. email_address, telephone. These attributes + will be included in the issued SAML tokens. </td></tr> +</table> +<p></p> +<strong>JDBC - org.wso2.usermanager.custom.jdbc.JDBCRealmConfig</strong> +<p>Configuration object is org.wso2.usermanager.custom.jdbc.JDBCRealmConfig. It requires the following parameters to be set.</p> +<table> + <tr><td>Parameter Name</td><td>Is Required</td><td>Description</td></tr> + <tr><td>DriverName</td><td>Yes</td><td>JDBC Driver's class name. It must be present in the classpath - e.g. org.apache.derby.jdbc.EmbeddedDriver</td></tr> + <tr><td>ConnectionURL</td><td>Yes</td><td>Connection URL to the database - e.g. jdbc:derby:home/identity/database/SAMPLE_DB</td></tr> + <tr><td>ConnectionUserName</td><td>Yes</td><td>Connection username to the database</td></tr> + <tr><td>ConnectionPassword</td><td>Yes</td><td>Connection password of the username</td></tr> + <tr><td>UserTable</td><td>Yes</td><td>User table name in the database.</td></tr> + <tr><td>UserNameColumn</td><td>Yes</td><td>User name column in the User table</td></tr> + <tr><td>UserCredentialColumn</td><td>Yes</td><td>User credential column in the User table</td></tr> + <tr><td>ColumnNames</td><td>No. Required only when reading attributes</td><td>Column names of the user table from where the user properties will be read. + Column names must be comma seperated - e.g. email_address, telephone. These attributes + will be included in the issued SAML tokens. + </td></tr> +</table> +<p></p> +<strong>Acegi - org.wso2.usermanager.custom.acegi.AcegiRealmConfig</strong> +<p>Configuration object is org.wso2.usermanager.custom.acegi.AcegiRealmConfig. It requires the following parameters to be set.</p> +<table> + <tr><td>Parameter Name</td><td>Is Requried</td><td>Description</td></tr> + <tr><td>AuthenticationProviderBeanMappingFile</td><td>Yes</td><td>Authentication Provider BeanMappingFile</td></tr> + <tr><td>AuthProviderId</td><td>Yes</td><td>AuthenticationProvider Id in the Bean Mapping File</td></tr> +</table> + +</body> +</html> Added: trunk/commons/usermanager/modules/docs/index.html ============================================================================== --- (empty file) +++ trunk/commons/usermanager/modules/docs/index.html Mon Jan 21 01:04:14 2008 @@ -0,0 +1,58 @@ +<!-- + ~ Copyright 2005-2007 WSO2, Inc. (http://wso2.com) + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> + +<html> +<title>UserManager - Index</title> +<body> +<h1>Welcome to WSO2 User Manager SNAPSHOT Version</h1> + +<p>[<a +href="">Download</a>] +| [<a href="index_docs.html">Documentation Home</a>] | [<a +href="release_notes.html">Release Note</a>]</p> + +<p>WSO2 User Manager is a user management library that can authenticate/authorize and manage users. +It can be configured to connect to existing enterprise user stores to authenticate users. It can authenticate users in relational databases, LDAP and Acegi.</p> + +<strong>Features of UserManager</strong> +<ul> + <li>Create/manage/authenticate/authorize users</li> + <ul> + <li>Add/Edit/Delete user</li> + <li>Add/Edit/Delete user details</li> + <li>Add/Edit/Delete roles</li> + <li>Assoicite users to roles</li> + <li>Remove users from role</li> + <li>Different querries based on users/roles and user information</li> + <li>Authenticate users</li> + <li>Access control adminstration on users/roles to access resources</li> + <li>Access control querries on users/roles</li> + </ul> + <li>Authenticate users in JDBC, LDAP and Acegi user stores</li> + <li>Allows authorization based user management</li> + <li>All Realms uses the same API, therefore users can be managed across realms without code change.</li> +</ul> + +</ul> + +<p>See the <a href="index_docs.html">full list of documents</a> with +instructions on how to integrate WSO2 User Manager into your application development</p> +<a></a> + +<h3></h3> + +</body> +</html> Added: trunk/commons/usermanager/modules/docs/index_docs.html ============================================================================== --- (empty file) +++ trunk/commons/usermanager/modules/docs/index_docs.html Mon Jan 21 01:04:14 2008 @@ -0,0 +1,38 @@ +<!-- + ~ Copyright 2005-2007 WSO2, Inc. (http://wso2.com) + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> +<html> +<title>WSO2 UserManager SNAPSHOT - Documentation Index</title> +<body> +<p>[<a +href="">Download</a>] +| [<a href="index_docs.html">Documentation Home</a>] | [<a +href="release_notes.html">Release Note</a>]</p> + +<h1>WSO2 UserManager SNAPSHOT- Documentation Index</h1> +<strong>For Application Developers</strong> +<ul> + <li><a href="release_notes.html">Release Notes</a> - + Release Notes + </li> + <li><a href="using_usermanager.html">Guide to UserManager</a> - Provides + instructions on how to use user manager in your application + </li> + <li><a href="configuration_manual.html">Configuration Manual</a> - + Contains parameters and descriptions for all the realms</li> +</ul> + +</body> +</html> Added: trunk/commons/usermanager/modules/docs/release_notes.html ============================================================================== --- (empty file) +++ trunk/commons/usermanager/modules/docs/release_notes.html Mon Jan 21 01:04:14 2008 @@ -0,0 +1,72 @@ +<!-- + ~ Copyright 2005-2007 WSO2, Inc. (http://wso2.com) + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> + +<html> +<title>UserManager - Release Notes</title> +<body> +<h1>WSO2 UserManager SNAPSHOT Release Notes</h1> + +<p>[<a +href="">Download</a>] +| [<a href="index_docs.html">Documentation Home</a>] | [<a +href="release_notes.html">Release Note</a>]</p> + +<h3>23 January, 2007</h3> + +<p>UserManager is a library allows user management to be consistent across applications.</p> + +<h3>Key Features of this Release</h3> +<ul> + <li>Create/manage/authenticate/authorize users</li> + <ul> + <li>Add/Edit/Delete user</li> + <li>Add/Edit/Delete user details</li> + <li>Add/Edit/Delete roles</li> + <li>Assoicite users to roles</li> + <li>Remove users from role</li> + <li>Different querries based on users/roles and user information</li> + <li>Authenticate users</li> + <li>Access control adminstration on users/roles to access resources</li> + <li>Access control querries on users/roles</li> + </ul> + <li>Authenticate users in JDBC, LDAP and Acegi user stores</li> + <li>Allows authorization based user management</li> + <li>All Realms uses the same API, therefore users can be managed across realms without code change.</li> +</ul> + +<h3>Reporting Problems</h3> + +<p>Issues can be reported using the public JIRA available at <a href="https://wso2.org/jira/browse/COMMONS";>https://wso2.org/jira/browse/IDENTITY</a></p> + +<h3>Contact us</h3> + +<p>WSO2 UserManager developers can be contacted via mailing lists: </p> + +<p>For Developers:[email protected]</p> + +<p>For details on subscriptions see <a href="http://wso2.org/projects/commons/user-manager";>http://wso2.org/projects/commons/user-manager</a> +</p> + +<p>Alternatively, questions can also be raised in the forums: <a href="http://wso2.org/forum/192";>http://wso2.org/forum/192</a></p> + +<p>For more information on WSO2 UserManager, visit the WSO2 Oxygen Tank</p> + +<p>Thank you for your interest in WSO2 UserManager</p> + +<p>-The WSO2 UserManager Development Team</p> + +</body> +</html> Added: trunk/commons/usermanager/modules/docs/using_usermanager.html ============================================================================== --- (empty file) +++ trunk/commons/usermanager/modules/docs/using_usermanager.html Mon Jan 21 01:04:14 2008 @@ -0,0 +1,114 @@ +<!-- + ~ Copyright 2005-2007 WSO2, Inc. (http://wso2.com) + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> + +<html> +<title>UserManager Guide</title> +<body> +<h1>WSO2 UserManager SNAPSHOT, Guide to using User Manager</h1> + +<p>[<a +href="">Download</a>] +| [<a href="index_docs.html">Documentation Home</a>] | [<a +href="release_notes.html">Release Note</a>]</p> + +<p><strong>Table of Contents</strong></p> +<ul> +<li><a href="#t1">Overview of UserManager</a></li> +<li><a href="#t2">Compiling with UserManager</a></li> +<li><a href="#t3">Coding with UserManager</a></li> +<li><a href="#t4">Connecting to Existing User Stores</a></li> +<li><a href="#t5">Creating your own User Stores</a></li> +<li><a href="#t6">Using a AuthorizingRealm</a></li> +</ul> +<h3><a name="t1">Overview of UserManager</a></h3> +<p>WSO2 UserManager uses Realms to connect to user stores. For example org.wso2.usermanager.custom.jdbc.JDBCRealm can connect to relational databases to authenticate users. Following is the list of Realms with their speciality. All Realms implement the org.wso2.usermanager.Realm interface. Therefore your application can switch back and forth between Realms.</p> + +<table> +<tbody> +<tr><th>Realm Name</th><th>Description</th></tr> +<tr><td>JDBCRealm</td><td>Authenticate users in relational databases</td></tr> +<tr><td>LDAPRealm</td><td>Authenticate users in company LDAP to Authenticate users</td></tr> +<tr><td>AcegiRealm</td><td>Authenticate users in Acegi user stores</td></tr> +<tr><td>DefaultRealm</td><td>Create/manage/querry users. The database can be created using the scripts provided or by calling utility methods.</td></tr> +<tr><td>AuthorizingRealm</td><td>This realm wraps other realms. It calls isUserAuthorized() method before performing actions.</td></tr> +</tbody> +</table> + +<h3><a name="t2">Coding with UserManager</a></h3> + +<p>Using the Realm interface is accompanied by 5 other interfaces. Using the Realm interface we can get objects that implement these +interfaces. They can manipute or read UserStore.</p> + +<table> +<tbody> +<tr><th>Interface</th><th>Realm Interface Method</th><th>Description</th></tr> +<tr><td>org.wso2.usermanager.Authenticator</td><th>getAuthenticator()</th><td>Authenticate users.</td></tr> +<tr><td>org.wso2.usermanager.AccessControlAdmin</td><th>getAccessControlAdmin()</th><td>Add/edit/delete Authorization on users/roles/resources</td></tr> +<tr><td>org.wso2.usermanager.Authorizer</td><th></th>getAuthorizer()<td>Can check for authorizations</td></tr> +<tr><td>org.wso2.usermanager.UserStoreAdmin</td><th>getUserStoreAdmin()</th><td>Add/edit/delete users.</td></tr> +<tr><td>org.wso2.usermanager.UserStoreReader</td><th>getUserStoreReader()</th><td>Querry user details.</td></tr> +</tbody> +</table> + + +<p>This is how you initialize and use the realm.</p> +<pre> + Realm realm = new XYZRealm(); + XYZRealmConfig config = (XYZRealmConfig) realm + .getRealmConfiguration(); + /*Call setter methods on the configuration object*/ + config.set....... + config.set....... + realm.init(config); + realm.getAuthenticator().authenticate("anne", "annepass"); + +</pre> + +<p>For more details on configuration baen parameters please refer <a href="configuration_manual.html">Configuration Manual</a></p> + +<h3><a name="t3">Compiling with UserManager</a></h3> + +<p>You only need the usermanager-core.jar and usemanager-config.jar. Other libraries depends on the type of Realm that you are using.</p> + +<table> +<tbody> +<tr><th>Realm Name</th><th>Required Additional Libraries</th></tr> +<tr><td>JDBCRealm</td><td>Only the jar containing the JDBC driver of your choice</td></tr> +<tr><td>LDAPRealm</td><td> naming-factory.jar, naming-factory-dbcp.jar, naming-resources.jar</td></tr> +<tr><td>AcegiRealm</td><td>spring.jar, acegi-security.jar</td></tr> +<tr><td>DefaultRealm</td><td>Only the jar containing the JDBC driver of your choice</td></tr> +<tr><td>AuthorizingRealm</td><td> - None - </td></tr> +</tbody> +</table> + + +<h3><a name="t4">Connecting to Existing User Stores</a></h3> + +<p>When connecting to existing user stores you only perform Authentication. The following realms are the Realms that you can use for this purpose</p> +<ul> + <li>JDBCRealm</li> + <li>LDAPRealm</li> + <li>AcegiRealm</li> +</ul> + +<h3><a name="t5">Creating your own User Stores</a></h3> +<p>When your application wants to create and maintain users in your own database Default Realm can be used. It is a fully pleged Realm where users/roles and permissions can be created/managed and querried.</p> + +<h3><a name="t6">Using a AuthorizingRealm</a></h3> +<p>AuthorizingRealm wraps another Realm inside it along with a username. Before calling the actions it calls isUserAuthorized() method for the authenticated user.</p> + +</body> +</html> _______________________________________________ Commons-dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/commons-dev
