System Admins and Developers
All System Admin Articles
Partha Dey, October 2008
This document is designed for those who plan to install Sun Identity Manager software and perform initial deployment tasks on top of a web server, because a web server is relatively lightweight in comparison to heavyweight application servers.
This article covers the following topics:
Sun Java System Web Server 7.0 Update 3 and above runs on the following wide variety of platforms with Java 2 Platform, Standard Edition (J2SE) Development Kit (JDK) 5 and 6 support:
Sun Java System Web Server 7.0 (hereafter Web Server) Update 3 supports the NetBeans 6.0 IDE. Superior security features include Denial of Service (DoS) attack detection, cross-site detection, and Elliptic Curve Cryptography (ECC) support (see Sun Java System Web Server site). Update 3 also introduces auto-deploy functionality that enables you to deploy one or more web applications just by placing them under a designated directory. The web application to be auto-deployed could be a WAR file, a directory where a web archive is exploded, or a symbolic link to a directory where a web archive is exploded.
Depending on your choice of application server or web server and database, the steps you need to follow for setup differ. In general, you do the following:
Here, we discuss the installation of Sun Identity Manager 8.0 software using Web Server 7.0 Update 3 or above (exploiting its auto-deploy feature) and MySQL 5.0 as the database.
The application requires a Java compiler and a JVM to run the Java classes that perform actions within the Sun Identity Manager software. Both of these items can be found in a JDK. (The Java Runtime Environment [JRE] packages do not include a Java compiler.)
Tips:
JAVA_HOME to your list of system environment variables and to your system path. To do this, add
JAVA_HOME to your system environment and add
JAVA_HOME\bin to your path, making sure to list them before any other Java variables. Adding
JAVA_HOME to your list of system environment variables is helpful for Sun Identity Manager software, but it might affect other applications.
You should use a third-party relational database to store the system index data.
Note : You must configure your database with a character set that supports the characters that you want to store. If you need to store multi-byte characters, you should use a character set, such as UTF-8, that supports Unicode.
Sun Identity Manager software provides sample database scripts that you can modify and use to create tables and indexes. You may choose to use an alternate method to create equivalent tables and indexes, but the tables and indexes must meet these requirements:
waveset in the sample DDL.
You can modify the sample scripts to suit your environment. Common changes include the following:
Note : If you make changes to the sample scripts, then you must make equivalent changes to any sample database upgrade scripts that you receive in the future.
Here, we restrict ourselves to using only MySQL software as the database.
Follow these steps to set up the MySQL database for use with Sun Identity Manager software.
1. Install the MySQL software. Start the MySQL process (if it does not start automatically).
2. Create the database. To do this:
a. Copy the
create_waveset_tables.mysql script from the
db_scripts directory on the installation CD (or from the
idm\sample directory, if you have already installed the software) to a temporary location.
b. Modify the
create_waveset_tables.mysql script to change the database user password.
c. Create the new tables by using one of the following commands:
On Microsoft Windows:
c:\mysql\bin\mysql -u root < create_waveset_tables.mysql
On UNIX:
$MYSQL/bin/mysql -u root < create_waveset_tables.mysql
Use the following information and procedures to install Sun Identity Manager software for use with Web Server version 7 Update 3.
During installation, you will need to know the following:
Follow these installation and configuration steps:
1. Install the Web Server software. You can choose either Express or Custom installation to install the web server. You can also use either graphical or command-line mode for the installation.
For graphical mode installation, execute
setup (
setup.exe in Microsoft Windows environments or
./setup in UNIX environments) after unzipping the binary.
Express installation is the default installation type, and it makes assumptions regarding host name, port numbers, and JDK installation. If you select Express, you do not specify these settings during installation.
Custom installation provides more flexibility and enables you to configure settings that are not specified during Express installation, such as administration server and web server port numbers and which JDK to use. Use Custom installation if you want to customize your installation.
You can also install through the command-line interface, which is an interactive, text-based interface that prompts for responses in a terminal window. To activate the command-line mode, start the installation program using the
--console option (
setup --console in Microsoft Windows environments or
./setup --console in UNIX environments).
You can also use Silent installation mode to install the web server. This mode is a non-interactive mode that enables you to run the installer on multiple hosts using an installer configuration file (state file). To install in silent mode, generate a state file, and then start the installation program using the
--silent option (
./setup --silent </state_file/>).
After the silent mode is activated, installation takes place without additional user input. The installer configuration file (state file) is created when the
savestate option is used with the
setup command to start an interactive installation. Settings are captured during the interactive installation and saved in a state file. This file forms the template for silent installation, and it can be used to install the product on one or more systems. The state file can be modified later if necessary.
./setup --savestate (UNIX)
setup --savestate (Microsoft Windows)
./setup --console --savestate (UNIX)
setup --console --savestate (Microsoft Windows)
Most of the installation parameters are self-explanatory. You can refer to the Sun Java System Web Server 7.0 Update 3 Installation and Migration Guide for the details about configuration parameters.
2. Install the Sun Identity Manager software in the Web Server Instance's auto-deploy directory.
You can use the bundled JDK of Web Server or any other custom JDK (5.0 or higher).
You must export
JDK_HOME.
JAVA_HOME is the location of the JDK. You need to set as
export JAVA_HOME.
JAVA_HOME in the system variable. You need to export your Sun Identify Manager root directory as
WSHOME.
a. Install the software using one of two methods:
Using the installer Graphic User Interface:
Run the
install.bat file (for Microsoft Windows) or the
install command (for UNIX) to launch the installation process.If you copy the files from the installation media to your own location, note that the
idm.war and
install.class files must be in the same directory. The installer displays the Welcome panel.
Using the
nodisplay option (UNIX only):
Change to the directory where the Sun Identity Manager software is located. Enter the following command to activate the installer in nodisplay mode:
install -nodisplay
The installer displays the Welcome text. The installer then presents a list of questions to gather installation information in the same order that the Graphic User Interface installer uses.
Note:
If no display is present, the installer defaults to the nodisplay option. The
DISPLAY environment variable must be set to a valid X server or the installation might fail.
b. Click Next to display the Install or Upgrade? panel.
c. Leave the New Installation option selected, and then click Next. The installer displays the Select Installation Directory panel.
d. Replace the displayed directory location with the location where you want to install the Sun Identity Manager software. This could be a staging location or a specific folder. You can install in a staging location, then make a WAR file from the installed location, and then deploy the WAR file using the Add Web Application tab. If you want to use the auto-deploy feature of the web server then use the following:
%WebServer_HOME%\<Instance_Directory>\auto_deploy\idm
Enter the location (or click Browse to locate it), and then click Next.
e. Click Next to begin installation. After installing files, the installer displays the Launch Setup panel.
f. Before proceeding further, add the Java
mail.jar,
activation.jar, and
jms.jar files to the
$WSHOME/WEB-INF/lib directory. These files can be found here:
http://java.sun.com/products/javamail http://java.sun.com/products/beans/glasgow/jaf.html http://java.sun.com/products/jms/index.jsp
Caution
: Before you continue, if you plan to use an index database, you might need to copy one or more files to the
idm/WEB-INF/lib directory. For example, you might need to place into
idm/WEB-INF/lib a JAR file containing a JDBC driver (for a DriverManager connection) or a JAR file containing a Java Naming and Directory Interface (JNDI)
InitialContextFactory (for a DataSource connection). To determine the steps you might need to perform before you go on, see
Index Database Reference. When finished, click Launch Setup to launch the Setup Wizard and continue with setup steps. If you click Launch Setup before copying your index database files, setup will not proceed correctly. If this happens, quit the installation program, and then use the
lh setup command to restart the setup portion of the installation process.
g. Click Next on the Setup Wizard panel. The product displays the Locate the Repository panel.
h. Select an index database from the list provided. Depending on your selection, setup prompts for additional setup information.
i. Click Next. The Continue Identity Manager Demo Setup? panel appears.
j. If this is a non-demo installation, click No, I will configure Identity Manager myself. This will end the Installation steps.
k. Check the logs for any issue.
After the installation, if you installed the Sun Identity Manager software inside the auto-deploy directory, then you don't need to do anything else except start the web server instance.
If instead you installed in a staging directory, then you need to deploy Identity Manager by making a WAR file of it. You need to mention a URI as the application's context root. After the instance starts up, you can access the Sun Identity Manager login page here:
http://<instance_id>:port_number/Application_URI/login.jsp
Then you can enjoy using the Sun Identity Manager software.
Here are links to related resources:
Unless otherwise licensed, code in all technical manuals herein (including articles, FAQs, samples) is provided under this License.