cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gma...@apache.org
Subject svn commit: r1372540 - in /cxf/fediz/trunk/examples: simpleWebapp/README.txt wsclientWebapp/README.txt
Date Mon, 13 Aug 2012 18:32:46 GMT
Author: gmazza
Date: Mon Aug 13 18:32:45 2012
New Revision: 1372540

URL: http://svn.apache.org/viewvc?rev=1372540&view=rev
Log:
More clarification of Fediz sample READMEs.

Modified:
    cxf/fediz/trunk/examples/simpleWebapp/README.txt
    cxf/fediz/trunk/examples/wsclientWebapp/README.txt

Modified: cxf/fediz/trunk/examples/simpleWebapp/README.txt
URL: http://svn.apache.org/viewvc/cxf/fediz/trunk/examples/simpleWebapp/README.txt?rev=1372540&r1=1372539&r2=1372540&view=diff
==============================================================================
--- cxf/fediz/trunk/examples/simpleWebapp/README.txt (original)
+++ cxf/fediz/trunk/examples/simpleWebapp/README.txt Mon Aug 13 18:32:45 2012
@@ -4,33 +4,29 @@ Simple Web Application Demo
 This demo shows how to build and deploy an SSO protected using Apache CXF Fediz
 web application.
 
-The Demo consist of three parts:
+Running this sample consists of four steps:
 
-- Configure Fediz in the IDP and RP Tomcat instances
-- Install the Fediz Identity Provider (IDP)
-- Build the Demo Web Application
+- Configure the Tomcat-IDP and Tomcat-RP instances
+- Building the demo using Maven
+- Deploying the demo to the Tomcat-RP instance
+- Testing the demo
 
 Please review the README in the samples main directory before continuing.
 
-Configure Tomcat instances used for RP and IDP
-----------------------------------------------
-The Tomcat installation holding the relying parties (the demo Web application
+Configure the Tomcat-IDP and Tomcat-RP instances
+------------------------------------------------
+First, make sure the separate Tomcat instance hosting the Fediz IDP and IDP
+STS has been configured and is running as described here:  
+http://cxf.apache.org/fediz-idp.html.  Confirm the STS is active by
+checking that the WSDL is viewable from the browser using the URL given
+on that page--don't proceed further unless it is.
+
+Next, the Tomcat installation holding the relying parties (the demo Web application
 for this sample) must be configured properly before applications can be
 deployed to it.  See this wiki page for instructions:
-http://cxf.apache.org/fediz-tomcat.html
-
-Copy the Fediz Configuration file into the directory 'conf' of the Tomcat-RP
-installation. The configuration file is located in 
-src/main/config/fediz_config.xml of this example.  This configuration
-references the java keystore 'tomcat-rp.jks' from examples/samplekeys
-which contains the STS' public certificate to validate a SAML token
-issued by the IDP/STS.
-
-It's also assumed the separate Tomcat instance hosting the Fediz IDP and IDP
-STS has been configured and is running as described here:  
-http://cxf.apache.org/fediz-idp.html.  To confirm the STS is working,
-check that the WSDL is viewable from the browser using the URL given
-on that page.
+http://cxf.apache.org/fediz-tomcat.html -- the "Installation" and "HTTPS
+Configuration" sections are the only parts that need configuration for this
+sample. 
 
 
 Demo Web Application
@@ -58,9 +54,15 @@ command prompt, enter:
 
 Deploying the demo to Tomcat
 ----------------------------
-You can manually copy the generated WAR file to the Tomcat-RP's webapps folder, 
-or use the Tomcat Maven Plugin as described in the README file in the example folder
-root.
+First copy this sample's Fediz Configuration file (src/main/config/fediz_config.xml)
+into the Tomcat-RP's conf folder.  This configuration references the 
+Java keystore 'tomcat-rp.jks' available in Fediz' examples/samplekeys folder 
+but should already be in the Tomcat RP's root folder when you configured this
+instance as stated in the prerequisites.
+
+Then, either manually copy this sample's generated WAR file to the Tomcat-RP's 
+webapps folder, or use the Tomcat Maven Plugin as described in the README file 
+in the example folder root.
 
 
 Test the demo

Modified: cxf/fediz/trunk/examples/wsclientWebapp/README.txt
URL: http://svn.apache.org/viewvc/cxf/fediz/trunk/examples/wsclientWebapp/README.txt?rev=1372540&r1=1372539&r2=1372540&view=diff
==============================================================================
--- cxf/fediz/trunk/examples/wsclientWebapp/README.txt (original)
+++ cxf/fediz/trunk/examples/wsclientWebapp/README.txt Mon Aug 13 18:32:45 2012
@@ -3,49 +3,45 @@ Web Service Client Web Application Demo
 
 This demo builds on the simpleWebapp sample to show a Relying Party (RP) web application
using an IDP-provided SAML token to access a third-party web service.  Here the IDP authenticates
the browser user that the web application requested the token on behalf of, and uses its STS
to issue the token which fulfills the web service's security requirements.  From the SAML
token the Web Service is informed which browser user triggered the Web Service call.
 
-The Demo consist of three parts:
+Running this sample consists of four steps:
 
-- Configure Fediz in the IDP and RP Tomcat instances
-- Configure Tomcat instance holding the web service provider
-- Build/deploy the Demo Web Application
-- Build/deploy the Demo Web Service
+- Configure the Tomcat-IDP and Tomcat-RP instances
+- Configure Tomcat instance used for Web Service Provider (Tomcat-WSP)
+- Build the project
+- Deploying the demo WARs to Tomcat-RP and Tomcat-WSP
 
 Please review the README in the samples main directory before continuing.
 You may wish to run the simpleWebapp demo first as this is an extended demo.
 
 
-Configure Tomcat instances used for RP and IDP
-----------------------------------------------
-The Tomcat installation holding the relying parties (the demo Web application 
-for this sample) must be configured properly before applications can be 
-deployed to it.  See this wiki page for instructions:
-http://cxf.apache.org/fediz-tomcat.html
-
-Copy the Fediz Configuration file into the directory 'conf' of the Tomcat-RP
- installation. The configuration file is located in 
-src/main/config/fediz_config.xml of this example.  This configuration
-references the java keystore 'tomcat-rp.jks' from examples/samplekeys which
-contains the STS' public certificate to validate a SAML token issued by the
-IDP/STS.
-
-It's also assumed the separate Tomcat instance hosting the Fediz IDP and IDP
- STS has been configured and is running as described here:  
-http://cxf.apache.org/fediz-idp.html.  To confirm the STS is working, check
-that the WSDL is viewable from the browser using the URL given on that page.
+Configure the Tomcat-IDP and Tomcat-RP instances
+------------------------------------------------
+First, make sure the separate Tomcat instance hosting the Fediz IDP and IDP
+STS has been configured and is running as described here:  
+http://cxf.apache.org/fediz-idp.html.  Confirm the STS is active by
+checking that the WSDL is viewable from the browser using the URL given
+on that page--don't proceed further unless it is.
 
+Next, the Tomcat installation holding the relying parties (the demo Web application
+for this sample) must be configured properly before applications can be
+deployed to it.  See this wiki page for instructions:
+http://cxf.apache.org/fediz-tomcat.html -- the "Installation" and "HTTPS
+Configuration" sections are the only parts that need configuration for this
+sample. 
 
-Configure Tomcat instance used for Web Service Provider
--------------------------------------------------------
+Configure Tomcat instance used for Web Service Provider (Tomcat-WSP)
+--------------------------------------------------------------------
 To better model a real-world environment the web service provider is hosted
 on a third Tomcat instance separate from the RP and IDP Tomcat instances.
 You can follow the Tomcat configuration instructions given here for the IDP
 Tomcat instance: 
 http://cxf.apache.org/fediz-idp.html#FedizIDP-Tomcatserver.xmlconfiguration 
-but (1) use Tomcat ports different from the IDP and RP instances, perhaps 
-10080 for HTTP, 10443 for HTTPS, and 10005 as the server communication port, 
-and (2) don't reuse the Tomcat IDP keystore, the examples/samplekeys folder
-has a third sample (don't use in production!) tomcat-wsp.jks keystore that 
-can be used instead.
+but (1) use Tomcat ports different from the IDP and RP instances, this sample
+uses 10080 for HTTP, 10443 for HTTPS, and 10005 as the server communication 
+port, and (2) don't reuse the Tomcat IDP keystore, the examples/samplekeys 
+folder has a third sample (don't use in production!) tomcat-wsp.jks keystore
+that can be used instead--check the README in the samplekeys folder for 
+more information about the keystores used.
 
 
 Demo Web Application
@@ -85,11 +81,19 @@ mvn clean install   (builds the demo and
 Servlet deployment to the Tomcat-RP and Tomcat-WSP instances)
 
 
-Deploying the demo to Tomcat
-----------------------------
-You can manually copy each generated WAR file to the appropriate
-Tomcat webapps folder, or use the Tomcat Maven Plugin as described 
-in the README file in the example folder root.
+Deploying the demo WARs to Tomcat-RP and Tomcat-WSP
+------------------------------------------------------
+First copy this sample's Fediz Configuration file (src/main/config/fediz_config.xml)
+into the Tomcat-RP's conf folder.  This configuration references the 
+Java keystore 'tomcat-rp.jks' available in Fediz' examples/samplekeys folder 
+but should already be in the Tomcat RP's root folder when you configured this
+instance as stated in the prerequisites.  (If you did the Fediz simpleWebapp 
+sample first you can keep the fediz_config.xml from that sample, as it's 
+identical to this sample's.)
+
+Then, either manually copy this sample's generated WAR file to the Tomcat-RP's 
+webapps folder, or use the Tomcat Maven Plugin as described in the README file 
+in the example folder root.
 
 After deploying the web service provider, make sure you can see its
 WSDL at http://localhost:10080/fedizservice/GreeterService?wsdl



Mime
View raw message