Sun Java System SAML v2 Plug-in for Federation Services User's Guide

Installing the SAML v2 Plug-in for Federation Services

To install the SAML v2 Plug-in for Federation Services packages and create an updated WAR, run the saml2setup installer as described in The saml2setup Command-line Reference.


Note –

saml2setup takes as input an installation configuration properties file. See Creating an Installation Configuration Properties File for more information.


ProcedureTo Install the SAML v2 Plug-in for Federation Services

Before You Begin

Create an installation configuration properties file as described in Creating an Installation Configuration Properties File.


Note –

For instances of Access Manager and Federation Manager using an LDAPv3–compliant directory, the new schema file is loaded only if the LOAD_SCHEMA variable in the installation configuration properties file is set to true.


  1. Log in as root.

    You must have system administrator privileges to run the SAML v2 Plug-in for Federation Services installer.

  2. Create a new directory.


    # mkdir saml2bits
    

    # cd saml2bits
    
  3. Download the file-name.tar.gz file into the new directory.

    See the Sun Java System SAML v2 Plug-in for Federation Services Release Notes for the download URL.

  4. Unpack the product binaries by typing:


    # gunzip —dc file-name.tar.gz | tar -xvof -
    

    where file-name.tar.gz is the name of the downloaded file.

  5. Run the saml2setup installer as follows:


    # saml2setup install -s installation-file-name
    

    where installation-file-name is the name of the installation configuration properties file described in Creating an Installation Configuration Properties File.

    The installer will install the packages, configure the plug-in, and create an updated WAR using the service deployment identifier specified in the AMConfig.properties file of the specific server product.

    • When installed into an instance of Access Manager, the new WAR is located in /AccessManager-base/product-directory/ and is called service-deploy-uri.war as in, for example, amserver.war.


      Note –

      AMConfig.properties is located in the /etc/opt/product-directory/config directory.


    • When installed into an instance of Federation Manager, the new WAR is located in the staging directory defined in the installation configuration properties file and is called FM-deploy-uri.war as in, for example, federation.war


      Note –

      AMConfig.properties is located in the /staging-directory/web-src/WEB-INF/classes directory.


  6. Follow the instructions in Appendix A, Deploying the SAML v2 Plug-in for Federation Services Generated WAR to deploy the modified WAR and complete the installation.

Next Steps

Restart Federation Manager if you installed the SAML v2 Plug-in for Federation Services on that server product.