This appendix describes the directory layout after you install Sun JavaTM System Access Manager 7.1 using the Sun Java System Enterprise System (Java ES) installer.
If you are deploying an Access Manager 7.1 WAR file, see Chapter 12, Deploying Access Manager as a Single WAR File, in Sun Java System Access Manager 7.1 Postinstallation Guide.
The following table shows a summary of the Access Manager default directories after installation.
Description |
Default Directory |
---|---|
Base Installation Directory |
Solaris systems: /opt/SUNWam Linux and HP-UX systems: /opt/sun/identity Windows systems: C:\Program Files\Sun\JavaES5\identity During installation, you can specify a different base installation directory for /opt, /opt/sun, or C:\Program Files\Sun\JavaES5, if you prefer. However, do not change the /SUNWam, /identity, or \identity product directory name. |
Configuration Directory |
Solaris systems: /etc/opt/SUNWam/config Linux and HP-UX systems: /etc/opt/sun/identity/config Windows systems: C:\Program Files\Sun\JavaES5\identity\config |
Temporary Files Directory |
Solaris systems: /var/opt/SUNWam/tmp Linux and HP-UX systems: /var/opt/sun/identity/tmp Windows systems: C:\Program Files\Sun\JavaES5\identity\tmp |
Debug Files Directory |
Solaris systems: /var/opt/SUNWam/debug Linux and HP-UX systems: /var/opt/sun/identity/debug Windows systems: C:\Program Files\Sun\JavaES5\identity\debug |
Log Files Directory |
Solaris systems: /var/opt/SUNWam/logs Linux and HP-UX systems: /var/opt/sun/identity/logs Windows systems: C:\Program Files\Sun\JavaES5\identity\logs |
The default base installation directory depends on the platform where you are installing Access Manager:
Solaris systems: /opt
Linux and HP-UX systems: /opt/sun
Windows systems: C:\Program Files\Sun\JavaES5
In the Access Manager documentation, the AccessManager-base variable represents the base installation directory for Solaris, Linux, and HP-UX systems. For Windows systems, the javaes-install-dir variable represents the Java ES 5 installation directory.
Within the base installation directory, Access Manager packages, shared binary files, command-line tools, and other files are installed in the /SUNWam directory on Solaris systems, the /identity directory on Linux and HP-UX systems and \identity directory on Windows systems. Therefore, the default base and product directory also depend on the platform:
Solaris systems: /opt/SUNWam
Linux and HP-UX systems: /opt/sun/identity
Windows systems: C:\Program Files\Sun\JavaES5\identity
During installation, you can specify a different base installation directory if you wish. However, do not change the /SUNWam, /identity, or \identity product directory name.
On Windows systems, the \setup directory contains the following files that you can use to configure Access Manager:
amconfig.bat is a batch file used to deploy, configure, and reconfigure Access Manager. This file is equivalent to the amconfig script on UNIX and Linux platforms.
AMConfigurator.properties is the configuration input file that contains the Access Manager configuration properties. This file is equivalent to the amsamplesilent file on UNIX and Linux platforms. The values in AMConfigurator.properties should not contain backslashes (\).
The /SUNWam, /identity, or \identity directory contains the following files and directories:
Web application archive (WAR) files, such as amcommon.war, amconsole.war, ampassword.war , and amserver.war.
For information about WAR files, see the Sun Java System Access Manager 7.1 Developer’s Guide and Chapter 12, Deploying Access Manager as a Single WAR File, in Sun Java System Access Manager 7.1 Postinstallation Guide.
Subdirectories include:
After installing Access Manager, check the package installation accuracy by using the pkgchk (1M) utility. For example:
pkgchk -l -p /opt/SUNWam
The following table describes the command-line tools and utilities in the /bin directory. For information about running these tools and utilities, see the Sun Java System Access Manager 7.1 Administration Reference.
Table A–2 Access Manager Command-Line Tools and Utilities
Utility |
Description |
---|---|
am2bak am2bak.bat (Windows) |
Backs up the Access Manager components. |
amadmin amadmin.bat (Windows) |
Load XML service files into Directory Server and performs batch administrative tasks on the DIT. |
amsfo, amsfoconfig, amsfopassword amsfo.pl, amsfoconfig.bat, amsfopassword.bat (Windows) |
Access Manager session failover scripts. |
ampassword ampassword.bat (Windows) |
Changes passwords for Access Manager administrator or users. |
amsamplesilent |
Sample silent install file for use with the installation and configuration scripts. |
amconfig, amutils, amdsconfig, amsdkconfig, amsvcconfig, amas70config, amwas51config, amwl81config, amws61config |
Installation and configuration scripts for installing, configuring, and uninstalling Access Manager instances. For information about these scripts, see Chapter 2, Running the Access Manager amconfig Script, in Sun Java System Access Manager 7.1 Postinstallation Guide. |
amserver |
Start and stops the amunixd and amsecuridd daemons. |
amtune directory |
Contains the Access Manager tuning scripts, which allow you to set operating system, Access Manager, web container, and Directory Server parameters to improve performance. |
amverifyarchive amverifyarchive.bat (Windows) |
Verifies the log archives to detect possible tampering and/or deletion of any files in the archive. |
bak2am bak2am.bat (Windows) |
Restores Access Manager components backed up by the am2back or am2back.bat utility. |
ldapmodify |
Edits the contents of an LDAP directory, either by adding new entries or by modifying existing ones. |
ldapsearch |
Issues search requests to an LDAP directory and displays the result as LDIF text. |
amGenerateLDIF.pl and amGenerateNI.pl |
Access Manager bulk federation scripts. |
am2bak.template, amserver.template, amadmin.template, amverifyarchive.template, ampassword.template, and bak2am.template |
Access Manager template files. |
The /docs directory contains the HTML, JAR, CSS, and related files used for the Java API reference (Javadocs).
The /dtd directory contains the Document Type Definition (DTD) files used by Access Manager. A DTD defines the structure for XML files accessed by Access Manager. For more information, see the Sun Java System Access Manager 7.1 Developer’s Guide.
The following table describes the Access Manager DTD files in the /dtd directory.
Table A–3 Access Manager DTD Files
File |
Description |
---|---|
Auth_Module_Properties.dtd |
Defines the structure for XML files used by the authentication modules to specify their properties. |
amAdmin.dtd |
Defines the structure for XML files used to perform batch LDAP operations on the directory tree using the amAdmin command-line tool. |
amWebAgent.dtd |
Defines the structure for XML files used to handle requests from, and send responses to, web agents. This file is deprecated and remains for purposes of backward compatibility. |
policy.dtd |
Defines the structure for XML files used to store policies in Directory Server. |
remote-auth.dtd |
Defines the structure for XML files used by the Authentication Service’s remote Authentication API. |
server-config.dtd |
Defines the structure for serverconfig.xml which details ID, host and port information for all server and user types. |
sms.dtd |
Defines the structure for XML service files. |
web-app_2_2.dtd |
Defines the structure for XML files used by the Access Manager deployment container to deploy J2EE applications. |
The /include directory contains header (.h) files.
The /ldaplib/ldapsdk subdirectory contains the shared object (.so) files needed to run the LDAP utilities included with Access Manager.
The /lib directory contains JAR files and additional shared object (.so) files. It also contains a link to the AMConfig.properties file.
The /locale directory contains the localization properties files. Each properties file includes a corresponding English localization file. For example, amAdminCLI_en.properties is the corresponding file for amAdminCLI.properties.
The /migration directory contains the scripts and supporting files used to migrate data from earlier versions of Access Manager.
For more information about migration, the Sun Java Enterprise System 5 Upgrade Guide in the following documentation collection: http://docs.sun.com/coll/1286.2.
The /public_html directory and subdirectories contain the HTML and related files used for the Access manager Console online help.
The /samples directory contains the following subdirectories: /admin, /appserver, /authentication, /console, /csdk, /liberty, /logging, /phase2, /policy, /saml, /sso, and /um.
Each subdirectory contains samples for the respective functionality, which is indicated by the subdirectory name. For more specific information about these samples, see the Readme.html file.
The /share/bin subdirectory contains the following additional utilities used internally by Access Manager, including amsecuridd, amunixd, amwar, checkport, and wsutils.ksh.
The /upgrade directory contains the following directories:
The /scripts contains the upgrade scripts and files.
The /services directory contains directories for the Access Manager services.
The /web-src directory contains the subdirectories in which Access Manager J2EE web applications are deployed on a web container. It contains the following subdirectories:
applications/ directory where the Access Manager Console is deployed. It contains the index.html file and various subdirectories. The /console directory contains various console related subdirectories.
The /common directory (and subdirectories) is where the Access Manager Liberty Common Domain component is deployed.
The /password directory (and subdirectories) is where the Access Manager Password Synchronization component is deployed. It contains the index.html file and the various subdirectories.
The /services directory (and subdirectories) is where Access Manager Core Services are deployed. It contains the index.html file and the various subdirectories.
The default location of the configuration (/config) directory depends on the platform where Access Manager is installed:
Solaris systems: /etc/opt/SUNWam/config
Linux and HP-UX systems: /etc/opt/sun/identity/config
Windows systems: C:\Program Files\Sun\JavaES5\identity\config
The /config directory contains configuration, XML, and LDIF files, including:
The .version file contains the current version of Access Manager.
The AMConfig.properties and SSOConfig.properties files contain Access Manager configuration attributes.
The serverconfig.xml file provides configuration information for the Access Manager for Directory Server.
The /ldif subdirectory contains the LDIF files needed for populating the Directory Server data store when installing Access Manager. For example:
During installation, the ds_remote_schema.ldif file loads the Access Manager specific LDAP schema object classes and attributes (such as the iplanet-am-managed-people-container) needed to store Access Manager data in Directory Server. The sunone_schema2.ldif file loads the Access Manager specific LDAP schema object classes and attributes.
During uninstallation, The ds_remote_schema_uninstall.ldif file removes the Access Manager LDAP schema object classes and attributes from Directory Server.
The /xml subdirectory contains XML files.
The /ums subdirectory contains XML files, including:
The amserveradmin script loads the Access Manager services.
The ums.xml file provides a set of templates that contain LDAP configuration information for objects managed using Access Manager.
The XML files are generally not used for configuration. If they are modified, they must be manually reloaded into the Directory Server data store. (Any changes in the server are not synchronized with these files.) For information about the XML files in this directory, see the Sun Java System Access Manager 7.1 Developer’s Guide.