You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2015/02/05 17:30:15 UTC
directory-fortress-enmasse git commit: FC-56 - Update Fortress Rest
README
Repository: directory-fortress-enmasse
Updated Branches:
refs/heads/master 2d4e409ba -> e28597076
FC-56 - Update Fortress Rest README
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/commit/e2859707
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/tree/e2859707
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/diff/e2859707
Branch: refs/heads/master
Commit: e28597076d28079442ed345c9ec113206eac6c80
Parents: 2d4e409
Author: Shawn McKinney <sm...@apache.org>
Authored: Thu Feb 5 10:30:02 2015 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Thu Feb 5 10:30:02 2015 -0600
----------------------------------------------------------------------
README.txt | 172 ++++++++++++++++++++++----------------------------------
1 file changed, 66 insertions(+), 106 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/blob/e2859707/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
index 6bab8d0..641695c 100755
--- a/README.txt
+++ b/README.txt
@@ -22,111 +22,86 @@
# Note: Directives that begin with '@' are substitution parms for Fortress' build.xml 'init-slapd' target.
___________________________________________________________________________________
###################################################################################
-README for Fortress EnMasse Web Application Installation
-RC29 (BETA RELEASE CANDIDATE)
-Last updated: August 29, 2013
+README for Fortress Rest Application Installation
+Last updated: February 5, 2015
___________________________________________________________________________________
###################################################################################
-# Prerequisites
+# SECTION 0. Prerequisites for Fortress Rest installation and usage
###################################################################################
-1. Internet access to retrieve dependencies from online Maven repo.
+a. Internet access to retrieve source code from Apache Fortress Web GIT and binary dependencies from online Maven repo.
-NOTE: The EnMasse maven may run without connection to Internet iff:
-- The binary dependencies are already present in M2_HOME
+b. Java SDK Version 7 or beyond installed to target environment
-2. Java SDK Version 7 or beyond installed to target environment
-3. Maven 3 installed to target environment
-4. Fortress/OpenLDAP are installed to target system.
-___________________________________________________________________________________
-###################################################################################
-# Important Notes about EnMasse Web Application
-###################################################################################
-
-1. EnMasse is released as Open Source and available for unrestricted use via BSD 3 clause license. (see LICENSE.txt)
- - EnMasse dependencies are Open Source also.
+c. Apache Maven installed to target environment
-2. This web app was tested using Apache Tomcat 7 but would work inside any current Java Servlet container (with changes to deploy procedure)
+d. LDAP server installed. (see README in Apache Fortress Core)
-3. Maven 'install' target in this package builds EnMasse war file which deploys to Java EE servlet container.
-
-4. This document includes instructions to Compile, Deploy, run Javadoc and Test the EnMasse Web application using Apache Tomcat.
-
-5. Security Measures implemented within this application include:
-
- - Java EE Security - Confidentiality, Authentication, Session Management
- - requires HTTP Basic Auth header exchange to pass credentials used for security checks.
+e. Apache Tomcat or other servlet container installed
+_________________________________________________________________________________
+###################################################################################
+# SECTION 1: Instructions to clone source from Fortress Rest Git Repo:
+###################################################################################
- - Spring Security - Role-Based Access Control Interceptor
- - Service-level Authorization uses Spring Security.
- - To find out what Roles required to which Services, view the Spring annotations inside this file:
- enmasse-dist-[version]/src//main/java/org/openldap/enmasse/FortressServiceImpl.java
+a. Clone the directory-fortress-web from apache git repo:
+# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-web.git
- - Fortress Sentry - Java EE security plugin for Identity, Coarse-grained Authorization, and Audit Trail
+b. Change directory to package home:
+# cd directory-fortress-web/
- - Passwords in Config Files - Encrypted using jasypt.
+d. Set JAVA_HOME
+# export JAVA_HOME=...
- - EnMasse - Identity, Administrative, Compliance and Review services.
+d. Set Maven Home:
+# export M2_HOME=...
- - OpenLDAP - Password Hashing, Policies.
+e. Build the Fortress Web source:
+# $M2_HOME/bin/mvn clean install -DskipTests
___________________________________________________________________________________
###################################################################################
-# SECTION 1: Prerequisites for use of EnMasse Web Application
+# SECTION 2: Instructions to build Fortress Rest
###################################################################################
-Before you can successfully complete the steps to install and run EnMasse, the following steps must be completed:
-
-1. Internet access from your target machine to Maven 2 online repos.
-
-2. Maven 3 installed to target:
-http://maven.apache.org/download.html
-http://www.sonatype.com/books/mvnref-book/reference/installation-sect-maven-install.html
+a. Open a command prompt on target machine in the root folder of the enmasse-dist package
-3. Java SDK Version 7 or beyond installed:
-http://www.oracle.com/technetwork/java/javase/downloads/index.html
+b. Set java home:
+# export JAVA_HOME=...
-4. Fortress/OpenLDAP QUICKSTART installed:
-instructions: http://www.joshuatreesoftware.us/iamfortress/guides/README-QUICKSTART.html
-binaries: https://iamfortress.org/projects
+c. Set maven home:
+# export M2_HOME=...
-5. Tomcat 7 installed:
-http://tomcat.apache.org
+d. Run maven install:
+# $M2_HOME/bin/mvn clean install -DskipTests
-6. Fortress Sentry package (a.k.a Realm) installed:
-instructions: http://www.jts.us/iamfortress/javadocs/api-sentry/org/openldap/sentry/tomcat/package-summary.html
-binaries: http://iamfortress.org/download
+e. Build the javadoc:
+# $M2_HOME/bin/mvn javadoc:javadoc
-Note: There is a complete EnMasse demo that handles these prereqs for you located here:
-http://iamfortress.org/EnMasse
+f. To view Service-level documentation, point your web browser here:
+file:///[package home]/target/site/apidocs/org/apache/directory/fortress/rest/FortressServiceImpl.html
-_________________________________________________________________________________
+(where [package_home] is location of directory-fortress-rest base package)
+___________________________________________________________________________________
###################################################################################
-# SECTION 2: Instructions for EnMasse installation using distribution package
+# SECTION 3: Obtain the fortress.properties
###################################################################################
-1. Retrieve Fortress EnMasse source code bundle either from iamfortress.org or OpenLDAP.org.
+Copy the fortress.properties, created during Apache Fortress Core setup, to this package's resource folder.
-2. Extract contents of openldap-fortress-enmasse.tar.gz to target env.
+# cp [directory-fortress-core]/config/fortress.properties [directory-fortress-enmasse]/src/main/resources
+
+Where [directory-fortress-core] is base folder of the fortress core source package and [directory-fortress-enmasse] is the current package's home folder.
___________________________________________________________________________________
###################################################################################
-# SECTION 3: Instructions to build EnMasse Web archive file
+# SECTION 4: Load Test Users
###################################################################################
-1. Open a command prompt on target machine in the root folder of the enmasse-dist package
-
-2. Set java home:
->export JAVA_HOME=/opt/jdk1.7.0_10
-
-3. Set maven home:
->export M2_HOME=/usr/share/maven
-
-4. Run maven install:
->mvn install
+Run maven install with load file:
+# $M2_HOME/bin/mvn install -Dload.file=./src/main/resources/FortressRestServerRoles.xml -DskipTests=true
###################################################################################
-# SECTION 4: Instructions to Deploy EnMasse Web application to Tomcat
+# SECTION 5: Instructions to Deploy Fortress Rest application to Tomcat
###################################################################################
-1. Enable Maven to communicate with Tomcat using settings.xml file.
+a. Enable Maven to communicate with Tomcat using settings.xml file.
note: a typical location for this maven configuration file is: ~/.m2/settings.xml
@@ -140,23 +115,23 @@ Add to file:
note: If you followed the installation steps of Fortress QUICKSTART your Tomcat Manager creds would be as above.
-2. Enter maven command to deploy to Tomcat:
->mvn tomcat:deploy
+b. Enter maven command to deploy to Tomcat:
+# $M2_HOME/bin/mvn tomcat:deploy
-3. To redeploy:
->mvn tomcat:redeploy
+c. To redeploy:
+# $M2_HOME/bin/mvn tomcat:redeploy
___________________________________________________________________________________
###################################################################################
-# SECTION 5: Instructions to test EnMasse Web application
+# SECTION 6: Instructions to test Fortress Rest application
###################################################################################
-1. Run maven test
->mvn test
+Run maven test
+# $M2_HOME/bin/mvn test
-note1: the EnMasse application must be deployed and running within your servlet container before the unit tests will complete successfully. If your EnMasse server
- is running on a separate machine, or using port other than 8080, adjust the settings accordingly in EmTest Java module.
-note2: For learning and troubleshooting, it is recommended that you use an HTTP proxy program, like Axis' tpMon to intercept the HTTP/XML request/responses between EnMasse client and server.
-note3: The tests depend on user, 'demoUser4', already provisioned into LDAP assigned necessary role, 'EmSuperUser'. demoUser4 is created during Fortress' 'init-slapd' Ant target.
+note1: the Fortress Rest application must be deployed and running within your servlet container before the unit tests will complete successfully. If your app server
+ is running on a separate machine, or using port other than 8080, adjust the settings accordingly in src/main/test/java/org/apache/directory/fortress/rest/EmTest.java
+note2: For learning and troubleshooting, it is recommended that you use an HTTP proxy program, like Axis' tpMon to intercept the HTTP/XML request/responses between Fortress rest client and server.
+note3: The tests depend on user, 'demoUser4', already provisioned into LDAP assigned necessary role, during section 3.
note4: If for any reason these tests should not be run during maven processing, adjust the following setting in project's pom.xml (set to 'true'):
<plugin>
@@ -168,15 +143,19 @@ note4: If for any reason these tests should not be run during maven processing,
</configuration>
</plugin>
+___________________________________________________________________________________
+###################################################################################
+# SECTION 7: Alternative testing procedures
+###################################################################################
-2. Another way to test EnMasse is using the Fortress APIs which can be configured as a proxy for EnMasse. To enable Fortress client to route
-API requests through EnMasse server, add these properties to fortress.properties in your Fortress client's /config folder:
+Another way to test Fortress Rest is using the Fortress Core APIs which can be configured to communicate via HTTP/REST.
+To enable Fortress Core test client to route requests through Fortres Rest server, add these properties to fortress.properties in your Fortress Core client's /config folder:
# These credentials are used for accessing EnMasse:
http.user=demouser4
-http.pw=gX9JbCTxJW5RiH+otQEX0Ja0RIAoPBQf (note this password was encrypted using the Fortress 'encrypt' target in build.xml)
+http.pw=password
http.host=localhost
-http.port=80
+http.port=8080
# These will override default and enable client to call REST implementations:
reviewmgr.implementation=org.apache.directory.fortress.core.rest.ReviewMgrRestImpl
@@ -187,23 +166,4 @@ delegated.reviewmgr.implementation=org.apache.directory.fortress.core.rest.Deleg
policymgr.implementation=org.apache.directory.fortress.core.rest.PswdPolicyMgrRestImpl
delegated.accessmgr.implementation=org.apache.directory.fortress.core.rest.DelegatedAccessMgrRestImpl
auditmgr.implementation=org.apache.directory.fortress.core.rest.AuditMgrRestImpl
-configmgr.implementation=org.apache.directory.fortress.core.rest.ConfigMgrRestImpl
-
-___________________________________________________________________________________
-###################################################################################
-# SECTION 6: Instructions to create EnMasse javadoc (optional)
-###################################################################################
-
-The service level documentation provides descriptions for each of the EnMasse services + required and optional parameters for service invocations.
-
-1. Enter the following:
-
-$ mvn javadoc:javadoc
-
-2. View the document output here:
-
-openldap-fortress-enmasse/target/site/apidocs
-
-3. To view Service-level documentation, go here:
-
-openldap-fortress-enmasse/target/site/apidocs/org/openldap/enmasse/FortressServiceImpl.html
\ No newline at end of file
+configmgr.implementation=org.apache.directory.fortress.core.rest.ConfigMgrRestImpl
\ No newline at end of file