Sun OpenSSO Enterprise 8.0 Developer's Guide

Customizing Branding and Functionality

You can modify JSP templates and module configuration properties files to reflect branding or functionality specified for any of the following:

ProcedureTo Modify Branding and Functionality

  1. Go to the directory where default JSP templates are stored.

    cd OpenSSO-Deploy-base/config/auth

  2. Create a new directory.

    Use the appropriate customized directory path based on the level of customization. Use the following forms:


    org_locale/orgPath/filePath
         org/orgPath/filePath
         default_locale/orgPath/filePath
         default/orgPath/filePath

    In these examples,

    orgPath represents subOrg1/subOrg2

    filePath represents clientPath + serviceName

    clientPath represents clientType/sub-clientType

    In these paths, SubOrg, Locale, Client Path, Service Name (which represents orgPath and filePath ) are optional. The organization name you specify may match the organization attribute set in the Directory Server. For example, if the organization attribute value is SunMicrosystems, then the organization customized directory should also be SunMicrosystems. If no organization attribute exists, then use the lowercase value of the organization name (sunmicrosystems).

    For example, for the following attributes:

    org = SunMicrosystems

    locale = en

    subOrg = solaris

    clientPath = html/ customerName/

    serviceName = paycheck

    The customized directory paths would then be:

    SunMicrosystems_en/solaris/html/ customerName /paycheck

    SunMicrosystems/solaris/html/ customerName /paycheck

    default_en/solaris/html/ customerName/paycheck

    default/solaris/html/ customerName /paycheck

  3. Copy the default templates.

    Copy all the JSP templates (*.jsp) and authentication module configuration properties XML files (*.xml) from the default directory:

    OpenSSO-Deploy-base/config/auth/default

    to the new directory:

    OpenSSO-Deploy-base/config/auth/CustomizedDirectoryPath

  4. Customize the files in the new directory.

    The files in the new directory can be customized if necessary, but not this is not required. See Customizing the Login Page and Customizing JSP Templates for information on what you can modify.

  5. Update and redeploy the opensso.war file.

    After you have modified the authentication GUI files, in order to see the changes in the actual GUI, you must update and then redeploy the opensso.war file. For more information, see Chapter 12, Creating and Deploying OpenSSO Enterprise WAR Files.

  6. Restart the OpenSSO Enterprise server web container.