README revision 4fe4e4f798a84a46e567f64ceadd3648eb0582d4
3649N/A<!--
3649N/A DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3649N/A
3649N/A Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
3649N/A
3649N/A The contents of this file are subject to the terms
3649N/A of the Common Development and Distribution License
3649N/A (the License). You may not use this file except in
3649N/A compliance with the License.
3649N/A
3649N/A You can obtain a copy of the License at
3649N/A https://opensso.dev.java.net/public/CDDLv1.0.html or
3649N/A opensso/legal/CDDLv1.0.txt
3649N/A See the License for the specific language governing
3649N/A permission and limitations under the License.
3649N/A
3649N/A When distributing Covered Code, include this CDDL
3649N/A Header Notice in each file and include the License file
3649N/A at opensso/legal/CDDLv1.0.txt.
3649N/A If applicable, add the following below the CDDL Header,
3649N/A with the fields enclosed by brackets [] replaced by
3649N/A your own identifying information:
3649N/A "Portions Copyrighted [year] [name of copyright owner]"
3649N/A
3649N/A $Id: README,v 1.9 2009/01/05 23:51:29 veiming Exp $
3649N/A
3649N/A-->
3649N/A
3649N/APortions Copyrighted [2011] [ForgeRock AS]
3649N/A
3649N/A
3649N/AOpenSSO - Deployable WAR
3649N/A
3649N/AThis directory contains the OpenSSO deployable WAR file
3649N/A(opensso.war which contains all server components and server samples),
3649N/Aand files/directories required to create some specialized WAR files.
3649N/A
3649N/AThe following specialized WAR files are supported:
3649N/A - Console Only WAR (fam-console.list)
3649N/A - Server without console WAR (fam-noconsole.list)
3649N/A - Distributed Authentication WAR (fam-distauth.list)
3649N/A - SAMLv2/ID-FF IDP Discovery/Introduction WAR (fam-idpdiscovery.list)
3649N/A
3649N/AContents of this directory:
3649N/A <zip staging area> (root directory where opensso.zip is extracted)
3649N/A |- opensso (parent directory)
3649N/A |- deployable-war (current directory)
3649N/A |- README (this README file)
3649N/A |- createwar.sh (shell script to create WAR files)
3649N/A |- createwar.bat (bat file to create WAR files)
3649N/A |- opensso.war (OpenSSO Server WAR with samples)
3649N/A |- fam-idpdiscovery.list (files list for IDP Discovery WAR)
3649N/A |- fam-distauth.list (files list for Distributed Authentication WAR)
3649N/A |- fam-console.list (files list for Console Only WAR)
3649N/A |- fam-noconsole.list (files list for Server without console WAR)
3649N/A |- classes (contains resources and classes for executing
3649N/A | createwar.sh and createwar.bat)
3649N/A |- idpdiscovery (directory containing additional files for
3649N/A | IDP discovery WAR)
3649N/A |- distauth (directory containing additional files for
3649N/A | Distributed Authentication WAR)
3649N/A |- console (directory containing additional files for
3649N/A | Console Only WAR)
3649N/A |- noconsole (directory containing additional files for
3649N/A Server without console WAR)
3649N/A
3649N/A
3649N/ASteps to create a specialized WAR file:
3649N/A
3649N/A1. Creates a new directory as staging area for the server WAR, and extracts the
3649N/A opensso.war in this staging directory:
3649N/A % mkdir <server war staging area>
3649N/A % cd <server war staging area>
3649N/A % jar xvf <zip staging area>/opensso/deployable-war/opensso.war
3649N/A
3649N/A2. Creates the specialized WAR file using createwar.sh or createwar.bat.
3649N/A (Please remember that createwar.sh and createwar.bat needs to be executed in
3649N/A its current directory to be able to find the type-specific additional
3649N/A files)
For example, to create Console WAR:
% /createwar.sh -s /tmp/staging -t console -w /tmp/console.war
Now the specialized WAR is ready to be deployed into your web container.
After deploying the WAR, access the WAR deployment URL
(e.g. http://moonriver.eng.sun.com/console) from your browser. A configurator
JSP page will be displayed for you to enter the configuration information
for the special WAR. Enter the fields and submit the data, a configuration file
(e.g. AMConfig.properties) will be created under your home directory. It is
highly recommended that you change the permission of the configuration file
to limit access to the sensitive configuration information.
Now you could access the special WAR for its functions.